Skip to content
Open
Show file tree
Hide file tree
Changes from 109 commits
Commits
Show all changes
111 commits
Select commit Hold shift + click to select a range
f03ad31
add wombat bones
RHammond2 Oct 2, 2025
446c74e
add basics for wombat API entrypoint
RHammond2 Oct 2, 2025
24ec954
replace remaining orbit naming references
RHammond2 Oct 2, 2025
40a23db
add basic outputs
RHammond2 Oct 2, 2025
4b40dd6
continue tinkering
RHammond2 Oct 10, 2025
04a6f8c
add more bones to the skeleton
RHammond2 Oct 29, 2025
7869ded
move config-scenario setup to setup
RHammond2 Nov 3, 2025
88510c0
add start of turbine options
RHammond2 Nov 3, 2025
47f0650
add missing default value
RHammond2 Nov 3, 2025
88f5b04
add placeholders for the key failure data for all model inputs
RHammond2 Nov 6, 2025
a2b28a2
add wombat as dependency
RHammond2 Nov 6, 2025
b2d6804
add turbine configuration inputs
RHammond2 Nov 6, 2025
36eaee0
update compute to use configuration inputs
RHammond2 Nov 6, 2025
f31b27b
update orbit dependency for incoming features
RHammond2 Nov 6, 2025
0d97725
add layout to orbit output, and use it for wombat's layout
RHammond2 Nov 6, 2025
c2e8496
add wombat outputs
RHammond2 Nov 6, 2025
2ba419b
create hooks for wisdem integration
ptrbortolotti Nov 10, 2025
d1c39b0
start adding appropriate level of user inputs
RHammond2 Nov 12, 2025
a7bf747
add schema documentation to the base opex inputs
RHammond2 Nov 12, 2025
37dfb95
update none and number
RHammond2 Nov 12, 2025
a5ea16b
update number to n
RHammond2 Nov 12, 2025
e8667bb
create glue code
RHammond2 Nov 12, 2025
1d73158
connect inputs during compile
RHammond2 Nov 12, 2025
1e126ac
add weather
RHammond2 Nov 13, 2025
40cb9bf
fix units
RHammond2 Nov 13, 2025
686331c
fix incorrect encoding and reorder scenario-specific inputs
RHammond2 Nov 13, 2025
23b50aa
convert turbine costs to proportional and fix bad default library ref…
RHammond2 Nov 13, 2025
646008d
fix todo notes
RHammond2 Nov 13, 2025
a77712d
ensure inputs are included in setup
RHammond2 Nov 14, 2025
d7ecda1
start adding outputs
RHammond2 Nov 14, 2025
dd5f254
update outputs
RHammond2 Nov 14, 2025
3e230ec
fix runtime setup issues
RHammond2 Nov 14, 2025
f58bd76
resolving improper use of discrete/continuous connections
RHammond2 Nov 17, 2025
d52e48d
hook two connections to wisdem
ptrbortolotti Nov 18, 2025
d39fc04
enable ivc for user inputs and remove internally connected information
RHammond2 Nov 18, 2025
2c7bfe0
fix missing connections
RHammond2 Nov 18, 2025
4773436
fix inputs compilation errors
RHammond2 Nov 19, 2025
562f823
fix improper weather loading usage and simply read the data
RHammond2 Nov 19, 2025
2475406
fix improper weather loading usage and simply read the data
RHammond2 Nov 19, 2025
c7b4339
check for none before formatting actual inputs
RHammond2 Nov 19, 2025
d08427a
convert input lists to single values
RHammond2 Nov 19, 2025
3d85c24
fix capacity reference
RHammond2 Nov 19, 2025
0fb9b7f
fix bad output values
RHammond2 Nov 19, 2025
1a715b6
connect annual opex to financese
RHammond2 Nov 19, 2025
b235ce8
cleanup completed todos
RHammond2 Nov 19, 2025
6436fcc
remove years from user input
RHammond2 Nov 20, 2025
2ed9d3c
connect random seed and add missing connections
RHammond2 Nov 21, 2025
85e8918
merge develop and fix conflict
RHammond2 Nov 25, 2025
5af2eb1
add wombat documentation reference
RHammond2 Dec 4, 2025
e24a129
move wombat computation to be fore financese model is run
RHammond2 Dec 4, 2025
f83ec1d
add final outputs
RHammond2 Dec 4, 2025
80c6c1e
include wombat page in docs
RHammond2 Dec 4, 2025
08b6d78
add wombat input variables to input guide
RHammond2 Dec 4, 2025
af67221
run pre-commit on wombat api
RHammond2 Dec 4, 2025
03d4774
remove manually generated input docs
RHammond2 Dec 4, 2025
230961b
add land-based connections and shared inputs from offshore
RHammond2 Jan 5, 2026
bc1abd4
update scenario handling
RHammond2 Jan 5, 2026
bad8561
update error
RHammond2 Jan 5, 2026
3538e25
update pre-commit
RHammond2 Jan 5, 2026
24c46dd
convert radian input to degrees
gbarter Jan 6, 2026
1dbf672
add landbosse outputs for wombat usage and layout creation
RHammond2 Jan 6, 2026
5200258
enable wombat for all reference examples
RHammond2 Jan 6, 2026
d06c2d5
fix bad input connections and typos
RHammond2 Jan 6, 2026
21bef1c
fix missing connection for docstring build
RHammond2 Jan 7, 2026
08afda1
fix typos in docs
RHammond2 Jan 7, 2026
1a85733
udpate input and output variable guides
RHammond2 Jan 7, 2026
81dcdd6
add missing docs requirement
RHammond2 Jan 7, 2026
53024c8
bump wombat version for capacity check fix
RHammond2 Jan 7, 2026
541bf36
bump orbit for latest release
RHammond2 Jan 8, 2026
19af462
merge develop and fix conflicts
RHammond2 Jan 8, 2026
b69828f
update orbit release number after versioning patch
RHammond2 Jan 12, 2026
bb9d63c
update organization name
ptrbortolotti Jan 14, 2026
b750a62
update reg values iea 15 lcoe (??)
ptrbortolotti Jan 14, 2026
90222e3
forgot one file
ptrbortolotti Jan 14, 2026
24bd9b4
Merge pull request #692 from NLRWindSystems/new_org
gbarter Jan 15, 2026
b26854e
update environment yamls
RHammond2 Jan 15, 2026
6a64d1b
fix bad defaults causing full system value materials costs for all fa…
RHammond2 Jan 16, 2026
1ca2945
remove double counting of rhub in cg calculation
gbarter Jan 21, 2026
7cbdc8c
update unit tests for better representation of r that has r[0]=rhub
gbarter Jan 21, 2026
bee51a1
correct truth values with RNA cg now slightly shifted impacting tower…
gbarter Jan 22, 2026
70e6c53
Merge pull request #694 from NLRWindSystems/fix_bladecg
ptrbortolotti Jan 22, 2026
641d98a
rename variable for blade cg location
ptrbortolotti Jan 22, 2026
2abc643
improve description
ptrbortolotti Jan 22, 2026
77350ff
Merge pull request #695 from NLRWindSystems/rename_blade_cg
ptrbortolotti Jan 23, 2026
ed36b72
turn off wombat for nrel5, adjust lcoe for 3.4 and 15
ptrbortolotti Feb 10, 2026
5beb7ec
Merge branch 'develop' into feature/wombat-intregration
ptrbortolotti Feb 10, 2026
a2094d7
minor wombat settings updates
RHammond2 Feb 11, 2026
3b0ebc3
convert tests to pytest and add ability to test w/ & w/o WOMBAT OpEx …
RHammond2 Feb 11, 2026
542dcdc
use correct decimals
RHammond2 Feb 11, 2026
05ac97d
include cost and efficiency model for the converter from Sam Seo and …
ptrbortolotti Feb 12, 2026
24af4c6
let's turn wombat off for the 3.4mw, which is used in some tests with…
ptrbortolotti Feb 12, 2026
cc0731c
Merge branch 'feature/wombat-intregration' of github.com:RHammond2/WI…
ptrbortolotti Feb 12, 2026
2a0d715
fix drivetrain test error
ptrbortolotti Feb 12, 2026
a1c0b90
run example 19 without wombat
ptrbortolotti Feb 12, 2026
396d8b1
Merge pull request #691 from RHammond2/feature/wombat-intregration
ptrbortolotti Feb 13, 2026
17ee460
Merge branch 'develop' of github.com:NLRWindSystems/WISDEM into conve…
ptrbortolotti Feb 13, 2026
0fc637c
fix test glue code
ptrbortolotti Feb 13, 2026
3c4089f
15mw and 22mw running [skip ci]
ptrbortolotti Feb 13, 2026
e274df9
Merge pull request #697 from NLRWindSystems/converter
gbarter Feb 14, 2026
5a34637
update yaml files with new control block [skip ci]
ptrbortolotti Feb 17, 2026
870190d
work on power tests [skip ci]
ptrbortolotti Feb 17, 2026
fb28640
keep working on tests [skip ci]
ptrbortolotti Feb 17, 2026
9a3b02d
section commented by mistake [skip ci]
ptrbortolotti Feb 17, 2026
46d3807
use max_allowable_blade_tip_speed, start running GHA
ptrbortolotti Feb 17, 2026
ee1973b
fix a couple of yamls
ptrbortolotti Feb 17, 2026
0e109de
fix bar yamls
ptrbortolotti Feb 18, 2026
3af8c6d
improve if condition for max rotor speed
ptrbortolotti Feb 18, 2026
8fb8f05
Merge pull request #698 from NLRWindSystems/windIO2p1
ptrbortolotti Feb 18, 2026
86b1f6f
up version to 4.1.0
ptrbortolotti Feb 18, 2026
269f0fa
update to windIO 2.1.1, cut in and cut out in assembly block of geome…
ptrbortolotti Feb 25, 2026
67f2c06
Merge pull request #700 from NLRWindSystems/windIO2p1p1
ptrbortolotti Feb 25, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
repos:
- repo: https://github.com/PyCQA/isort
rev: 5.12.0
rev: 7.0.0
hooks:
- id: isort
name: isort
stages: [pre-commit]

