Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding documentation for typical usages of OpenFAST #308

Merged
merged 10 commits into from
Dec 12, 2023
3 changes: 2 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,9 @@ package:

source/this_doc.rst
source/install/index.rst
source/testing/index.rst
source/working.rst
source/user/index.rst
source/testing/index.rst
source/dev/index.rst
source/license.rst
source/help.rst
Expand Down
52 changes: 52 additions & 0 deletions docs/source/user/general.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@


.. _general-reference-docs:

General
~~~~~~~
.. toctree::
:maxdepth: 1

fast_to_openfast.rst
api_change.rst
input_file_overview.rst

Workshop material, legacy documentation, and other resources are listed below.

- `Overview of OpenFAST at NAWEA WindTech 2023 <https://forums.nrel.gov/t/modeling-workshops/523/27>`_
- `Overview of OpenFAST at NAWEA WindTech 2022 <https://drive.google.com/file/d/1bD5a6rRg6cCKht9Ar8AFJQ8YrI4-wsFe/view>`_
ebranlard marked this conversation as resolved.
Show resolved Hide resolved
- `Practical Guide to OpenFAST at NAWEA WindTech 2022 <https://drive.google.com/file/d/1FHovo6btDStPBh1Kv2swA09hIQRcZGZf/view>`_
- `Overview of OpenFAST at NAWEA WindTech 2019 <https://drive.google.com/file/d/1wagMTOV_CLxSKzS2EEPFp2CExUo3JLpQ/view>`_
- `Workshop Presentations <https://drive.google.com/drive/folders/1BDDfcnIyvmZCwf7eFo0ISI7aF_FMAOvt>`_
- :download:`Old FAST v6 User's Guide <../../OtherSupporting/Old_FAST6_UsersGuide.pdf>`
- :download:`FAST v8 README <../../OtherSupporting/FAST8_README.pdf>`
- `Implementation of Substructure Flexibility and Member-Level Load Capabilities for Floating Offshore Wind Turbines in OpenFAST <https://www.nrel.gov/docs/fy20osti/76822.pdf>`_
- `FAST modularization framework for wind turbine simulation: full-system linearization <https://www.nrel.gov/docs/fy17osti/67015.pdf>`_
- `Full-System Linearization for Floating Offshore Wind Turbines in OpenFAST <https://www.nrel.gov/docs/fy19osti/71865.pdf>`_
- :download:`FAST with Labview <../../OtherSupporting/UsingFAST4Labview.pdf>`
- :download:`OutListParameters.xlsx <../../OtherSupporting/OutListParameters.xlsx>` - Contains the full list of outputs for each module.



Modularization Framework
************************

Information specific to the modularization framework of OpenFAST is provided here. These are a collection
of publications, presentations, and past studies on the subject.

- `The New Modularization Framework for the FAST Wind Turbine CAE Tool <https://www.nrel.gov/docs/fy13osti/57228.pdf>`_
- :download:`Example Module Implementation Plans <../../OtherSupporting/ModulePlan_GasmiPaperExamples.doc>`
- :download:`Module and Mesh-Mapping Linearization Implementation Plan <../../OtherSupporting/LinearizationOfMeshMapping_Rev18_Rev2.doc>`
- :download:`Interpolation of DCMs <../../OtherSupporting/DCM_Interpolation/DCM_Interpolation.pdf>` - A summary of the mathematics used in the interpolation of DCM (direction cosine matrices) using logarithmic mapping and matrix exponentials.
- :download:`Set-point Linearization Development Plan <../../OtherSupporting/DevelopmentPlan-SetPoint-Linearization.pdf>`

.. - :download:`OpenFAST Steady State Solution <../../OtherSupporting/OpenFASTSteadyStateSolution_Rev7.doc>`
Glue Code and Mesh Mapping
**************************

