IEAWindTask37 · ptrbortolotti · Nov 27, 2023 · Nov 19, 2023 · Nov 19, 2023 · Nov 19, 2023
diff --git a/docs/source/airfoils.rst b/docs/source/airfoils.rst
@@ -3,9 +3,9 @@ Airfoils
 
 windIO describes the airfoils in terms of coordinates and polars. The yaml entry airfoils consists of a list of elements. 
 
-.. literalinclude:: ../../test/turbine/turbine_example.yaml
-    :start-after: # Airfoils
-    :end-before: # Materials
+.. literalinclude:: ../../test/turbine/IEA-15-240-RWT.yaml
+    :start-after: airfoils
+    :end-before: materials
 
 :code:`name` : String
     Label identifying the airfoils

diff --git a/docs/source/assembly.rst b/docs/source/assembly.rst
@@ -2,11 +2,11 @@
 Assembly
 *******************
 
-The field :code:`assembly` includes five entries that aim at describing the overall configuration of the wind turbine:
+The field :code:`assembly` includes nine entries that aim at describing the overall configuration of the wind turbine:
 
-.. literalinclude:: ../../test/turbine/turbine_example.yaml
-    :start-after: # Assembly
-    :end-before: # Control
+.. literalinclude:: ../../test/turbine/IEA-15-240-RWT.yaml
+    :start-after: assembly
+    :end-before: components
 
 :code:`turbine_class` : String 
     IEA wind class. The entry should be :code:`I`, :code:`II`, :code:`III`, or :code:`IV`. 
@@ -22,3 +22,15 @@ The field :code:`assembly` includes five entries that aim at describing the over
 
 :code:`number_of_blades` : Integer 
     Number of rotor blades.
+
+:code:`hub_height` : Float, m 
+    Height of the hub center from the ground or from the mean sea level
+
+:code:`rotor_diameter` : Float, m 
+    Rotor diameter, defined as the sum of hub diameter and two times the three dimensional curved blade length
+
+:code:`rated_power` : Float, W 
+    Electrical rated power of the wind turbine
+
+:code:`lifetime` : Float, yr
+    Design lifetime of the turbine
diff --git a/docs/source/blade.rst b/docs/source/blade.rst
diff --git a/docs/source/components.rst b/docs/source/components.rst
@@ -2,19 +2,17 @@
 Components
 *******************
 
-The inputs describing the wind turbine components are described here. The ontology windIO currently distinguishes the five components :code:`blade`, :code:`hub`, :code:`nacelle`, :code:`tower`, and :code:`foundation`
-
-.. literalinclude:: ../../test/top_level.yaml
-    :start-after: # Components
-    :end-before: # EOF2
-
+The inputs describing the wind turbine components are described here. The ontology windIO currently distinguishes the components :code:`blade`, :code:`hub`, :code:`nacelle`, :code:`tower`, :code:`monopile`, :code:`floating_platform`, and :code:`mooring`
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
    blade
+   hub
    nacelle
-   support
+   tower
+   monopile
    floating
+   mooring
 
diff --git a/docs/source/control.rst b/docs/source/control.rst
@@ -1,108 +1,20 @@
 
 ****************************************
-Actuators and Controllers
+Control
 ****************************************
 
 Actuators
 ************
 
 
-.. literalinclude:: ../../test/turbine/turbine_example.yaml
-    :start-after: # Actuators
-    :end-before: # Control
+.. literalinclude:: ../../test/turbine/IEA-15-240-RWT.yaml
+    :start-after: control
+    :end-before: environment
 
 
 pitch
 ########################################
 
