Merge pull request WISDEM#180 from WISDEM/dev

Release v1.1
RHammond2 · Sep 13, 2024 · b77b98b · b77b98b
commit b77b98b
Show file tree

Hide file tree

Showing 190 changed files with 24,952 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: b019dd1415efa8f3737a00039dec19fa
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.nojekyll b/.nojekyll
diff --git a/_images/ArrayCableInstall.png b/_images/ArrayCableInstall.png
diff --git a/_images/ArraySystemDesign.png b/_images/ArraySystemDesign.png
diff --git a/_images/ExportCableInstall.png b/_images/ExportCableInstall.png
diff --git a/_images/ExportSystemDesign.png b/_images/ExportSystemDesign.png
diff --git a/_images/full_grid_example.png b/_images/full_grid_example.png
diff --git a/_images/monopile_install.png b/_images/monopile_install.png
diff --git a/_images/monopile_single_wtiv.png b/_images/monopile_single_wtiv.png
diff --git a/_images/monopile_wtiv_with_feeders.png b/_images/monopile_wtiv_with_feeders.png
diff --git a/_images/partial_ring_example.png b/_images/partial_ring_example.png
diff --git a/_images/turbine_install.png b/_images/turbine_install.png
diff --git a/_images/turbine_single_wtiv.png b/_images/turbine_single_wtiv.png
diff --git a/_images/turbine_wtiv_with_feeders.png b/_images/turbine_wtiv_with_feeders.png
diff --git a/_sources/contents.rst.txt b/_sources/contents.rst.txt
@@ -0,0 +1,28 @@
+.. _contents:
+
+=======================
+Documentation for ORBIT
+=======================
+
+Contents:
+=========
+
+.. toctree::
+   :maxdepth: 2
+
+   index
+   source/intro/index
+   source/tutorial/index
+   source/examples
+   source/api
+   source/methods
+   source/publications/index
+   source/changelog
+   source/team
+
+
+Indices and search page
+=======================
+
+* :ref:`genindex`
+* :ref:`search`
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -0,0 +1,55 @@
+.. sidebar:: Documentation
+
+   :ref:`Introduction <intro>`
+      A quick introduction to the project.
+
+   :ref:`Tutorial <tutorial>`
+      Basic tutorial for working with ORBIT.
+
+   :ref:`Examples <examples>`
+      Advanced examples and real world validation cases.
+
+   :ref:`API Reference <api>`
+      Detailed description of ORBIT's API.
+
+   :ref:`Methodology <methods>`
+      References and descriptions of the underlying engineering models.
+
+   :ref:`Publications <publications>`
+      Publications related to ORBIT.
+
+   :ref:`Changelog <changelog>`
+      ORBIT Changelog
+
+   :ref:`Team <team>`
+      List of authors and contributors.
+
+ORBIT
+=====
+
+Overview
+--------
+
+The Offshore Renewables Balance of system and Installation Tool (ORBIT) is a
+model developed by the National Renewable Energy Lab (NREL) to study
+the cost and times associated with Offshore Wind Balance of System (BOS)
+processes.
+
+ORBIT includes many different modules that can be used to model phases within
+the BOS process, split into :ref:`design <design>` and
+:ref:`installation <install>`. It is highly flexible and allows the user to
+define which phases are needed to model their project or scenario using
+:ref:`ProjectManager <manager>`.
+
+ORBIT is written in Python 3.10 and utilizes
+`SimPy <https://simpy.readthedocs.io/en/latest/>`_'s discrete event simulation
+framework to model individual processes during the installation phases,
+allowing for the effects of weather delays and vessel interactions to be
+studied.
+
+License
+-------
+
+Apache 2.0. Please see the
+`repository <https://github.com/WISDEM/ORBIT/blob/master/LICENSE>`_ for
+license information.
diff --git a/_sources/source/api.rst.txt b/_sources/source/api.rst.txt
@@ -0,0 +1,12 @@
+.. _api:
+
+API Reference
+=============
+
+.. toctree::
+   :maxdepth: 3
+
+   api_ProjectManager
+   api_ParametricManager
+   api_DesignPhase
+   api_InstallPhase
diff --git a/_sources/source/api_DesignPhase.rst.txt b/_sources/source/api_DesignPhase.rst.txt
@@ -0,0 +1,21 @@
+.. _design_phases:
+
+Design Phases - ``ORBIT.phases.design``
+=============================================
+
+ORBIT includes the following design modules that can be used within
+ProjectManager. These design processes are intended to broadly capture scaling
+trends but are not intended to be used for actual designs.
+
+.. toctree::
+   :maxdepth: 2
+
+   phases/design/api_MonopileDesign
+   phases/design/api_ScourProtectionDesign
+   phases/design/api_ArraySystemDesign
+   phases/design/api_ExportSystemDesign
+   phases/design/api_ElectricalDesign
+   phases/design/api_OffshoreSubstationDesign
+   phases/design/api_SemiSubmersibleDesign
+   phases/design/api_SparDesign
+   phases/design/api_MooringSystemDesign
diff --git a/_sources/source/api_InstallPhase.rst.txt b/_sources/source/api_InstallPhase.rst.txt
@@ -0,0 +1,23 @@
+.. _install:
+
+Install Phases - ``ORBIT.phases.install``
+===============================================
+
+ORBIT includes the following installation modules that can be used within
+ProjectManager. These modules utilize SimPy to model individual processes and
+their constraints due to weather and vessel interactions. For a more detailed
+description of vessel scheduling within ORBIT, please see `add link`.
+
+.. toctree::
+   :maxdepth: 1
+
+   phases/install/monopile/api_MonopileInstallation
+   phases/install/scour/api_ScourProtectionInstall
+   phases/install/turbine/api_TurbineInstallation
+   phases/install/array/api_ArrayCableInstall
+   phases/install/export/api_ExportCableInstall
+   phases/install/oss/api_OffshoreSubstationInstall
+   phases/install/quayside_towout/api_MooredSubInstallation
+   phases/install/mooring/api_MooringSystemInstallation
+
+..    phases/install/jacket/api_JacketInstall
diff --git a/_sources/source/api_ParametricManager.rst.txt b/_sources/source/api_ParametricManager.rst.txt
@@ -0,0 +1,7 @@
+.. _manager:
+
+Parametric Configurations - ``ORBIT.ParametricManager``
+=======================================================
+
+.. autoclass:: ORBIT.ParametricManager
+   :members:
diff --git a/_sources/source/api_ProjectManager.rst.txt b/_sources/source/api_ProjectManager.rst.txt
@@ -0,0 +1,7 @@
+.. _manager:
+
+Project Configuration and Management - ``ORBIT.manager``
+==============================================================
+
+.. autoclass:: ORBIT.manager.ProjectManager
+   :members: