NLRWindSystems · RHammond2 · Oct 2, 2025 · Oct 2, 2025 · Oct 2, 2025 · Oct 2, 2025
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -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

diff --git a/docs/docstrings/input_variable_guide.csv b/docs/docstrings/input_variable_guide.csv
diff --git a/docs/docstrings/input_variable_guide.json b/docs/docstrings/input_variable_guide.json
diff --git a/docs/docstrings/output_variable_guide.csv b/docs/docstrings/output_variable_guide.csv
diff --git a/docs/docstrings/output_variable_guide.json b/docs/docstrings/output_variable_guide.json
diff --git a/docs/docstrings/update_variable_guides.py b/docs/docstrings/update_variable_guides.py
@@ -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()
@@ -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")
 
@@ -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 = []
@@ -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")
-
diff --git a/docs/examples/02_refturb/tutorial.rst b/docs/examples/02_refturb/tutorial.rst
@@ -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.

diff --git a/docs/modules.rst b/docs/modules.rst
@@ -24,3 +24,4 @@ Module documentation
    wisdem/pyframe3dd/index
    wisdem/rotorse/index
    wisdem/towerse/index
+   wisdem/wombat/index
diff --git a/docs/wisdem/ccblade/documentation.rst b/docs/wisdem/ccblade/documentation.rst
@@ -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:
diff --git a/docs/wisdem/wombat/index.rst b/docs/wisdem/wombat/index.rst
@@ -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
diff --git a/environment_dev.yml b/environment_dev.yml
@@ -43,3 +43,4 @@ dependencies:
     - sphinx_rtd_theme>=1.3
     - sphinx-jsonschema
     - sphinx-copybutton
+    - docstring-parser
diff --git a/examples/02_reference_turbines/modeling_options_iea10.yaml b/examples/02_reference_turbines/modeling_options_iea10.yaml
@@ -69,6 +69,20 @@ WISDEM:
         tower_mass_cost_coeff: 2.9
         controls_machine_rating_cost_coeff: 21.15
         crane_cost: 12000.0
+    OpEx:
+        flag: True
+        workday_start: 7
+        workday_end: 19
+        equipment_dispatch_distance: 116
+        n_ctv: 3
+        maintenance_start: None
+        non_operational_start: None
+        non_operational_end: None
+        reduced_speed_start: None
+        reduced_speed_end: None
+        reduced_speed: 0
+        n_hlv: 1
+        random_seed: 42
 
 Environment:
     air_density: 1.225

diff --git a/examples/02_reference_turbines/modeling_options_iea15.yaml b/examples/02_reference_turbines/modeling_options_iea15.yaml
@@ -24,7 +24,7 @@ WISDEM:
         distance_to_substation: 1.0
         distance_to_interconnection: 8.5
         interconnect_voltage: 130.
-        distance_to_site: 115.
+        distance_to_site: 115.  # TODO: check on updated COWER asumptions
         distance_to_landfall: 50.
         port_cost_per_month: 2e6
         review_cost: 0.0
@@ -35,6 +35,27 @@ WISDEM:
         site_assessment_cost: 50e6
         construction_plan_cost: 2.5e5
         installation_plan_cost: 1e6
+    OpEx:
+        flag: True
+        workday_start: 7
+        workday_end: 19
+        equipment_dispatch_distance: 116
+        n_ctv: 3
+        maintenance_start: None
+        non_operational_start: None
+        non_operational_end: None
+        reduced_speed_start: None
+        reduced_speed_end: None
+        reduced_speed: 0
+        n_hlv: 1
+        random_seed: 42
+        # TODO: move to floating example?
+        # n_tugboat: 2
+        # port_workday_start: 6
+        # port_workday_end: 18
+        # n_port_crews: 2
+        # max_port_operations: 2
+        # repair_port_distance: 116
     LCOE:
         flag: True
         wake_loss_factor: 0.15

diff --git a/examples/02_reference_turbines/modeling_options_iea22.yaml b/examples/02_reference_turbines/modeling_options_iea22.yaml
@@ -68,6 +68,20 @@ WISDEM:
         reserve_margin_price: 120.0
         capacity_credit: 0.0
         benchmark_price: 0.071
+    OpEx:
+        flag: True
+        workday_start: 7
+        workday_end: 19
+        equipment_dispatch_distance: 116
+        n_ctv: 3
+        maintenance_start: None
+        non_operational_start: None
+        non_operational_end: None
+        reduced_speed_start: None
+        reduced_speed_end: None
+        reduced_speed: 0
+        n_hlv: 1
+        random_seed: 42
 
 Environment:
     air_density: 1.225

diff --git a/examples/02_reference_turbines/modeling_options_iea3p4.yaml b/examples/02_reference_turbines/modeling_options_iea3p4.yaml
@@ -52,6 +52,20 @@ WISDEM:
         tower_mass_cost_coeff: 2.9
         controls_machine_rating_cost_coeff: 21.15
         crane_cost: 12.e+3
+    OpEx:
+        flag: True
+        workday_start: 7
+        workday_end: 19
+        equipment_dispatch_distance: 116
+        n_ctv: 3
+        maintenance_start: None
+        non_operational_start: None
+        non_operational_end: None
+        reduced_speed_start: None
+        reduced_speed_end: None
+        reduced_speed: 0
+        n_hlv: 1
+        random_seed: 42
 Environment:
     air_density: 1.225
     air_dyn_viscosity: 1.81e-5

diff --git a/examples/02_reference_turbines/modeling_options_nrel5.yaml b/examples/02_reference_turbines/modeling_options_nrel5.yaml
@@ -53,6 +53,20 @@ WISDEM:
         tower_mass_cost_coeff: 2.9
         controls_machine_rating_cost_coeff: 21.15
         crane_cost: 12e3
+    OpEx:
+        flag: True
+        workday_start: 7
+        workday_end: 19
+        equipment_dispatch_distance: 0
+        n_ctv: 3
+        maintenance_start: None
+        non_operational_start: None
+        non_operational_end: None
+        reduced_speed_start: None
+        reduced_speed_end: None
+        reduced_speed: 0
+        n_hlv: 1
+        random_seed: 42
 Environment:
     air_density: 1.225
     air_dyn_viscosity: 1.81e-5

diff --git a/pyproject.toml b/pyproject.toml
@@ -56,14 +56,15 @@ dependencies = [
   "numpy",
   "openmdao",
   "openpyxl",
-  "orbit-nrel>=1.2.1",
+  "orbit-nrel>=1.2.5",
   "pandas",
   "pydoe3",
   "pyyaml",
   "scipy",
   "sortedcontainers",
   "statsmodels>=0.14.5",
   "windIO",
+  "wombat>=0.13.1"
 ]
 
 # List additional groups of dependencies here (e.g. development
@@ -85,6 +86,7 @@ docs = [
   "sphinx-jsonschema",
   "sphinx-copybutton",
   "numpydoc",
+  "docstring-parser",
 ]
 opt = ["pyoptsparse","nlopt"]