- `FAST Modular Wind Turbine CAE Tool: Nonmatching Spatial and Temporal Meshes <https://www.nrel.gov/docs/fy14osti/60742.pdf>`_
- `FAST Modular Framework for Wind Turbine Simulation: New Algorithms and Numerical Examples <https://dx.doi.org/10.2514/6.2015-1461>`_
- :download:`OpenFAST Algorithms <../../OtherSupporting/OpenFAST_Algorithms/OpenFAST_Algorithms.pdf>` - A summary of the solve method used in the glue code.
- :download:`Predictor-Corrector Approach <../../OtherSupporting/ProposedPCApproach_Rev4.docx>`
72 changes: 8 additions & 64 deletions docs/source/user/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,48 +3,17 @@
User Documentation
==================

We are in the process of transitioning legacy FAST v8 documentation, which can be found at https://www.nrel.gov/wind/nwtc.html.

.. note::
We are in the process of transitioning legacy FAST v8 documentation to this online documentation. The legacy FAST v8 documentation can be found at https://www.nrel.gov/wind/nwtc.html.

Much of the documentation here is legacy documentation from FAST v8. While most of it is still
directly applicable to OpenFAST, portions may be out of date.
This section contains documentation for the OpenFAST module-coupling environment and its underlying modules. Documentation covers usage of models, underlying theory, and in some cases module verification.


.. _general-reference-docs:

General
~~~~~~~
.. toctree::
:maxdepth: 1

fast_to_openfast.rst
api_change.rst
input_file_overview.rst

Workshop material, legacy documentation, and other resources are listed below.

- `Overview of OpenFAST at NAWEA WindTech 2022 <https://drive.google.com/file/d/1bD5a6rRg6cCKht9Ar8AFJQ8YrI4-wsFe/view>`_
- `Practical Guide to OpenFAST at NAWEA WindTech 2022 <https://drive.google.com/file/d/1FHovo6btDStPBh1Kv2swA09hIQRcZGZf/view>`_
- `Overview of OpenFAST at NAWEA WindTech 2019 <https://drive.google.com/file/d/1wagMTOV_CLxSKzS2EEPFp2CExUo3JLpQ/view>`_
- `Workshop Presentations <https://drive.google.com/drive/folders/1BDDfcnIyvmZCwf7eFo0ISI7aF_FMAOvt>`_
- :download:`Old FAST v6 User's Guide <../../OtherSupporting/Old_FAST6_UsersGuide.pdf>`
- :download:`FAST v8 README <../../OtherSupporting/FAST8_README.pdf>`
- `Implementation of Substructure Flexibility and Member-Level Load Capabilities for Floating Offshore Wind Turbines in OpenFAST <https://www.nrel.gov/docs/fy20osti/76822.pdf>`_
- `FAST modularization framework for wind turbine simulation: full-system linearization <https://www.nrel.gov/docs/fy17osti/67015.pdf>`_
- `Full-System Linearization for Floating Offshore Wind Turbines in OpenFAST <https://www.nrel.gov/docs/fy19osti/71865.pdf>`_
- :download:`FAST with Labview <../../OtherSupporting/UsingFAST4Labview.pdf>`
- :download:`OutListParameters.xlsx <../../OtherSupporting/OutListParameters.xlsx>` - Contains the full list of outputs for each module.


Module Documentation
~~~~~~~~~~~~~~~~~~~~
This section contains documentation for the OpenFAST module-coupling environment and its underlying modules.
Documentation covers usage of models, underlying theory, and in some cases module verification.

.. toctree::
:maxdepth: 1

General considerations <general.rst>
AeroDyn <aerodyn/index.rst>
OLAF <aerodyn-olaf/index.rst>
Aeroacoustics <aerodyn-aeroacoustics/index.rst>
Expand All @@ -59,8 +28,12 @@ Documentation covers usage of models, underlying theory, and in some cases modul
ServoDyn <servodyn/index.rst>
Structural Control <servodyn-stc/StC_index.rst>
TurbSim <turbsim/index.rst>
C++ API <cppapi/index.rst>
FAST.Farm <fast.farm/index.rst>
C++ API <cppapi/index.rst>


