.. _user_guide:

User Documentation
==================

.. 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.

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>
   AeroDisk <aerodisk/index.rst>
   BeamDyn <beamdyn/index.rst>
   SubDyn <subdyn/index.rst>
   ExtPtfm <extptfm//index.rst>
   ElastoDyn <elastodyn/index.rst>
   HydroDyn <hydrodyn/index.rst>
   SeaState <seastate/index.rst>
   InflowWind <inflowwind/index.rst>
   MoorDyn <moordyn/index.rst>
   ServoDyn <servodyn/index.rst>
   Simplified ElastoDyn <simplified_elastodyn/index.rst>
   Structural Control <servodyn-stc/StC_index.rst>
   TurbSim <turbsim/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
external to NREL and the core OpenFAST team. As documentation is added,
these resources will be moved to their appropriate location. If newer versions
of the external resources are available, please open a `GitHub Issue <https://github.com/openfast/openfast/issues>`_
with the information for the new documentation.

- MAP++

  - `Official MAP++ documentation <https://map-plus-plus.readthedocs.io/en/latest/index.html>`_
  - :download:`Implementation of a Multi-Segmented, Quasi-Static Cable Model <../../OtherSupporting/MAP/cable_model_development.pdf>`

- FEAMooring

  - :download:`Theory Manual <../../OtherSupporting/FEAMooring/FEAM_Theory_Manual.pdf>`
  - :download:`User's Guide <../../OtherSupporting/FEAMooring/FEAM_Users_Guide.pdf>`

- OrcaFlex Interface:

  - :download:`User's Guide <../../OtherSupporting/OrcaFlex/User_Guide_OrcaFlexInterface.pdf>`

- IceFloe

  - :download:`Ice Load Project Final Technical Report <../../OtherSupporting/IceFloe/Ice_Load_Final_Report.pdf>`

- IceDyn

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




NWTC Subroutine Library
~~~~~~~~~~~~~~~~~~~~~~~

- :download:`NWTC Library - short overview of subroutines and functions <../../OtherSupporting/NWTC_Library_Description.pdf>`
