Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/DLC_RefactorCaseInputs' into o…
Browse files Browse the repository at this point in the history 
…f_400
  • Loading branch information
@dzalkind
dzalkind committed Nov 7, 2024
2 parents 5032108 + 1eb9474 commit 9df78c2
Show file tree
Hide file tree
Showing 107 changed files with 28,552 additions and 15,524 deletions.
12 changes: 6 additions & 6 deletions .github/workflows/CI_WEIS.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,19 +35,19 @@ jobs:
activate-environment: test
auto-activate-base: false

- name: Add dependencies windows specific
if: contains( matrix.os, 'windows')
run: |
conda install -y -c intel intel-openmp mkl
#- name: Add dependencies windows specific
# if: contains( matrix.os, 'windows')
# run: |
# conda install -y -c intel intel-openmp mkl

- name: Add dependencies ubuntu specific
if: false == contains( matrix.os, 'windows')
run: |
conda install -y petsc4py mpi4py openmpi
conda install -y petsc4py mpi4py openmpi pyoptsparse
- name: Add test packages
run: |
conda install -y pytest pytest-cov coveralls
conda install -y pytest pytest-cov coveralls
- name: Show custom environment
run: |
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/run_exhaustive_examples.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@ jobs:
- name: Add dependencies ubuntu specific
if: false == contains( matrix.os, 'windows')
run: |
conda install -y petsc4py mpi4py openmpi
conda install -y petsc4py mpi4py openmpi pyoptsparse
- name: Add test packages
run: |
conda install -y pytest pytest-cov coveralls treon
conda install -y pytest pytest-cov coveralls treon
- name: Show custom environment
run: |
Expand Down
5 changes: 3 additions & 2 deletions .readthedocs.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,12 @@ version: 2
build:
os: ubuntu-22.04
tools:
python: "mambaforge-4.10"
python: "mambaforge-22.9"
jobs:
# Read the docs needs a couple packages not in the environment file
pre_install:
- conda install cmake compilers
- conda install -y cmake compilers sphinx sphinxcontrib-bibtex sphinx-jsonschema
- conda install sphinx_rtd_theme>=1.3


# Shouldn't need conda for building the docs, but it is an option
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ The installation instructions below use the environment name, "weis-env," but an

module load comp-intel intel-mpi mkl
module unload gcc
pip install -e .
pip install --no-deps -e . -v

**NOTE:** To use WEIS again after installation is complete, you will always need to activate the conda environment first with `conda activate weis-env` (or `source activate weis-env`). On Eagle, make sure to reload the necessary modules

Expand Down
65 changes: 65 additions & 0 deletions docs/_static/custom.css
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
/* dl.class, dl.method, dl.attribute {
display: inline-block;
padding-top: 15px;
padding-bottom: 15px;
}
dl.class, dl.method, dl.attribute {
border-top: groove;
border-top-color: darkgrey;
} */

dl.class::before {
content: ' ';
width: auto;
display: block;
border-top: 4px solid black;
margin-top: 35px;
margin-left: -30px;
padding-bottom: 35px;
}

dl.method::before {
content: ' ';
width: auto;
display: block;
border-top: 1px solid black;
margin-top: 15px;
margin-left: -30px;
padding-bottom: 15px;
}

dl.function::before {
content: ' ';
width: auto;
display: block;
border-top: 1px solid black;
margin-top: 15px;
margin-left: -30px;
padding-bottom: 15px;
}

dl.attribute::before {
content: ' ';
width: auto;
display: block;
border-top: 1px solid black;
margin-top: 15px;
margin-left: -30px;
padding-bottom: 15px;
}


.wy-nav-content {
max-width: 1100px !important;
}

.wy-table-responsive td,
.wy-table-responsive th {
white-space: normal;
}

.wy-table-responsive table.word-wrap td,
.wy-table-responsive table.word-wrap th {
white-space: inherit;
}
3 changes: 3 additions & 0 deletions docs/_static/main.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
$(document).ready( function () {
$('table.datatable').DataTable();
} );
20 changes: 20 additions & 0 deletions docs/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
'sphinxcontrib.bibtex',
'sphinx.ext.intersphinx',
'sphinx_rtd_theme',
'sphinx-jsonschema',
# 'autoapi.extension',
# 'embed-n2',
]
Expand Down Expand Up @@ -106,3 +107,22 @@
'searchbox.html'
]
}

html_css_files = [
'https://cdn.datatables.net/1.10.23/css/jquery.dataTables.min.css',
"custom.css",
]

html_js_files = [
'https://cdn.datatables.net/1.10.23/js/jquery.dataTables.min.js',
'main.js',
]

# Bibtex configuration
bibtex_bibfiles = ["references.bib"]