Additional module documentation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The following modules do not currently have formal documentation
or are contributed to OpenFAST from organizations
Expand All @@ -79,10 +52,6 @@ with the information for the new documentation.
- :download:`Theory Manual <../../OtherSupporting/FEAMooring/FEAM_Theory_Manual.pdf>`
- :download:`User's Guide <../../OtherSupporting/FEAMooring/FEAM_Users_Guide.pdf>`

- MoorDyn

- `Official User's Guide <http://www.matt-hall.ca/files/MoorDyn%20Users%20Guide%202017-08-16.pdf>`_

- OrcaFlex Interface:

- :download:`User's Guide <../../OtherSupporting/OrcaFlex/User_Guide_OrcaFlexInterface.pdf>`
Expand All @@ -95,32 +64,7 @@ with the information for the new documentation.

- :download:`Draft: FAST Ice Module Manual <../../OtherSupporting/IceDyn/IceDyn_Manual.pdf>`

- TurbSim

- :download:`User's Guide <../../OtherSupporting/TurbSim/TurbSim_v2.00.pdf>`

Modularization Framework
~~~~~~~~~~~~~~~~~~~~~~~~

Information specific to the modularization framework of OpenFAST is provided here. These are a collection
of publications, presentations, and past studies on the subject.

- `The New Modularization Framework for the FAST Wind Turbine CAE Tool <https://www.nrel.gov/docs/fy13osti/57228.pdf>`_
- :download:`Example Module Implementation Plans <../../OtherSupporting/ModulePlan_GasmiPaperExamples.doc>`
- :download:`Module and Mesh-Mapping Linearization Implementation Plan <../../OtherSupporting/LinearizationOfMeshMapping_Rev18_Rev2.doc>`
- :download:`Interpolation of DCMs <../../OtherSupporting/DCM_Interpolation/DCM_Interpolation.pdf>` - A summary of the mathematics used in the interpolation of DCM (direction cosine matrices) using logarithmic mapping and matrix exponentials.
- :download:`Set-point Linearization Development Plan <../../OtherSupporting/DevelopmentPlan-SetPoint-Linearization.pdf>`

.. - :download:`OpenFAST Steady State Solution <../../OtherSupporting/OpenFASTSteadyStateSolution_Rev7.doc>`


Glue Code and Mesh Mapping
~~~~~~~~~~~~~~~~~~~~~~~~~~

- `FAST Modular Wind Turbine CAE Tool: Nonmatching Spatial and Temporal Meshes <https://www.nrel.gov/docs/fy14osti/60742.pdf>`_
- `FAST Modular Framework for Wind Turbine Simulation: New Algorithms and Numerical Examples <https://dx.doi.org/10.2514/6.2015-1461>`_
- :download:`OpenFAST Algorithms <../../OtherSupporting/OpenFAST_Algorithms/OpenFAST_Algorithms.pdf>` - A summary of the solve method used in the glue code.
- :download:`Predictor-Corrector Approach <../../OtherSupporting/ProposedPCApproach_Rev4.docx>`


NWTC Subroutine Library
Expand Down
4 changes: 4 additions & 0 deletions docs/source/user/moordyn/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,7 @@ usage of MoorDyn at the FAST.Farm level
(`MoorDyn with FAST.Farm <https://moordyn.readthedocs.io/en/latest/inputs.html#moordyn-with-fast-farm-inputs>`_),
and links to publications with the relevant theory.


The user guide can be downloaded below.

`Official User's Guide <http://www.matt-hall.ca/files/MoorDyn%20Users%20Guide%202017-08-16.pdf>`_
5 changes: 5 additions & 0 deletions docs/source/user/turbsim/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
TurbSim Users Guide Placeholder
======================================

The Turbsim documentation has not been ported to readthedocs yet. It can be downloaded below.

:download:`User's Guide <../../../OtherSupporting/TurbSim/TurbSim_v2.00.pdf>`


.. only:: html

This is a placeholder for the TurbSim documentation that has not yet been converted to readTheDocs.
Expand Down
Loading