- repo: https://github.com/psf/black
rev: stable
rev: 25.12.0
hooks:
- id: black
name: black
stages: [pre-commit]
language_version: python3

- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.4.0
rev: v6.0.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# WISDEM®

[![Actions Status](https://github.com/WISDEM/WISDEM/workflows/CI_WISDEM/badge.svg?branch=develop)](https://github.com/WISDEM/WISDEM/actions)
[![Coverage Status](https://coveralls.io/repos/github/WISDEM/WISDEM/badge.svg?branch=develop)](https://coveralls.io/github/WISDEM/WISDEM?branch=develop)
[![Actions Status](https://github.com/NLRWindSystems/WISDEM/workflows/CI_WISDEM/badge.svg?branch=develop)](https://github.com/NLRWindSystems/WISDEM/actions)
[![Coverage Status](https://coveralls.io/repos/github/NLRWindSystems/WISDEM/badge.svg?branch=develop)](https://coveralls.io/github/NLRWindSystems/WISDEM?branch=develop)
[![Documentation Status](https://readthedocs.org/projects/wisdem/badge/?version=master)](https://wisdem.readthedocs.io/en/master/?badge=master)


Expand Down Expand Up @@ -108,7 +108,7 @@ Setup and activate the Anaconda environment from a prompt (Anaconda3 Power Shell
2. Clone the repository and enter it:

```console
git clone https://github.com/WISDEM/WISDEM.git
git clone https://github.com/NLRWindSystems/WISDEM.git
cd WISDEM
```

Expand Down Expand Up @@ -174,4 +174,4 @@ the examples or just run the examples. Otherwise, all tests will be run.

## Feedback

For software issues please use <https://github.com/WISDEM/WISDEM/issues>. For functionality and theory related questions and comments please use the NWTC forum for [Systems Engineering Software Questions](https://wind.nrel.gov/forum/wind/viewtopic.php?f=34&t=1002).
For software issues please use <https://github.com/NLRWindSystems/WISDEM/issues>. For functionality and theory related questions and comments please use the NWTC forum for [Systems Engineering Software Questions](https://wind.nrel.gov/forum/wind/viewtopic.php?f=34&t=1002).
3,475 changes: 2,674 additions & 801 deletions docs/docstrings/input_variable_guide.csv

Large diffs are not rendered by default.

8,439 changes: 8,438 additions & 1 deletion docs/docstrings/input_variable_guide.json

Large diffs are not rendered by default.

5,843 changes: 3,007 additions & 2,836 deletions docs/docstrings/output_variable_guide.csv

Large diffs are not rendered by default.

9,714 changes: 9,713 additions & 1 deletion docs/docstrings/output_variable_guide.json

Large diffs are not rendered by default.

34 changes: 19 additions & 15 deletions docs/docstrings/update_variable_guides.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
#!/usr/bin/env python
import numpy as np
import os.path as osp

import numpy as np
from get_docstrings import get_all_docstrings

from wisdem import run_wisdem
from wisdem.commonse import fileIO
from get_docstrings import get_all_docstrings

# Get all docstrings from WISDEM files
parsed_dict = get_all_docstrings()
Expand All @@ -14,6 +15,8 @@
mydir = osp.join(examp_dir, "02_reference_turbines")
iea15_mono_geom = osp.join(mydir, "IEA-15-240-RWT.yaml")
iea3p4_geom = osp.join(mydir, "IEA-3p4-130-RWT.yaml")
iea15_float_modeling = osp.join(mydir, "modeling_options_iea15.yaml")
iea3p4_float_modeling = osp.join(mydir, "modeling_options_iea3p4.yaml")
rwt_modeling = osp.join(mydir, "modeling_options.yaml")
rwt_analysis = osp.join(mydir, "analysis_options.yaml")

Expand All @@ -27,10 +30,12 @@
rwt_jack_modeling = osp.join(mydir, "modeling_options_jacket.yaml")
rwt_jack_analysis = osp.join(mydir, "analysis_options_jacket.yaml")

iea15_mono_prob, model_dict, anal_dict = run_wisdem(iea15_mono_geom, rwt_modeling, rwt_analysis)
iea3p4_prob, _, _ = run_wisdem(iea3p4_geom , rwt_modeling, rwt_analysis)
iea15_float_prob, model_float_dict, anal_float_dict = run_wisdem(iea15_float_geom, rwt_float_modeling, rwt_float_analysis)
nrel_jack_prob, model_jack_dict, anal_jack_dict = run_wisdem(iea15_float_geom, rwt_float_modeling, rwt_float_analysis)
iea15_mono_prob, model_dict, anal_dict = run_wisdem(iea15_mono_geom, iea15_float_modeling, rwt_analysis)
iea3p4_prob, _, _ = run_wisdem(iea3p4_geom, iea3p4_float_modeling, rwt_analysis)
iea15_float_prob, model_float_dict, anal_float_dict = run_wisdem(
iea15_float_geom, rwt_float_modeling, rwt_float_analysis
)
nrel_jack_prob, model_jack_dict, anal_jack_dict = run_wisdem(iea15_float_geom, rwt_float_modeling, rwt_float_analysis)

# Extract inputs and outputs from the models
all_inputs = []
Expand All @@ -44,35 +49,34 @@
all_inputs.extend(input_k)
all_outputs.extend(output_k)


# Use Pandas for some data cleansing and writing to csv
def write_guide(in_dict, fname):
mydf = fileIO.variable_dict2df(in_dict)
mydf.rename(columns={"variables":"Variable",
"units":"Units",
"description":"Description"}, inplace=True)
mydf.rename(columns={"variables": "Variable", "units": "Units", "description": "Description"}, inplace=True)
mydf = mydf[["Variable", "Units", "Description"]]
mydf.set_index("Variable", inplace=True)
mydf = mydf[~mydf.index.duplicated(keep='first')]
mydf = mydf[~mydf.index.duplicated(keep="first")]
mydf.reset_index(inplace=True)

# Fold in docstrings
mynames = mydf["Variable"].to_list()
mydesc = mydf["Description"].to_list()
mydesc = mydf["Description"].to_list()
for k in range(len(mynames)):
ivar = mynames[k]
if ivar in parsed_dict:
idesc = parsed_dict[ivar]
mydesc[k] += "" if idesc is None else idesc
mydf["Description"] = mydesc
mydf['Units'] = mydf['Units'].replace(np.nan, '-')
mydf['Description'] = mydf['Description'].replace(np.nan,'None')
mydf["Units"] = mydf["Units"].replace(np.nan, "-")
mydf["Description"] = mydf["Description"].replace(np.nan, "None")

# Write everything out
mydf.to_csv(fname, index=False)
mydf.to_json(fname.replace('csv','json'))#, index=False)
mydf.to_json(fname.replace("csv", "json")) # , index=False)

return mydf


inputs_df = write_guide(all_inputs, "input_variable_guide.csv")
outputs_df = write_guide(all_outputs, "output_variable_guide.csv")

8 changes: 4 additions & 4 deletions docs/examples/01_nrelcsm/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ The final lines highlight the mass breakdown summaries:
>>> nacelle_mass [165460.38774975] kg
>>> turbine_mass [442906.80408368] kg

See the full source for this example on `Github <https://github.com/WISDEM/WISDEM/blob/master/examples/01_nrel_csm/mass.py>`_.
See the full source for this example on `Github <https://github.com/NLRWindSystems/WISDEM/blob/master/examples/01_nrel_csm/mass.py>`_.


Turbine Component Masses and Costs Using the NREL_CSM (2015)
Expand Down Expand Up @@ -95,7 +95,7 @@ The final screen output is:
>>> turbine_cost [3543676.12253719] USD
>>> turbine_cost_kW [708.73522451] USD/kW

See the full source for this example on `Github <https://github.com/WISDEM/WISDEM/blob/master/examples/01_nrel_csm/mass_and_cost.py>`__.
See the full source for this example on `Github <https://github.com/NLRWindSystems/WISDEM/blob/master/examples/01_nrel_csm/mass_and_cost.py>`__.


Turbine Component Costs Using the NREL_CSM (2015)
Expand Down Expand Up @@ -175,7 +175,7 @@ We can also print out an exhaustive listing of the inputs and outputs to each su
:start-after: # 5 ---
:end-before: # 5 ---

See the full source for this example on `Github <https://github.com/WISDEM/WISDEM/blob/master/examples/01_nrel_csm/costs.py>`__.
See the full source for this example on `Github <https://github.com/NLRWindSystems/WISDEM/blob/master/examples/01_nrel_csm/costs.py>`__.



Expand Down Expand Up @@ -234,7 +234,7 @@ To store for later postprocessing, we save everything into a large csv-file. Fl
:start-after: # 7 ---
:end-before: # 7 ---

See the full source for this example on `Github <https://github.com/WISDEM/WISDEM/blob/master/examples/01_nrel_csm/parametric.py>`__.
See the full source for this example on `Github <https://github.com/NLRWindSystems/WISDEM/blob/master/examples/01_nrel_csm/parametric.py>`__.

.. bibliography:: ../../references.bib
:filter: docname in docnames
2 changes: 1 addition & 1 deletion docs/examples/02_refturb/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Alternatively, you can create a summary WISDEM file that points to each file,

Where the contents of ``nrel5mw_driver.yaml`` are,

.. literalinclude:: /../examples/02_reference_turbines/nrel5mw_driver.yaml
.. literalinclude:: /../examples/02_reference_turbines/nrel5mw.yaml
:language: yaml

Note that to run the IEA Wind 15-MW reference wind turbine, simply substitute the file, ``IEA-15-240-RWT.yaml``, in as the geometry file. The ``modeling_options.yaml`` and ``analysis_options.yaml`` file can remain the same.
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/11_user_custom/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
11a. User Customized Optimization Example
-----------------------------

WISDEM offers a long list of design variables, figures of merit, and constraints that users can call in their ``analysis_options.yaml``. The full list is specified in the `modeling_options.yaml <https://github.com/WISDEM/WISDEM/blob/develop/examples/02_reference_turbines/modeling_options.yaml>`. In addition, WISDEM now offers the option to build your own optimization problem by setting any available input as a design variable and any available output as either a constraint or a figure of merit. This example 11 shows how to build your customized ``analysis_options.yaml``.
WISDEM offers a long list of design variables, figures of merit, and constraints that users can call in their ``analysis_options.yaml``. The full list is specified in the `modeling_options.yaml <https://github.com/NLRWindSystems/WISDEM/blob/develop/examples/02_reference_turbines/modeling_options.yaml>`. In addition, WISDEM now offers the option to build your own optimization problem by setting any available input as a design variable and any available output as either a constraint or a figure of merit. This example 11 shows how to build your customized ``analysis_options.yaml``.

In this example, we start from a 5MW land-based wind turbine that was developed within the Big Adaptive Rotor project (for more details refer to https://github.com/NREL/BAR_Designs) and we ask WISDEM to optimize the rated power of the turbine to minimize the levelized value of energy (LVOE) while keeping the turbine capital cost (TCC) within certain limits. Note that the focus of this example is on the capability of WISDEM, more than on the actual problem setup.

Expand Down
6 changes: 3 additions & 3 deletions docs/first_steps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ WISDEM just needs three input files for many optimization and analysis operation
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
| Description | Suggested Default to Modify | Where to learn more |
+===========================+===============================================================================================================================+==============================================================================+
| Geometry of the turbine | `nrel5mw.yaml <https://github.com/WISDEM/WISDEM/blob/develop/examples/02_reference_turbines/nrel5mw.yaml>`_ | `WindIO docs <https://windio.readthedocs.io/en/latest/source/turbine.html>`_ |
| Geometry of the turbine | `nrel5mw.yaml <https://github.com/NLRWindSystems/WISDEM/blob/develop/examples/02_reference_turbines/nrel5mw.yaml>`_ | `WindIO docs <https://windio.readthedocs.io/en/latest/source/turbine.html>`_ |
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
| Modeling options | `modeling_options.yaml <https://github.com/WISDEM/WISDEM/blob/develop/examples/02_reference_turbines/modeling_options.yaml>`_ | :ref:`modeling-options` |
| Modeling options | `modeling_options.yaml <https://github.com/NLRWindSystems/WISDEM/blob/develop/examples/02_reference_turbines/modeling_options.yaml>`_ | :ref:`modeling-options` |
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
| Analysis options | `analysis_options.yaml <https://github.com/WISDEM/WISDEM/blob/develop/examples/02_reference_turbines/analysis_options.yaml>`_ | :ref:`analysis-options` |
| Analysis options | `analysis_options.yaml <https://github.com/NLRWindSystems/WISDEM/blob/develop/examples/02_reference_turbines/analysis_options.yaml>`_ | :ref:`analysis-options` |
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+

There are two options to run WISDEM with these files. The first option is to use a text editor to modify files and to run WISDEM from the command line. The second option is to edit the files with a GUI and run WISDEM with the click of a button. This document will describe both of these options in turn.
Expand Down
2 changes: 1 addition & 1 deletion docs/how_to_write_docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ text files near seamlessly.
How to request doc creation
---------------------------
If you think the docs should be modified or expanded, create an issue on the GitHub documentation repository.
Do this by going to the `WISDEM repo <https://github.com/WISDEM/WISDEM/>`__ then click on Issues on the lefthand side of the page.
Do this by going to the `WISDEM repo <https://github.com/NLRWindSystems/WISDEM/>`__ then click on Issues on the lefthand side of the page.
There you can see current requests for doc additions as well as adding your own.
Feel free to add any issue for any type of doc and members of the WISDEM development team can determine how to approach it.
Assign someone or a few people to the issue who you think would be a good fit for that doc.
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ This software is provided as-is and without warranty. There are no guarantees it
Important Links
---------------

- `Source Code Repository <https://github.com/WISDEM/WISDEM>`_
- `Source Code Repository <https://github.com/NLRWindSystems/WISDEM>`_
- `OpenMDAO <https://openmdao.org/>`_

Feedback
---------------

For software issues please use the `Github Issues Tracker <https://github.com/WISDEM/WISDEM/issues>`_. For functionality and theory related questions and comments please use the NWTC forum for `Systems Engineering Software Questions <https://wind.nrel.gov/forum/wind/viewtopic.php?f=34&t=1002>`_.
For software issues please use the `Github Issues Tracker <https://github.com/NLRWindSystems/WISDEM/issues>`_. For functionality and theory related questions and comments please use the NWTC forum for `Systems Engineering Software Questions <https://wind.nrel.gov/forum/wind/viewtopic.php?f=34&t=1002>`_.

Documentation Outline
------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Setup and activate the Anaconda environment from a prompt (Anaconda3 Power Shell

.. code-block:: bash

git clone https://github.com/WISDEM/WISDEM.git
git clone https://github.com/NLRWindSystems/WISDEM.git
cd WISDEM


Expand Down
1 change: 1 addition & 0 deletions docs/modules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@ Module documentation
wisdem/pyframe3dd/index
wisdem/rotorse/index
wisdem/towerse/index
wisdem/wombat/index
2 changes: 1 addition & 1 deletion docs/wisdem/ccblade/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,6 @@ A Polar object is meant to represent the variation in lift, drag, and pitching m

.. module:: wisdem.ccblade.Polar

.. autoclass:: wisdem.ccblae.Polar.Polar
.. autoclass:: wisdem.ccblade.Polar.Polar

.. _polar-class-label:
4 changes: 2 additions & 2 deletions docs/wisdem/floatingse/execution.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ environment, and the operational constraints, are required to evaluate
the total mass, cost, and code compliance. These variables are also
included in the `WindIO <https://windio.readthedocs.io/en/latest/>`_
effort or found in the `floating-specific examples
<https://github.com/WISDEM/WISDEM/tree/master/examples/09_floating>`_
<https://github.com/NLRWindSystems/WISDEM/tree/master/examples/09_floating>`_
for standalone execution.


Expand Down Expand Up @@ -71,7 +71,7 @@ Examples
--------

As mentioned previously `floating-specific examples
<https://github.com/WISDEM/WISDEM/tree/master/examples/09_floating>`_
<https://github.com/NLRWindSystems/WISDEM/tree/master/examples/09_floating>`_
examples are provided. These files are encoded with default starting
configurations (from :cite:`OC3` and :cite:`OC4`, respectively), with
some modifications. There is an additional spar example that also has
Expand Down
2 changes: 1 addition & 1 deletion docs/wisdem/floatingse/geometry.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ ones shown.
Inputs: WindIO
--------------

The parameterization of the input variables in the Geometry YAML file into *FloatingSE* is documented within the larger `WindIO <https://windio.readthedocs.io/en/latest/>`_ effort. When running *FloatingSE* directly as a standalone with a python script, users are encouraged to review the `floating-specific examples <https://github.com/WISDEM/WISDEM/tree/master/examples/09_floating>`_ for syntax.
The parameterization of the input variables in the Geometry YAML file into *FloatingSE* is documented within the larger `WindIO <https://windio.readthedocs.io/en/latest/>`_ effort. When running *FloatingSE* directly as a standalone with a python script, users are encouraged to review the `floating-specific examples <https://github.com/NLRWindSystems/WISDEM/tree/master/examples/09_floating>`_ for syntax.

Tapered Cylinders (Vertical Frustums)
-------------------------------------
Expand Down
38 changes: 38 additions & 0 deletions docs/wisdem/wombat/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
WOMBAT
=====

Overview
--------

The land-based and offshore Windfarm Operations and Maintenance cost-Beneft Anaylysis Tool (WOMBAT) is a low fidelity,
process-based, discrete event simulation model to understand the cost, energy production, and downtime implications
of technological and maintenance-based changes to the operations and maintenance (O&M) phase of the wind life cycle.

WOMBAT allows for the modeling of arbitrarily simple or complex wind turbines, substations, cables, and hydrogen
electrolyzers through fixed-interval maintenance and Weibull-distributed failure events. Paired with the ability
to generically model many servicing equipment, WOMBAT enables users to model a plethora of wind O&M scenarios.

Documentation
-------------

WOMBAT maintains its own Github `repository <https://github.com/WISDEM/WOMBAT>`_ and
`documentation <https://wisdem.github.io/WOMBAT/>`_. WISDEM uses the default scenarios included in
the WOMBAT package, so annual updates for inflation and improved assumptions are automatically
applied to the the model.


Usage
_____

WOMBAT can be easily used as a standalone module through WISDEM or by installing from its own
`repository <https://github.com/WISDEM/WOMBAT>`_ as a separate project. For examples and
documentation on WOMBAT usage, please read the
`How To Use WOMBAT guide <https://wisdem.github.io/WOMBAT/examples/how_to.html>`_ and the linked
`API reference <https://wisdem.github.io/WOMBAT/API/index.html>`_ guides. When using WOMBAT through
WISDEM, use the following import:

>>> import wisdem.wombat

instead of

>>> import wombat
3 changes: 2 additions & 1 deletion environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ dependencies:
- statsmodels>=0.14.5
- pip
- pip:
- orbit-nrel>=1.2.1
- orbit-nrel>=1.2.5
- wombat>=0.13.1
- dearpygui
- windIO
4 changes: 3 additions & 1 deletion environment_dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,12 @@ dependencies:
- pytest-cov
- pip
- pip:
- orbit-nrel>=1.2.1
- orbit-nrel>=1.2.5
- wombat>=0.13.1
- dearpygui
- windIO
- sphinxcontrib-bibtex
- sphinx_rtd_theme>=1.3
- sphinx-jsonschema
- sphinx-copybutton
- docstring-parser
Loading
Loading