jsonschema_options = {
'lift_title': True,
'lift_description': True,
'lift_definitions': True,
}
203 changes: 200 additions & 3 deletions docs/dlc_generator.rst
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,202 @@
DLC Generator
-------------
=========================
Design Load Cases in WEIS
=========================

Design load cases (DLCs) specify the conditions that a turbine must operate in safely thorughout its lifetime.
These load cases are defined in IEC standards.
We supplement the standards with information from the DTU design load basis (cite).

**Inputs to the DLC case generator explained**
--------------------------
How to Set Up DLCs in WEIS
--------------------------

DLCs are configured in the modeling options (link).
A full set of input information is contained within the modeling schema.
An example (a subset of a modeling input) is shown next::

DLC_driver:
metocean_conditions:
wind_speed: [1.,3.,5.,7.,9.,11.,13.,15.,17.,19.,21.,23.,25.,27.,29.]
wave_height_NSS: [0.84,0.84,0.87,0.99,1.15,1.34,1.58,1.82,2.08,2.34,2.66,2.98,3.28,3.77,3.94]
wave_period_NSS: [8.3,8.3,8.3,7.7,7.1,6.3,6.1,6.2,6.2,6.7,7.1,7.1,7.7,7.7,7.7]
wave_height_fatigue: [0.84,0.84,0.87,0.99,1.15,1.34,1.58,1.82,2.08,2.34,2.66,2.98,3.28,3.77,3.94]
wave_period_fatigue: [8.3,8.3,8.3,7.7,7.1,6.3,6.1,6.2,6.2,6.7,7.1,7.1,7.7,7.7,7.7]
wave_height_SSS: [9.7,9.7,9.7,9.7,9.7,9.7,9.7,9.7,9.7,9.7,9.7,9.7,9.7,9.7,9.7]
wave_period_SSS: [13.6,13.6,13.6,13.6,13.6,13.6,13.6,13.6,13.6,13.6,13.6,13.6,13.6,13.6,13.6]
wave_height1: 5.9
wave_period1: 11.2
wave_height50: 9.7
wave_period50: 13.6
DLCs: # Currently supported IEC 1.1, 1.3, 1.4, 1.5, 5.1, 6.1, 6.3, or define a Custom one
- DLC: "1.1"
ws_bin_size: 5
n_seeds: 2
# analysis_time: 5.
# transient_time: 5.
# wind_speed: [3., 5., 7., 9., 11., 13., 15., 17., 19., 21., 23., 25.]
turbulent_wind:
HubHt: 110
GridHeight: 160
GridWidth: 160

The ``metocean_conditions`` are defined using tables of ``wind_speed``, ``wave_height``, and ``wave_period`` for normal sea states (``NSS``) and severe sea states (``SSS``), and sea states representative of 1- and 50-year return periods.
Individual DLCs use these conditions to determine specific sea conditions for each case, but they can also be overwritten in each case.

Users can specify the wind speed bin size (``ws_bin_size``) or the specific wind speeds (``wind_speed``).
The number of seeds (``n_seed``) and specifics about the turbsim inputs (link?, ``turbulent_wind``) can also be specified.
``transient_time`` is excluded from timeseries analysis; only ``analysis_time`` is used.
A complete listing of the DLC options can be found here `DLC options`_ below.

-------------------
Reviewing DLC Cases
-------------------

The DLC Case Matrix
-------------------

WEIS creates a case matrix for each DLC; this case matrix, is located in the same directory as the openfast runs in both yaml and txt format.
The case matrix specifies which inputs are changed for each case.
An example case matrix is shown next::

Case_ID AeroDyn15 AeroDyn15 ElastoDyn ElastoDyn ElastoDyn ElastoDyn ElastoDyn Fst Fst HydroDyn HydroDyn HydroDyn InflowWind TurbSim
WakeMod tau1_const BlPitch1 BlPitch2 BlPitch3 NacYaw RotSpeed TMax TStart WaveHs WaveMod WaveTp HWindSpeed RandSeed1
0 1 25.353075267567498 0.000535 0.000535 0.000535 0 5.6819 10.0 0.0 9.7 2 13.6 8.0 1501552846
1 1 25.353075267567498 0.000535 0.000535 0.000535 0 5.6819 10.0 0.0 9.7 2 13.6 8.0 488200390
2 1 9.536058651858337 9.189114 9.189114 9.189114 0 7.559987 10.0 0.0 9.7 2 13.6 15.0 1693606511
3 1 9.536058651858337 9.189114 9.189114 9.189114 0 7.559987 10.0 0.0 9.7 2 13.6 15.0 680233354

This case matrix represents DLC 6.1 and shows the initial conditions (BlPitch*, RotSpeed) as well as the sea state (WaveHs, WaveTp) and wind condtions (HWindSpeed, RandSeed1) for each case.

