deploy: 1713111

kmruehl · Sep 18, 2024 · a8d144c · a8d144c
commit a8d144c
Show file tree

Hide file tree

Showing 793 changed files with 62,482 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+# Sphinx build artefacts
+*/.buildinfo
+*/.doctrees/
diff --git a/.nojekyll b/.nojekyll
diff --git a/README.md b/README.md
@@ -0,0 +1,5 @@
+# WEC-Sim Documentation
+
+This branch is auto-generated by GitHub Actions upon pushes to the main or
+dev branches. See the README.md file in the main branch for instructions
+regarding building the docs locally.
diff --git a/dev/_images/AdjustableRodHPTO.png b/dev/_images/AdjustableRodHPTO.png
diff --git a/dev/_images/DirectDrivePorts.png b/dev/_images/DirectDrivePorts.png
diff --git a/dev/_images/GeneratorSpeedControl.png b/dev/_images/GeneratorSpeedControl.png
diff --git a/dev/_images/HYDPHYMODEL.PNG b/dev/_images/HYDPHYMODEL.PNG
diff --git a/dev/_images/HorizontalVerticalOrbitalVelocity.jpg b/dev/_images/HorizontalVerticalOrbitalVelocity.jpg
diff --git a/dev/_images/IMAGE_Aeroload_Control_Submodel.png b/dev/_images/IMAGE_Aeroload_Control_Submodel.png
diff --git a/dev/_images/IMAGE_Baseline_PowerToPitch_Sensitivity.png b/dev/_images/IMAGE_Baseline_PowerToPitch_Sensitivity.png
diff --git a/dev/_images/IMAGE_Baseline_Torque_Law.png b/dev/_images/IMAGE_Baseline_Torque_Law.png
diff --git a/dev/_images/IMAGE_Body_Block_example.png b/dev/_images/IMAGE_Body_Block_example.png
diff --git a/dev/_images/IMAGE_LogoMOREnergyLab.png b/dev/_images/IMAGE_LogoMOREnergyLab.png
diff --git a/dev/_images/IMAGE_LogoPolitecnicodiTorino.jpg b/dev/_images/IMAGE_LogoPolitecnicodiTorino.jpg
diff --git a/dev/_images/IMAGE_MOST_Library.png b/dev/_images/IMAGE_MOST_Library.png
diff --git a/dev/_images/IMAGE_ROSCO_Power_Curve.png b/dev/_images/IMAGE_ROSCO_Power_Curve.png
diff --git a/dev/_images/IMAGE_Results_Plots_example.png b/dev/_images/IMAGE_Results_Plots_example.png
diff --git a/dev/_images/IMAGE_Steady_States.png b/dev/_images/IMAGE_Steady_States.png
diff --git a/dev/_images/IMAGE_Volturn15MW_Simulink_example.png b/dev/_images/IMAGE_Volturn15MW_Simulink_example.png
diff --git a/dev/_images/IMAGE_blade_geom.png b/dev/_images/IMAGE_blade_geom.png
diff --git a/dev/_images/IMAGE_geometry.png b/dev/_images/IMAGE_geometry.png
diff --git a/dev/_images/IMAGE_wind_Choice.png b/dev/_images/IMAGE_wind_Choice.png
diff --git a/dev/_images/IMAGE_workflow.png b/dev/_images/IMAGE_workflow.png
diff --git a/dev/_images/MECHANICALPTO.PNG b/dev/_images/MECHANICALPTO.PNG
diff --git a/dev/_images/MagAngleOrbitalVelocity.jpg b/dev/_images/MagAngleOrbitalVelocity.jpg
diff --git a/dev/_images/MoorDyn_Graphic.png b/dev/_images/MoorDyn_Graphic.png
diff --git a/dev/_images/MotionConversionLib.png b/dev/_images/MotionConversionLib.png
diff --git a/dev/_images/Nwave.png b/dev/_images/Nwave.png
diff --git a/dev/_images/OSWECPHYMODEL.PNG b/dev/_images/OSWECPHYMODEL.PNG
diff --git a/dev/_images/OSWECPTOSimExample.png b/dev/_images/OSWECPTOSimExample.png
diff --git a/dev/_images/OSWEC_Geom.png b/dev/_images/OSWEC_Geom.png
diff --git a/dev/_images/OSWEC_Model.png b/dev/_images/OSWEC_Model.png
diff --git a/dev/_images/OSWEC_WECSim.JPG b/dev/_images/OSWEC_WECSim.JPG
diff --git a/dev/_images/OSWEC_WECSim_Body.jpg b/dev/_images/OSWEC_WECSim_Body.jpg
diff --git a/dev/_images/OSWEC_WECSim_GUI.jpg b/dev/_images/OSWEC_WECSim_GUI.jpg
diff --git a/dev/_images/OSWEC_WECSim_GlobalRef.jpg b/dev/_images/OSWEC_WECSim_GlobalRef.jpg
diff --git a/dev/_images/OSWEC_heaveForces.PNG b/dev/_images/OSWEC_heaveForces.PNG
diff --git a/dev/_images/OSWEC_pitchResponse.PNG b/dev/_images/OSWEC_pitchResponse.PNG
diff --git a/dev/_images/OSWEC_plotEta.PNG b/dev/_images/OSWEC_plotEta.PNG
diff --git a/dev/_images/OSWEC_plotSpectrum.PNG b/dev/_images/OSWEC_plotSpectrum.PNG
diff --git a/dev/_images/OSWEC_plotWaves.PNG b/dev/_images/OSWEC_plotWaves.PNG
diff --git a/dev/_images/OSWEC_with_ptosim.png b/dev/_images/OSWEC_with_ptosim.png
diff --git a/dev/_images/PTOSimBlock1.png b/dev/_images/PTOSimBlock1.png
diff --git a/dev/_images/PTOSimBlock1OSWEC.png b/dev/_images/PTOSimBlock1OSWEC.png
diff --git a/dev/_images/PTOSimClass_diagram.png b/dev/_images/PTOSimClass_diagram.png
diff --git a/dev/_images/Physics.png b/dev/_images/Physics.png
diff --git a/dev/_images/RM3_Geom.png b/dev/_images/RM3_Geom.png
diff --git a/dev/_images/RM3_WECSim.JPG b/dev/_images/RM3_WECSim.JPG
diff --git a/dev/_images/RM3_WECSim_Body.jpg b/dev/_images/RM3_WECSim_Body.jpg
diff --git a/dev/_images/RM3_WECSim_GUI.JPG b/dev/_images/RM3_WECSim_GUI.JPG
diff --git a/dev/_images/RM3_WECSim_GlobalRef.jpg b/dev/_images/RM3_WECSim_GlobalRef.jpg
diff --git a/dev/_images/RM3_vizMarker.jpg b/dev/_images/RM3_vizMarker.jpg
diff --git a/dev/_images/RM3withPTOSimBlocks.png b/dev/_images/RM3withPTOSimBlocks.png
diff --git a/dev/_images/SliderandCrankMechanism.png b/dev/_images/SliderandCrankMechanism.png
diff --git a/dev/_images/WEC-Sim_Lib.PNG b/dev/_images/WEC-Sim_Lib.PNG
diff --git a/dev/_images/WEC-Sim_Lib_PTOSim.png b/dev/_images/WEC-Sim_Lib_PTOSim.png
diff --git a/dev/_images/WEC-Sim_Lib_bodies.PNG b/dev/_images/WEC-Sim_Lib_bodies.PNG
diff --git a/dev/_images/WEC-Sim_Lib_cable.PNG b/dev/_images/WEC-Sim_Lib_cable.PNG
diff --git a/dev/_images/WEC-Sim_Lib_constraints.PNG b/dev/_images/WEC-Sim_Lib_constraints.PNG
diff --git a/dev/_images/WEC-Sim_Lib_frames.PNG b/dev/_images/WEC-Sim_Lib_frames.PNG
diff --git a/dev/_images/WEC-Sim_Lib_mooring.PNG b/dev/_images/WEC-Sim_Lib_mooring.PNG
diff --git a/dev/_images/WEC-Sim_Lib_pto.PNG b/dev/_images/WEC-Sim_Lib_pto.PNG
diff --git a/dev/_images/WEC-Sim_flowChart.png b/dev/_images/WEC-Sim_flowChart.png
diff --git a/dev/_images/WECCCOMP_PTO_Extension.png b/dev/_images/WECCCOMP_PTO_Extension.png
diff --git a/dev/_images/WECSimMoorDyn.png b/dev/_images/WECSimMoorDyn.png
diff --git a/dev/_images/b2b_comparison2.png b/dev/_images/b2b_comparison2.png
diff --git a/dev/_images/body_diagram.PNG b/dev/_images/body_diagram.PNG
diff --git a/dev/_images/cable_diagram.PNG b/dev/_images/cable_diagram.PNG
diff --git a/dev/_images/codeFeatures.png b/dev/_images/codeFeatures.png
diff --git a/dev/_images/compPerformanceBetweenOption1Option2.png b/dev/_images/compPerformanceBetweenOption1Option2.png
diff --git a/dev/_images/constraint_diagram.PNG b/dev/_images/constraint_diagram.PNG
diff --git a/dev/_images/coordinateSystem.png b/dev/_images/coordinateSystem.png
diff --git a/dev/_images/declutchTimeSweep.png b/dev/_images/declutchTimeSweep.png
diff --git a/dev/_images/declutching.png b/dev/_images/declutching.png
diff --git a/dev/_images/ellipsoid_iso_side.png b/dev/_images/ellipsoid_iso_side.png
diff --git a/dev/_images/extractMaskVariables.PNG b/dev/_images/extractMaskVariables.PNG
diff --git a/dev/_images/gbm_iso_side.png b/dev/_images/gbm_iso_side.png
diff --git a/dev/_images/impedance.png b/dev/_images/impedance.png
diff --git a/dev/_images/latchTimeSweep.png b/dev/_images/latchTimeSweep.png
diff --git a/dev/_images/latching.png b/dev/_images/latching.png
diff --git a/dev/_images/library_format.png b/dev/_images/library_format.png
diff --git a/dev/_images/mask_dev_body.png b/dev/_images/mask_dev_body.png
diff --git a/dev/_images/mask_dev_grf.png b/dev/_images/mask_dev_grf.png
diff --git a/dev/_images/mask_user_grf.png b/dev/_images/mask_user_grf.png
diff --git a/dev/_images/mask_user_grf_waveOptions.png b/dev/_images/mask_user_grf_waveOptions.png
diff --git a/dev/_images/mcr_powerMatrix.png b/dev/_images/mcr_powerMatrix.png
diff --git a/dev/_images/mcr_waveElev-heaveResp.png b/dev/_images/mcr_waveElev-heaveResp.png
diff --git a/dev/_images/moorDynInput.png b/dev/_images/moorDynInput.png
diff --git a/dev/_images/mooring_diagram.PNG b/dev/_images/mooring_diagram.PNG
diff --git a/dev/_images/mpcForce.png b/dev/_images/mpcForce.png
diff --git a/dev/_images/mpcForceChange.png b/dev/_images/mpcForceChange.png
diff --git a/dev/_images/mpcPos.png b/dev/_images/mpcPos.png
diff --git a/dev/_images/mpcSimulink.png b/dev/_images/mpcSimulink.png
diff --git a/dev/_images/mpcVel.png b/dev/_images/mpcVel.png
diff --git a/dev/_images/nlhydro_comparison4.png b/dev/_images/nlhydro_comparison4.png
diff --git a/dev/_images/nonlinearEllipsoid.png b/dev/_images/nonlinearEllipsoid.png
diff --git a/dev/_images/nonlinearMesh.png b/dev/_images/nonlinearMesh.png
diff --git a/dev/_images/nonlinearWEC.png b/dev/_images/nonlinearWEC.png
diff --git a/dev/_images/numOpt_comparison.png b/dev/_images/numOpt_comparison.png
diff --git a/dev/_images/oc6_iso_side.png b/dev/_images/oc6_iso_side.png
diff --git a/dev/_images/oceanCurrentProfiles.png b/dev/_images/oceanCurrentProfiles.png
diff --git a/dev/_images/option2Schematic.jpg b/dev/_images/option2Schematic.jpg
diff --git a/dev/_images/oswec_iso_side.png b/dev/_images/oswec_iso_side.png
diff --git a/dev/_images/oswec_pto_sim.PNG b/dev/_images/oswec_pto_sim.PNG
diff --git a/dev/_images/pGainSweep.png b/dev/_images/pGainSweep.png
diff --git a/dev/_images/passiveYaw_comparison.png b/dev/_images/passiveYaw_comparison.png
diff --git a/dev/_images/piGainSweep.png b/dev/_images/piGainSweep.png
diff --git a/dev/_images/piPTOSimulink.png b/dev/_images/piPTOSimulink.png
diff --git a/dev/_images/pto_diagram.PNG b/dev/_images/pto_diagram.PNG
diff --git a/dev/_images/pto_sim_lib.png b/dev/_images/pto_sim_lib.png
diff --git a/dev/_images/reactiveWithPTOCC.png b/dev/_images/reactiveWithPTOCC.png
diff --git a/dev/_images/reactiveWithPTOCCPower.png b/dev/_images/reactiveWithPTOCCPower.png
diff --git a/dev/_images/reactiveWithPTOOpt.png b/dev/_images/reactiveWithPTOOpt.png
diff --git a/dev/_images/reactiveWithPTOOptPower.png b/dev/_images/reactiveWithPTOOptPower.png
diff --git a/dev/_images/reactiveWithPTOSweep.png b/dev/_images/reactiveWithPTOSweep.png
diff --git a/dev/_images/rectangles.png b/dev/_images/rectangles.png
diff --git a/dev/_images/rm3_iso_side.png b/dev/_images/rm3_iso_side.png
diff --git a/dev/_images/rm3with_pto_sim.PNG b/dev/_images/rm3with_pto_sim.PNG
diff --git a/dev/_images/rotational_pto.PNG b/dev/_images/rotational_pto.PNG
diff --git a/dev/_images/simulation_diagram.png b/dev/_images/simulation_diagram.png
diff --git a/dev/_images/sphere_freedecay_iso_side.png b/dev/_images/sphere_freedecay_iso_side.png
diff --git a/dev/_images/translational_pto.PNG b/dev/_images/translational_pto.PNG
diff --git a/dev/_images/wave_diagram.PNG b/dev/_images/wave_diagram.PNG
diff --git a/dev/_images/wec_sim_header.png b/dev/_images/wec_sim_header.png
diff --git a/dev/_images/wecccomp_diagram.png b/dev/_images/wecccomp_diagram.png
diff --git a/dev/_images/wecccomp_iso_side.png b/dev/_images/wecccomp_iso_side.png
diff --git a/dev/_images/wigley_iso_side.png b/dev/_images/wigley_iso_side.png
diff --git a/dev/_sources/developer/advanced_features.rst.txt b/dev/_sources/developer/advanced_features.rst.txt
@@ -0,0 +1,43 @@
+.. _dev-advanced-features:
+
+Advanced Features
+=================
+
+
+Added Mass
+-----------
+
+.. include:: /_include/added_mass.rst
+
+
+Morison Element
+---------------
+
+.. include:: /_include/morison_element.rst
+
+.. TO DO: add passive yaw
+.. TO DO: add morison element
+.. TO DO: add passive yaw
+.. TO DO: add PTO-Sim
+
+Extract Mask Variables
+----------------------
+The Simulink variable workspace is inaccesible in the MATLAB workspace by default.
+Simulink variables can be imported to the MATLAB workspace using the block handle 
+of the Simulink block being probed. The block parameters can be used by developers
+to programmatically set block parameters by being able to access the unique tags
+that Simulink uses for a particular block parameter. This is also useful for the code
+initialization of Simulink mask blocks.
+The function :code:`ExtractMaskVariables()` 
+located in :code:`source\functions\simulink\mask`, can be used to extract the block
+parameters in following steps,
+
+* Open the pertinent Simulink model,
+* Run the function with the address of the block being probed as the argument,
+* Explore the :code:`mask` data structure in the MATLAB workspace.
+
+
+.. figure:: /_static/images/extractMaskVariables.PNG
+   :width: 550pt
+   :figwidth: 550pt
+   :align: center
diff --git a/dev/_sources/developer/getting_started.rst.txt b/dev/_sources/developer/getting_started.rst.txt
@@ -0,0 +1,32 @@
+.. _dev-getting-started:
+
+Getting Started
+===============
+
+The WEC-Sim source code is hosted on `WEC-Sim's GitHub repository <https://github.com/WEC-Sim/wec-sim>`_. 
+Please fork the WEC-Sim repository if you plan to contribute to the WEC-Sim code.
+Forking the repository allows developers to create a personal copy of the WEC-Sim repository that can be edited idependently.
+For details on creating and using a fork, refer to `GitHub's forking documentation <https://help.github.com/articles/fork-a-repo/>`_. 
+
+Once you have forked the repository on GitHub, add the fork's remote, and pull the fork into your local directory:: 
+
+	>> git remote add <USERNAME> https://github.com/<USERNAME>/WEC-Sim.git
+	>> git pull <USERNAME> <branch>
+
+
+Push local commits to fork on GitHub::
+
+	>> git push <USERNAME> <branch>
+
+Pull updates from WEC-Sim origin::
+
+	>> git pull origin <branch>
+
+
+.. Note::
+	This example defines ``origin`` as `WEC-Sim's GitHub repository <https://github.com/WEC-Sim/wec-sim>`_, and ``<USERNAME>`` as the developer's fork. Develoeprs may use whatever convention they prefer, refer to `GitHub documentation on configuring remotes <https://docs.github.com/en/github/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-for-a-fork>`_
+
+
+
+
+
diff --git a/dev/_sources/developer/index.rst.txt b/dev/_sources/developer/index.rst.txt
@@ -0,0 +1,15 @@
+.. _dev:
+
+#################
+Developer Manual
+#################
+
+.. toctree::
+   :maxdepth: 2
+
+   overview.rst
+   getting_started.rst
+   pull_requests.rst
+   software_tests.rst
+   library.rst
+   advanced_features.rst