-:code:`fine_pitch` : Float, rad
-    Optimal pitch angle of the wind turbine. As default, it is
-    maintained constant in region II.
-
-    *Minimum* = -10    *Maximum* = 10
-
-
-:code:`max_pitch_rate` : Float, rad/s
-    Maximum pitch rate of the rotor blades.
-
-    *Minimum* = 0    *Maximum* = 0.2
-
-
-:code:`pitch_act_bw` : Float, rad/s
-    Bandwidth of 2nd order LPF representing pitch actuators
-
-    *Minimum* = 0    *Maximum* = 100
-
-
-:code:`max_pitch` : Float, rad
-    Maximum pitch angle, where the default is 90 degrees. It is used
-    by the ROSCO controller (https://github.com/NREL/ROSCO)
-
-    *Minimum* = 0    *Maximum* = 2.0
-
-
-:code:`min_pitch` : Float, rad
-    Minimum pitch angle, where the default is 0 degrees. It is used by
-    the ROSCO controller (https://github.com/NREL/ROSCO)
-
-    *Minimum* = -0.5    *Maximum* = 1.0
-
-
-
-
-generator
-########################################
-
-:code:`rated_power` : Float, W
-    Nameplate power of the turbine, i.e. the rated electrical output
-    of the generator.
-
-    *Minimum* = 0
-
-:code:`max_gen_speed` : Float, rad/s
-    Maximum generator speed of the wind turbine.
-
-    *Minimum* = 0    *Maximum* = 10
-
-
-:code:`max_torque_rate` : Float, Nm/s
-    Maximum torque rate of the wind turbine generator.
-
-    *Minimum* = 1000    *Maximum* = 100000000
-
-
-
-
-hss_brake
-########################################
-
-:code:`start_time` : Float, seconds
-    Time in simulation that brake is activated, THSSBrDp in OpenFAST
-
-    *Minimum* = 0
-
-:code:`duration` : Float, seconds
-    Time for HSS-brake to reach full deployment once initiated (sec),
-    HSSBrDT in OpenFAST
-
-    *Minimum* = 0
-
-:code:`torque` : Float, N-m
-    Fully deployed HSS-brake torque, HSSBrTqF in OpenFAST
-
-    *Minimum* = 0
-
-
-
-Control
-***********
-
-
-.. literalinclude:: ../../test/turbine/turbine_example.yaml
-    :start-after: # Control
-    :end-before: # Environment
-
-
 supervisory
 ########################################
 
@@ -149,62 +61,42 @@ pitch
 
     *Minimum* = 0    *Maximum* = 1
 
+:code:`fine_pitch` : Float, rad
+    Optimal pitch angle of the wind turbine. As default, it is
+    maintained constant in region II.
 
+    *Minimum* = -10    *Maximum* = 10
 
 
-fl_feedback
-========================================
-
-Platform velocity feedback using nacelle IMU
-
-:code:`gain` : Float, seconds
-    Platform velocity feedback gain used by the ROSCO controller
-    (https://github.com/NREL/ROSCO)
-
-
-
-twr_feedback
-========================================
-
-Tower velocity feedback using nacelle IMU
-
-:code:`gain` : Float, seconds
-    Tower velocity feedback gain used by the ROSCO controller
-    (https://github.com/NREL/ROSCO)
-
-
-
-IPC
-========================================
-
-Individual pitch control (IPC) using the mulitblade coordinate (MBC) transform
+:code:`max_pitch_rate` : Float, rad/s
+    Maximum pitch rate of the rotor blades.
 
-:code:`IPC_gain_1P` : Float, rad/Nm
-    Integral gain of 1P feedback
+    *Minimum* = 0    *Maximum* = 0.2
 
-    *Minimum* = 0
+:code:`max_pitch` : Float, rad
+    Maximum pitch angle, where the default is 90 degrees. It is used
+    by the ROSCO controller (https://github.com/NREL/ROSCO)
 
-:code:`IPC_gain_2P` : Float, rad/Nm
-    Integral gain of 2P feedback
+    *Minimum* = 0    *Maximum* = 2.0
 
-    *Minimum* = 0
 
-:code:`IPC_phase_1P` : Float, rad
-    Phase lag of 1P IPC feedback
+:code:`min_pitch` : Float, rad
+    Minimum pitch angle, where the default is 0 degrees. It is used by
+    the ROSCO controller (https://github.com/NREL/ROSCO)
 
-    *Minimum* = -3.14    *Maximum* = 3.14
+    *Minimum* = -0.5    *Maximum* = 1.0
 
 
-:code:`IPC_phase_2P` : Float, rad
-    Phase lag of 2P IPC feedback
 
-    *Minimum* = -3.14    *Maximum* = 3.14
 
+torque
+########################################
 
 
+:code:`max_torque_rate` : Float, Nm/s
+    Maximum torque rate of the wind turbine generator.
 
-torque
-########################################
+    *Minimum* = 1000    *Maximum* = 100000000
 
 :code:`control_type` : String from, ['tsr_tracking', 'legacy', 'pi_transitions']
     Type of torque control used.

diff --git a/docs/source/costs.rst b/docs/source/costs.rst
@@ -3,9 +3,8 @@ Costs
 
 The field :code:`costs` includes the data to conduct an LCOE analysis of the wind turbine. The structure of the data is based on the analysis presented in the report https://www.nrel.gov/docs/fy20osti/74598.pdf
 
-.. literalinclude:: ../../test/turbine/turbine_example.yaml
-    :start-after: # Costs
-    :end-before: # EOF
+.. literalinclude:: ../../test/turbine/IEA-15-240-RWT.yaml
+    :start-after: costs
 
 :code:`wake_loss_factor` : Float
     Loss factor to account for wind park losses, such as wake losses. This is used to convert the annual energy production of the turbine to the annual energy production of the wind plant.

diff --git a/docs/source/environment.rst b/docs/source/environment.rst
@@ -3,9 +3,9 @@ Environment
 
 The field :code:`environment` includes the data characterizing air and water.
 
-.. literalinclude:: ../../test/turbine/turbine_example.yaml
-    :start-after: # Environment
-    :end-before: # Costs
+.. literalinclude:: ../../test/turbine/IEA-15-240-RWT.yaml
+    :start-after: environment
+    :end-before: bos
 
 :code:`air_density` : Float, kg/m3
     Density of air. 
@@ -24,4 +24,10 @@ The field :code:`environment` includes the data characterizing air and water.
 :code:`soil_shear_modulus` : Float, Pa
     Shear modulus of the soil. 
 :code:`soil_poisson` : Float
-    Poisson ratio of the soil. 
+    Poisson ratio of the soil. 
+:code:`water_depth` : Float, m
+    Depth of the water at the site
+:code:`significant_wave_height` : Float, m
+    Significant wave height at the site
+:code:`significant_wave_period` : Float, m
+    Significant wave period at the site