Modeling Option Outputs
-----------------------

Additionally, the DLC options are outputted in the modeling options of WEIS.
These outputs can be used as inputs for future runs to exactly reproduce specific cases::

DLC_driver:
DLCs:
- DLC: '1.1'
wind_speed: [3.0, 5.0, 7.0, 9.0, 11.0, 13.0, 15.0, 17.0, 19.0, 21.0, 23.0, 25.0]
ws_bin_size: 2
n_seeds: 1
n_azimuth: 1
wind_seed: [1501552846, 488200390, 1693606511, 680233354, 438466540, 1712329281, 1380152456, 1452245847, 2122694022, 839901364, 1802651553, 714712467]
wave_seeds: [304524126, 1192975140, 1668389755, 489172031, 349375909, 208787680, 426140584, 37937012, 1601914564, 1619243266, 413287548, 918595805]
wind_heading: [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]
turbine_status: operating
wave_period: [8.3, 8.3, 7.7, 7.1, 6.3, 6.1, 6.2, 6.2, 6.7, 7.1, 7.1, 7.7]
wave_height: [0.84, 0.87, 0.99, 1.15, 1.34, 1.58, 1.82, 2.08, 2.34, 2.66, 2.98, 3.28]
wave_heading: [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]
wave_gamma: [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]
probabilities: [0.08333333333333333, 0.08333333333333333, 0.08333333333333333, 0.08333333333333333, 0.08333333333333333, 0.08333333333333333, 0.08333333333333333, 0.08333333333333333, 0.08333333333333333, 0.08333333333333333, 0.08333333333333333, 0.08333333333333333]
IEC_WindType: NTM
analysis_time: 600.0
transient_time: 120.0
shutdown_time: 9999
turbulent_wind: {flag: false, Echo: false, RandSeed1: 1, RandSeed2: RANLUX, WrBHHTP: false, WrFHHTP: false, WrADHH: false, WrADFF: true, WrBLFF: false, WrADTWR: false, WrFMTFF: false, WrACT: false, Clockwise: false, ScaleIEC: 0, NumGrid_Z: 25, NumGrid_Y: 25, TimeStep: 0.05, UsableTime: ALL, HubHt: 0, GridHeight: 0, GridWidth: 0, VFlowAng: 0.0, HFlowAng: 0.0, TurbModel: IECKAI, UserFile: unused, IECstandard: 1-ED3, ETMc: default, WindProfileType: PL, ProfileFile: unused, RefHt: 0, URef: -1, IECturbc: -1, ZJetMax: default, PLExp: -1, Z0: default, Latitude: default, RICH_NO: 0.05, UStar: default, ZI: default, PC_UW: default, PC_UV: default, PC_VW: default, SCMod1: default, SCMod2: default, SCMod3: default, InCDec1: default, InCDec2: default, InCDec3: default, CohExp: default, CTEventPath: unused, CTEventFile: RANDOM, Randomize: true, DistScl: 1.0, CTLy: 0.5, CTLz: 0.5, CTStartTime: 30}
wake_mod: 1
wave_model: 2
label: '1.1'
sea_state: normal
PSF: 1.35
yaw_misalign: [0]
total_time: 720.0
pitch_initial: [2.426047, 0.377375, 0.000535, 0.000535, 1.170321, 6.052129, 9.189114, 11.824437, 14.19975, 16.42107, 18.525951, 20.553121]
rot_speed_initial: [5.000012, 5.000012, 5.000012, 6.390847, 7.559987, 7.559987, 7.559987, 7.559987, 7.559987, 7.559987, 7.559987, 7.559987]
tau1_const: [69.824578732105, 40.971862185516514, 29.12612763770409, 22.53606690450444, 16.17186559734712, 11.569392828413536, 9.536058651858337, 8.207963142590629, 7.2407552404030975, 6.493729028184553, 5.894677553483227, 5.401388775677793]

--------------------------------
Expected DLC Outputs in OpenFAST
--------------------------------

DLC 1.1
-------
For each:
Short description.
Defaults?
Timeseries

DLC 1.2
-------

DLC 1.3
-------

DLC 1.4
-------

DLC 1.5
-------

DLC 1.6
-------

DLC 5.1
-------

DLC 6.1
-------

DLC 6.3
-------

DLC 6.4
-------


------------------------
User-defined DLC Example
------------------------


------------------------------------
Setting up New DLCs (for developers)
------------------------------------





.. _DLC options:

------------------------
DLC Option Input Listing
------------------------

The following inputs are a subset of the options available in the ``modeling_options`` file.

.. jsonschema:: inputs/modeling_schema.json#/definitions/DLC_driver
:hide_key_if_empty: /**/default
.. How WEIS works
.. --------------
.. 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
Loading

0 comments on commit 9df78c2

Please sign in to comment.