Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 14 additions & 6 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# CHANGELOG

## v0.13.2 - 10 February 2026

- Temporarily prohibit Pandas 3.0 to resolve failing tests and integrations.
- Update all instances of WISDEM -> NLRWindSystems with proper casing after the GitHub
organization's name change.
- Update all instances of NREL -> NLR (National Laboratory of the Rockies) after
official name change, except for past literature citations.

## v0.13.1 - 7 January 2026

- Updates the project capacity check for a true 6 decimal precision check.
Expand All @@ -10,15 +18,15 @@
### Default Data Now Available

- For complete details, please see the
[default data section of the user guide](https://wisdem.github.io/WOMBAT/examples/index.html#default-data)
[default data section of the user guide](https://nlrwindsystems.github.io/WOMBAT/examples/index.html#default-data)
- `"default"` library is now made available with a validated fixed and floating offshore wind reference
case based on the 2025 Cost of Wind Energy Review (COWER), and an experimental land-based
reference data set based on a variety of incomplete sources in onshore O&M studies.
- A new example
([examples/default_data_demonstration.ipynb](https://github.com/WISDEM/WOMBAT/blob/develop/examples/default_data_demonstration.ipynb))
([examples/default_data_demonstration.ipynb](https://github.com/NLRWindSystems/WOMBAT/blob/develop/examples/default_data_demonstration.ipynb))
is available to see key statistics of each scenario.
- A new example
([examples/COWER_om_workflow.ipynb](https://github.com/WISDEM/WOMBAT/blob/develop/examples/COWER_om_workflow.ipynb))
([examples/COWER_om_workflow.ipynb](https://github.com/NLRWindSystems/WOMBAT/blob/develop/examples/COWER_om_workflow.ipynb))
is available to reproduce the current year's offshore COWER results.

### Tow-To-Port Improvements
Expand Down Expand Up @@ -166,7 +174,7 @@
- `power_curve`: Includes variables `p1`, `p2`, `p3`, `p4`, `p5`, `FE` (Faradaic
efficiency), `n_cells` (per stack), and `turndown_ratio`.
- The production curve is based on the
[H2Integrate PEM electrolysis module](https://github.com/NREL/H2Integrate/blob/main/h2integrate/simulation/technologies/hydrogen/electrolysis/PEM_H2_LT_electrolyzer_Clusters.py).
[H2Integrate PEM electrolysis module](https://github.com/NLR/H2Integrate/blob/main/h2integrate/simulation/technologies/hydrogen/electrolysis/PEM_H2_LT_electrolyzer_Clusters.py).
- Electrolyzer downtime does not impact farm activities as it is assumed energy will
still flow through the export system to some other entity such as the grid.
- All stacks are currently modeled as a single entity.
Expand Down Expand Up @@ -383,7 +391,7 @@ cables:
dictionaries. Users can use the following function to update their cable, turbine,
substation, and consolidated configurations:
`wombat/core/library.py::convert_failure_data` Documentation is available at
https://wisdem.github.io/WOMBAT/API/utilities.html#importing-and-converting-from-old-versions.
https://nlrwindsystems.github.io/WOMBAT/API/utilities.html#importing-and-converting-from-old-versions.
- Updates the minimum Python version to 3.10.
- The wind farm operation level calculation was moved to `wombat/utilities/utilities.py`
so it can be reused when `Metrics` loads the operational data.
Expand Down Expand Up @@ -532,7 +540,7 @@ cables:

- Replace Flake8 and Pylint in the pre-commit workflow with ruff, and fix/ignore the resulting errors as appropriate
- Features:
- Weather data now has the ability to contain more than just the required "windspeed" and "waveheight" columns. This will allow for easier expansion of the weather model in the future, and increase compatibility with other NREL techno economic modeling frameworks.
- Weather data now has the ability to contain more than just the required "windspeed" and "waveheight" columns. This will allow for easier expansion of the weather model in the future, and increase compatibility with other NLR techno economic modeling frameworks.
- Bug fixes:
- Maintenance and failure simulation process interruptions were occuring prior to starting the process timing, and causing simulation failures.
- Duplicated parameters were being processed in `WombatEnvironment.log_action` stemming from improper handling of varying parameters in some of the more complex control flow logic in *in situ* repairs.
Expand Down
37 changes: 19 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@

[![DOI 10.2172/1894867](https://img.shields.io/badge/DOI-10.2172%2F1894867-brightgreen?link=https://doi.org/10.2172/1894867)](https://www.osti.gov/biblio/1894867)
[![PyPI version](https://badge.fury.io/py/wombat.svg)](https://badge.fury.io/py/wombat)
[![codecov](https://codecov.io/gh/WISDEM/WOMBAT/branch/main/graph/badge.svg?token=SK9M10BZXY)](https://codecov.io/gh/WISDEM/WOMBAT)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/wombat)
[![codecov](https://codecov.io/gh/NLRWindSystems/WOMBAT/branch/main/graph/badge.svg?token=SK9M10BZXY)](https://codecov.io/gh/NLRWindSystems/WOMBAT)
[![Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/WISDEM/WOMBAT/main?filepath=examples)
[![Jupyter Book](https://jupyterbook.org/badge.svg)](https://wisdem.github.io/WOMBAT)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/NLRWindSystems/WOMBAT/main?filepath=examples)
[![Jupyter Book](https://jupyterbook.org/badge.svg)](https://nlrwindsystems.github.io/WOMBAT)

[![Pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
Expand All @@ -26,7 +27,7 @@ With that said, it would be greatly appreciated for issues or PRs to be submitte
any improvements at all, from fixing typos (guaranteed to be a few) to features to
testing.

If you use this library please cite our NREL Technical Report:
If you use this library please cite our NLR Technical Report:

```bibtex
@techreport{hammond2022wombat,
Expand All @@ -44,11 +45,11 @@ If you use this library please cite our NREL Technical Report:

## Part of the WETO Stack

WOMBAT is primarily developed with the support of the U.S. Department of Energy and is part of the [WETO Software Stack](https://nrel.github.io/WETOStack). For more information and other integrated modeling software, see:
- [Portfolio Overview](https://nrel.github.io/WETOStack/portfolio_analysis/overview.html)
- [Entry Guide](https://nrel.github.io/WETOStack/_static/entry_guide/index.html)
- [Techno-Economic Modeling Workshop](https://nrel.github.io/WETOStack/workshops/user_workshops_2024.html#tea-and-cost-modeling)
- [Systems Engineering Workshop](https://nrel.github.io/WETOStack/workshops/user_workshops_2024.html#systems-engineering)
WOMBAT is primarily developed with the support of the U.S. Department of Energy and is part of the [WETO Software Stack](https://nlr.github.io/WETOStack). For more information and other integrated modeling software, see:
- [Portfolio Overview](https://nlr.github.io/WETOStack/portfolio_analysis/overview.html)
- [Entry Guide](https://nlr.github.io/WETOStack/_static/entry_guide/index.html)
- [Techno-Economic Modeling Workshop](https://nlr.github.io/WETOStack/workshops/user_workshops_2024.html#tea-and-cost-modeling)
- [Systems Engineering Workshop](https://nlr.github.io/WETOStack/workshops/user_workshops_2024.html#systems-engineering)

## WOMBAT in Action

Expand All @@ -61,10 +62,10 @@ folder, but here are a few highlights:
> features to better specify how repairs are managed.

* Dinwoodie, et al. replication for `wombat` can be found in the
`examples folder <https://github.com/WISDEM/WOMBAT/blob/main/examples/dinwoodie_validation.ipynb>`_.
`examples folder <https://github.com/NLRWindSystems/WOMBAT/blob/main/examples/dinwoodie_validation.ipynb>`_.
* IEA Task 26
`validation exercise <https://github.com/WISDEM/WOMBAT/blob/main/examples/iea_26_validation.ipynb>`_.
* Presentations: `slides <https://github.com/WISDEM/WOMBAT/blob/main/presentation_material/>`_.
`validation exercise <https://github.com/NLRWindSystems/WOMBAT/blob/main/examples/iea_26_validation.ipynb>`_.
* Presentations: `slides <https://github.com/NLRWindSystems/WOMBAT/blob/main/presentation_material/>`_.

## Setup

Expand Down Expand Up @@ -115,7 +116,7 @@ code, and/or contribute back to the project.
Install it directly into an activated virtual environment:

```console
git clone https://github.com/WISDEM/WOMBAT.git
git clone https://github.com/NLRWindSystems/WOMBAT.git
cd WOMBAT
pip install .
```
Expand All @@ -130,7 +131,7 @@ import wombat
wombat.__version__
```

For further usage, please see the documentation site at https://wisdem.github.io/WOMBAT.
For further usage, please see the documentation site at https://nlrwindsystems.github.io/WOMBAT.

### Requirements for Contributing to WOMBAT

Expand All @@ -140,10 +141,10 @@ Code contributors should note that there is both an additional dependency suite
running the tests and enabling the pre-commit workflow to automatically standardize the
core code formatting principles. In short, the following steps should be taken, but be
sure to read the
[contributor's guide](https://wisdem.github.io/WOMBAT/contributing.html)
[contributor's guide](https://nlrwindsystems.github.io/WOMBAT/contributing.html)

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

# Install the additional dependencies for running the tests and automatic code formatting
Expand Down Expand Up @@ -182,7 +183,7 @@ Basic pre-commit issues that users might encounter and their remedies:
#### Documentation Contributions

```console
git clone https://github.com/WISDEM/WOMBAT.git
git clone https://github.com/NLRWindSystems/WOMBAT.git
cd WOMBAT
pip install -e '.[docs]'
```
Expand All @@ -203,7 +204,7 @@ View the results: `docs/_build/html/index.html`
#### Code and Documentation Contributions

```console
git clone https://github.com/WISDEM/WOMBAT.git
git clone https://github.com/NLRWindSystems/WOMBAT.git
cd wombat
pip install -e '.[all]'
```
Expand Down
6 changes: 3 additions & 3 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ bibliography:

# Information about where the book exists on the web
repository:
url: https://github.com/WISDEM/WOMBAT
url: https://github.com/NLRWindSystems/WOMBAT
path_to_book: docs # Optional path to your book, relative to the repository root
branch: main # Which branch of the repository should be used when creating links (optional)

Expand Down Expand Up @@ -88,7 +88,7 @@ sphinx:
icon_links: [
{
name: GitHub,
url: "https://github.com/WISDEM/WOMBAT",
url: "https://github.com/NLRWindSystems/WOMBAT",
icon: fa-brands fa-github,
},
{
Expand All @@ -99,7 +99,7 @@ sphinx:
},
{
name: Launch Binder,
url: "https://mybinder.org/v2/gh/WISDEM/WOMBAT/main?filepath=examples",
url: "https://mybinder.org/v2/gh/NLRWindSystems/WOMBAT/main?filepath=examples",
icon: "https://mybinder.org/badge_logo.svg",
type: url,
},
Expand Down
24 changes: 12 additions & 12 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## Getting Started

These contributing guidelines should be read by software developers wishing to contribute code or
documentation changes into WOMBAT, or to push changes upstream to the main WISDEM/WOMBAT repository.
documentation changes into WOMBAT, or to push changes upstream to the main NLRWindSystems/WOMBAT repository.

1. Create a fork of WOMBAT on GitHub
2. Clone your fork of the repository
Expand Down Expand Up @@ -36,9 +36,9 @@ documentation changes into WOMBAT, or to push changes upstream to the main WISDE
pre-commit install
```

## Keeping your fork in sync with WISDEM/WOMBAT
## Keeping your fork in sync with NLRWindSystems/WOMBAT

The "main" WOMBAT repository is regularly updated with ongoing research at NREL and beyond. After
The "main" WOMBAT repository is regularly updated with ongoing research at NLR and beyond. After
creating and cloning your fork from the previous section, you might be wondering how to keep it
up to date with the latest improvements.

Expand All @@ -53,14 +53,14 @@ inevitably arise in development work.
cd /your/path/to/WOMBAT/
```

2. If you haven't already, add WISDEM/WOMBAT as the "upstream" location (or whichever naming
2. If you haven't already, add NLRWindSystems/WOMBAT as the "upstream" location (or whichever naming
convention you prefer).

```bash
git remote add upstream https://github.com/WISDEM/WOMBAT.git
git remote add upstream https://github.com/NLRWindSystems/WOMBAT.git
```

To find the name you've given WISDEM/WOMBAT again, you can simply run the following to display
To find the name you've given NLRWindSystems/WOMBAT again, you can simply run the following to display
all the remote sources you're tracking.

```bash
Expand All @@ -73,7 +73,7 @@ inevitably arise in development work.
git fetch --all
```

4. Sync the upstream (WISDEM) changes
4. Sync the upstream (NLRWindSystems) changes

```bash
# If there was a new release this will need to be updated
Expand All @@ -96,10 +96,10 @@ inevitably arise in development work.
## Issue Tracking

New feature requests, changes, enhancements, non-methodology features, and bug reports can be filed
as new issues in the [Github.com issue tracker](https://github.com/WISDEM/WOMBAT/issues) at any time.
as new issues in the [Github.com issue tracker](https://github.com/NLRWindSystems/WOMBAT/issues) at any time.
Please be sure to fully describe the issue.

For other issues, please email rob.hammond@nrel.gov.
For other issues, please email rob.hammond@nlr.gov.

### Issue Submission Checklist

Expand All @@ -119,7 +119,7 @@ For other issues, please email rob.hammond@nrel.gov.

## Repository

The WOMBAT repository is hosted on Github, and located here: http://github.com/WISDEM/WOMBAT
The WOMBAT repository is hosted on Github, and located here: http://github.com/NLRWindSystems/WOMBAT

This repository is organized using a modified git-flow system. Branches are organized as follows:

Expand All @@ -136,8 +136,8 @@ Work out of this feature branch before submitting a pull request.
Be sure to periodically synchronize the upstream develop branch into your feature branch to avoid
conflicts in the pull request.

When your branch is ready, make a pull request to WISDEM/WOMBAT through the
[GitHub web interface](https://github.com/WISDEM/WOMBATpulls).
When your branch is ready, make a pull request to NLRWindSystems/WOMBAT through the
[GitHub web interface](https://github.com/NLRWindSystems/WOMBATpulls).

## Coding Style

Expand Down
2 changes: 1 addition & 1 deletion docs/examples/default_data_demonstration.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ kernelspec:

# Default Data Demonstration

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/WISDEM/WOMBAT/main?filepath=examples)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/NLRWindSystems/WOMBAT/main?filepath=examples)

In this example, we'll show what each of the reference plants look like and what results they yield when simulated.

Expand Down
8 changes: 4 additions & 4 deletions docs/examples/examples_reference.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Examples Reference

This page will provide a brief overview of the varying examples available in the
[examples folder on GitHub](https://github.com/WISDEM/WOMBAT/blob/main/examples).
[examples folder on GitHub](https://github.com/NLRWindSystems/WOMBAT/blob/main/examples).

## `archival/`

Expand All @@ -14,7 +14,7 @@ DOE. The results are displayed in
### `COWER_om_worflow.ipynb`

This workflow example demonstrates the new (as of v0.13) default offshore wind data sets and the
O&M portion of the NREL Cost of Wind Energy Review (COWER) analysis. The underlying data and example
O&M portion of the NLR Cost of Wind Energy Review (COWER) analysis. The underlying data and example
are kept up to date every year for this project, so the data will be updated annually (as of 2025).

## Explanations
Expand Down Expand Up @@ -66,7 +66,7 @@ to date with WOMBAT's input changes.

This example demonstrates the WOMBAT analysis portion of the 2025 doctoral dissertation by
Nadezda Avanessova [^avanessova2025], which in part focuses on a comparison of
ORE Catapult's COMPASS, WavEC's O&M Tool, and NREL's WOMBAT for offshore wind O&M. This example
ORE Catapult's COMPASS, WavEC's O&M Tool, and NLR's WOMBAT for offshore wind O&M. This example
was originally run in v0.8.1, and updated to v0.12, so some results will differ from what was published.

### `dinwoodie_validation.ipynb`
Expand All @@ -81,7 +81,7 @@ IEA, 2016 [^smart2016iea].

### `timing_benchmarks.ipynb`

This notebook is a simple benchmark for comparing run times between releases from NREL's
This notebook is a simple benchmark for comparing run times between releases from NLR's
FY22 & FY23. That said, there has been a change in computers since running this, and
the listed times for v0.7 in the notebooks will not match those in this example.

Expand Down
Loading