Document Examples

README.md

@@ -40,7 +40,7 @@ The core WEIS modules are:
 
 ## Installation
 
-On laptop and personal computers, installation with [Anaconda](https://www.anaconda.com) is the recommended approach because of the ability to create self-contained environments suitable for testing and analysis.  WEIS requires [Anaconda 64-bit](https://www.anaconda.com/distribution/). 
+On laptop and personal computers, installation with [Anaconda](https://www.anaconda.com) is the recommended approach because of the ability to create self-contained environments suitable for testing and analysis.  WEIS requires [Anaconda 64-bit](https://www.anaconda.com/distribution/). WEIS is currently supported on Linux, MAC and Windows Sub-system for Linux (WSL). Installing WEIS on native Windows is not supported.
 
 The installation instructions below use the environment name, "weis-env," but any name is acceptable.
 
@@ -49,18 +49,19 @@ The installation instructions below use the environment name, "weis-env," but an
         module purge
         module load conda        
 
-1.  Setup and activate the Anaconda environment from a prompt (Anaconda3 Power Shell on Windows or Terminal.app on Mac)
+1.  Setup and activate the Anaconda environment from a prompt (WSL terminal on Windows or Terminal.app on Mac)
 
         conda config --add channels conda-forge
         conda create -y --name weis-env python=3.8       # (you can install an environment at a predefined path by switching "--name weis-env" with "--prefix path/weis-env")
         conda activate weis-env                          # (if this does not work, try source activate weis-env)
+        sudo apt update                                  # (WSL only, assuming Ubuntu)
 
-2.  Use conda to install the build dependencies.  Note the differences between Windows and Mac/Linux build systems. Skip to point #3 if you are on the DOE HPC system Eagle
+2.  Use conda to install the build dependencies.  Note the differences between Windows and Mac/build systems. Skip to point #3 if you are on the DOE HPC system Eagle
 
         conda install -y cmake cython control dill git jsonschema make matplotlib-base numpy openmdao openpyxl pandas pip pyoptsparse pytest python-benedict pyyaml ruamel_yaml scipy setuptools simpy slycot smt sortedcontainers swig
-        conda install -y petsc4py mpi4py                 # (Mac / Linux only)   
-        conda install -y compilers                       # (Mac only)   
-        conda install -y m2w64-toolchain libpython       # (Windows only)
+        conda install -y petsc4py mpi4py                                           
+        conda install -y compilers                                              # (Mac only)   
+        sudo apt install gcc g++ gfortran libblas-dev liblapack-dev  -y         # (WSL only, assuming Ubuntu)
         pip install marmot-agents jsonmerge fatpack
         git clone https://github.com/WISDEM/WEIS.git
         cd WEIS

docs/how_weis_works.rst

@@ -1,6 +1,31 @@
-.. _documentation-label:
-
 How WEIS works
 --------------
 
-This page is in progress.
+WEIS is a stack of software that can be used for floating wind turbine design and analysis.  The turbine’s components (blade, tower, platform, mooring, and more) are parameterized in a geometry input. The system engineering tool `WISDEM <https://github.com/WISDEM/WISDEM>`_ determines component masses, costs, and engineering parameters that can be used to determine modeling inputs.  A variety of pre-processing tools are used to convert these system engineering models into simulation models.  
+
+The modeling_options.yaml determines how the turbine is simulated.  We currently support `OpenFAST <https://github.com/OpenFAST/openfast>`_ and `RAFT <https://github.com/WISDEM/RAFT>`_.  
+
+The analysis_options.yaml determine how to run simulations, either a single run for analysis, a sweep or design of experiments, or an optimization.  
+
+A full description of the inputs can be found `here <https://github.com/WISDEM/WEIS/tree/master/weis/inputs>`_ (will point to rst when available).
+
+.. image:: images/WEIS_Stack.png
+  :width: 500
+  :alt: Stack of software tools contained in WEIS
+
+WEIS is `"glued" <https://github.com/WISDEM/WEIS/blob/master/weis/glue_code/glue_code.py>`_ together using `openmdao <https://openmdao.org/>`_ components and groups.
+
+WEIS works best by running `examples <https://github.com/WISDEM/WEIS/tree/master/examples>`_:
+ * `01_aeroelasticse <https://github.com/WISDEM/WEIS/tree/master/examples/01_aeroelasticse>`_ can be used to set up batches of aeroelastic simulations in OpenFAST
+ * `02_control_opt <https://github.com/WISDEM/WEIS/tree/master/examples/02_control_opt>`_ can be used to run WEIS from an existing OpenFAST model, and optimize control parameters only
+ * `03_NREL5MW_OC3 <https://github.com/WISDEM/WEIS/tree/master/examples/03_NREL5MW_OC3_spar>`_ and `04_NREL5MW_OC4_semi <https://github.com/WISDEM/WEIS/tree/master/examples/04_NREL5MW_OC4_semi>`_ can be used to simulate the OC spar and semi, respectively, from WISDEM geometries.
+ * `05_IEA-3.4-130-RWT <https://github.com/WISDEM/WEIS/tree/master/examples/05_IEA-3.4-130-RWT>`_ runs the design load cases (DLCs) for the fixed-bottom IEA-3.4 turbine
+ * `06_IEA-15-240-RWT <https://github.com/WISDEM/WEIS/tree/master/examples/06_IEA-15-240-RWT>`_ contains several examples for running the IEA-15MW with the VolturnUS platform, including tower and structural controller optimization routines
+ * `15_RAFT_Studies <https://github.com/WISDEM/WEIS/tree/master/examples/15_RAFT_Studies>`_ contains an example for optimizing a the IEA-15MW with the VolturnUS platform in RAFT
+More documentation specific to these examples can be found there, with more to follow.
+
+This documentation only covers a summary of WEIS's functionality.  WEIS can be adapted to solve a wide variety of problems.  If you have questions or would like to discuss WEIS's functionality further, please email dzalkind (at) nrel (dot) gov. 
+
+.. image:: images/WEIS_Flow.png
+  :width: 1000
+  :alt: Stack of software tools contained in WEIS