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
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
analysis.
- Fixes a bug where floating offshore substation design and installation results cause the
the code to error out when extracting substation results in ORBIT.
- Changes all references to NREL to NLR for the lab's name change from the National Renewable
Energy Laboratory to the National Laboratory of the Rockies.

## v0.7 - 12 January 2026

Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
[![image](https://img.shields.io/pypi/pyversions/waves.svg)](https://pypi.python.org/pypi/waves)


[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/NREL/WAVES/main?filepath=examples)
[![Jupyter Book](https://jupyterbook.org/badge.svg)](https://nrel.github.io/WAVES)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/NatLabRockies/WAVES/main?filepath=examples)
[![Jupyter Book](https://jupyterbook.org/badge.svg)](https://natlabrockies.github.io/WAVES)

[![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 @@ -17,9 +17,9 @@
## Overview

Runs analyses for offshore wind projects by utilizing ORBIT (CapEx), WOMBAT (OpEx), and FLORIS (AEP)
to estimate the lifecycle costs using NREL's flagship technoeconomic models.
to estimate the lifecycle costs using NatLabRockies's flagship technoeconomic models.

Please visit our [documentation site](https://nrel.github.io/WAVES/) for API documentation, a
Please visit our [documentation site](https://natlabrockies.github.io/WAVES/) for API documentation, a
reference guide, and examples.

## Requirements
Expand Down Expand Up @@ -61,7 +61,7 @@ A source installation is great for users that want to work with the provided exa
potentially modify the code at a later point in time.

```bash
git clone https://github.com/NREL/WAVES.git
git clone https://github.com/NatLabRockies/WAVES.git
cd WAVES
pip install .
```
Expand Down
10 changes: 5 additions & 5 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ bibtex_bibfiles:

# Information about where the book exists on the web
repository:
url: https://github.com/NREL/WAVES
url: https://github.com/NatLabRockies/WAVES
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 All @@ -43,7 +43,7 @@ repository:
# use_issues_button: true
# use_repository_button: true
# use_edit_page_button: true
# baseurl: http://nrel.github.io/WAVES
# baseurl: http://natlabrockies.github.io/WAVES

sphinx:
extra_extensions:
Expand All @@ -61,12 +61,12 @@ sphinx:
use_repository_button: true
use_edit_page_button: true
show_toc_level: 2
repository_url: "https://github.com/NREL/WAVES"
repository_url: "https://github.com/NatLabRockies/WAVES"
repository_branch: main
icon_links: [
{
name: GitHub,
url: "https://github.com/NREL/WAVES",
url: "https://github.com/NatLabRockies/WAVES",
icon: fa-brands fa-github,
},
{
Expand All @@ -77,7 +77,7 @@ sphinx:
},
{
name: Binder,
url: "https://mybinder.org/v2/gh/NREL/WAVES/main?filepath=examples",
url: "https://mybinder.org/v2/gh/NatLabRockies/WAVES/main?filepath=examples",
icon: "https://mybinder.org/badge_logo.svg",
type: url,
},
Expand Down
26 changes: 13 additions & 13 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
## Getting Started

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

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

## Keeping your fork in sync with NREL/WAVES
## Keeping your fork in sync with NatLabRockies/WAVES

The "main" WAVES repository is regularly updated with ongoing research at NREL and beyond. After
The "main" WAVES 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 @@ -58,14 +58,14 @@ inevitably arise in development work.
cd /your/path/to/WAVES/
```

2. If you haven't already, add NREL/WAVES as the "upstream" location (or whichever naming
2. If you haven't already, add NatLabRockies/WAVES as the "upstream" location (or whichever naming
convention you prefer).

```bash
git remote add upstream https://github.com/NREL/WAVES.git
git remote add upstream https://github.com/NatLabRockies/WAVES.git
```

To find the name you've given NREL/WAVES again, you can simply run the following to display
To find the name you've given NatLabRockies/WAVES again, you can simply run the following to display
all of the remote sources you're tracking.

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

4. Sync the upstream (NREL) changes
4. Sync the upstream (NLR) changes

```bash
# If there was a new release this will need to be updated
Expand All @@ -101,10 +101,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/NREL/WAVES/issues) at any time.
as new issues in the [Github.com issue tracker](https://github.com/NatLabRockies/WAVES/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 @@ -123,7 +123,7 @@ For other issues, please email rob.hammond@nrel.gov.

## Repository

The WAVES repository is hosted on Github, and located here: http://github.com/NREL/WAVES
The WAVES repository is hosted on Github, and located here: http://github.com/NatLabRockies/WAVES

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

Expand All @@ -138,8 +138,8 @@ To work on a feature, please fork WAVES first and then create a feature branch i
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 NREL/WAVES through the
[GitHub web interface](https://github.com/NREL/WAVES/pulls).
When your branch is ready, make a pull request to NatLabRockies/WAVES through the
[GitHub web interface](https://github.com/NatLabRockies/WAVES/pulls).

## Coding Style

Expand Down Expand Up @@ -281,5 +281,5 @@ over time, regardless of who the core developers are.
```

- Deploying a Package to PyPi
- The repository is equipped with a github action to build and publish new versions to PyPI. A maintainer can invoke this workflow by pushing a tag to the NREL/WAVES repository with prefix "v", such as "v1.2.3".
- The repository is equipped with a github action to build and publish new versions to PyPI. A maintainer can invoke this workflow by pushing a tag to the NatLabRockies/WAVES repository with prefix "v", such as "v1.2.3".
- The action is defined in `.github/workflows/tags-to-pypi.yml`.
12 changes: 6 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# WAVES Offshore Wind Techno-economic Analysis

Wind Asset Value Estimation System (WAVES) is a tool for estimating the lifecycle costs of
offshore wind projects using NREL's flagship techno economic models. WAVES is in active development
offshore wind projects using NLR's flagship techno economic models. WAVES is in active development
due to wrapping other in-development software packages for its underlying operations: ORBIT for
CapEx, WOMBAT for OpEx, and FLORIS for AEP.

Expand All @@ -13,14 +13,14 @@ the work of combining each software's configurations and results, so that users
put in the painstaking work, and can focus on what scenarios should be run--not how to run them.

At its core, WAVES is a wrapper around [ORBIT](https://wisdem.github.io/ORBIT/),
[WOMBAT](https://wisdem.github.io/WOMBAT/), and [FLORIS](https://nrel.github.io/floris/), so users
[WOMBAT](https://wisdem.github.io/WOMBAT/), and [FLORIS](https://natlabrockies.github.io/floris/), so users
are expected to know how to work with each of these models to work with WAVES.

| Model | Purpose | GitHub | Documentation |
| :---- | :------ | :----- | :------------ |
| ORBIT | CapEx | <https://github.com/WISDEM/ORBIT/> | <https://wisdem.github.io/ORBIT/> |
| WOMBAT | OpEx, Availability | <https://github.com/WISDEM/WOMBAT/> | <https://wisdem.github.io/WOMBAT/> |
| FLORIS | Energy Production | <https://github.com/NREL/FLORIS/> | <https://nrel.github.io/FLORIS/> |
| FLORIS | Energy Production | <https://github.com/NatLabRockies/FLORIS/> | <https://natlabrockies.github.io/FLORIS/> |

### Installation

Expand All @@ -35,7 +35,7 @@ For basic usage, users can install WAVES directly from PyPI, or from source for
#### From Source

```bash
git clone https://github.com/NREL/WAVES.git
git clone https://github.com/NatLabRockies/WAVES.git
cd WAVES
pip install .
```
Expand All @@ -61,8 +61,8 @@ pre-commit install

WAVES utilizes the following for coordinating development efforts

- [Issues](https://github.com/NREL/WAVES/issues): report bugs and submit feature requests
- [Pull Requests](https://github.com/NREL/WAVES/pulls): submit bug fixes, feature request,
- [Issues](https://github.com/NatLabRockies/WAVES/issues): report bugs and submit feature requests
- [Pull Requests](https://github.com/NatLabRockies/WAVES/pulls): submit bug fixes, feature request,
documentation improvements, and any other improvements

## Documentation Table of Contents
Expand Down
2 changes: 1 addition & 1 deletion docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ A source installation is great for users that want to work with the provided exa
potentially modify the code at a later point in time.

```bash
git clone https://github.com/NREL/WAVES.git
git clone https://github.com/NatLabRockies/WAVES.git
cd WAVES
pip install .
```
Expand Down
6 changes: 3 additions & 3 deletions docs/waves_example.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ kernelspec:
(example_cower)=
# Cost of Wind Energy Review: 2025 Edition

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/NREL/WAVES/main?filepath=examples)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/NatLabRockies/WAVES/main?filepath=examples)

Be sure to install `pip install "waves[examples]"` (or `pip install ".[examples]"`) to work with
this example.
Expand Down Expand Up @@ -61,8 +61,8 @@ pd.options.display.max_rows = 100

First, we need to set the library path, and then we'll load the configuration file, to show some of
the configurations. For a complete guide and definition, please see either the
[API documentation](https://nrel.github.io/WAVES/api.html) or the
[How to use WAVES guide](https://nrel.github.io/WAVES/getting_started.html#configuring).
[API documentation](https://natlabrockies.github.io/WAVES/api.html) or the
[How to use WAVES guide](https://natlabrockies.github.io/WAVES/getting_started.html#configuring).

````{warning}
If your FLORIS installation is <3.6, then the FLORIS configuration files in
Expand Down
2 changes: 1 addition & 1 deletion examples/iea49_analysis.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Script to generate results for the IEA Wind Task 49 O&M model comparison between NREL's WOMBAT
"""Script to generate results for the IEA Wind Task 49 O&M model comparison between NLR's WOMBAT
model (with WAVES supplement for additional results calculation) and TNO's UWISE model.

IMPORTANT: This analysis was originally run using the changes applied to the WOMBAT v0.12.x release
Expand Down
4 changes: 2 additions & 2 deletions examples/waves_example.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"(example_cower)=\n",
"# Cost of Wind Energy Review: 2025 Edition\n",
"\n",
"[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/NREL/WAVES/main?filepath=examples)\n",
"[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/NatLabRockies/WAVES/main?filepath=examples)\n",
"\n",
"Be sure to install `pip install \"waves[examples]\"` (or `pip install \".[examples]\"`) to work with\n",
"this example.\n",
Expand Down Expand Up @@ -129,7 +129,7 @@
"name": "stdout",
"output_type": "stream",
"text": [
"ORBIT library intialized at '/Users/rhammond/GitHub_Public/NREL/WAVES/library/base'\n",
"ORBIT library intialized at '/Users/rhammond/GitHub_Public/NatLabRockies/WAVES/library/base'\n",
"No LandBOSSE configuration provided, skipping model setup.\n",
"Fixed bottom loading time: 1.03 seconds\n",
"No LandBOSSE configuration provided, skipping model setup.\n",
Expand Down
2 changes: 1 addition & 1 deletion library/IEA_49/project/port/port_120km.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ crew:
hourly_rate: 0
n_hourly_rate: 0
n_crews: 2 # maximum number of simultaneously operating crews to repair individual failures on a turbine
annual_fee: 8100000 # https://www.nrel.gov/docs/fy22osti/83502.pdf
annual_fee: 8100000 # https://www.nlr.gov/docs/fy22osti/83502.pdf
2 changes: 1 addition & 1 deletion library/IEA_49/project/port/port_139km.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ crew:
hourly_rate: 0
n_hourly_rate: 0
n_crews: 2 # maximum number of simultaneously operating crews to repair individual failures on a turbine
annual_fee: 8100000 # https://www.nrel.gov/docs/fy22osti/83502.pdf
annual_fee: 8100000 # https://www.nlr.gov/docs/fy22osti/83502.pdf
2 changes: 1 addition & 1 deletion library/IEA_49/project/port/port_148km.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ crew:
hourly_rate: 0
n_hourly_rate: 0
n_crews: 2 # maximum number of simultaneously operating crews to repair individual failures on a turbine
annual_fee: 8100000 # https://www.nrel.gov/docs/fy22osti/83502.pdf
annual_fee: 8100000 # https://www.nlr.gov/docs/fy22osti/83502.pdf
2 changes: 1 addition & 1 deletion library/IEA_49/turbines/15MW_core_wind_floating.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
capacity_kw: 15000
capex_kw: 1300
power_curve:
file: 2020ATB_NREL_Reference_15MW_240.csv
file: 2020ATB_NLR_Reference_15MW_240.csv
bin_width: 0.5
wind_turbine:
name: Wind Turbine
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
capacity_kw: 15000
capex_kw: 1300
power_curve:
file: 2020ATB_NREL_Reference_15MW_240.csv
file: 2020ATB_NLR_Reference_15MW_240.csv
bin_width: 0.5
wind_turbine:
name: Wind Turbine
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
capacity_kw: 15000
capex_kw: 1300
power_curve:
file: 2020ATB_NREL_Reference_15MW_240.csv
file: 2020ATB_NLR_Reference_15MW_240.csv
bin_width: 0.5
wind_turbine:
name: Wind Turbine
Expand Down
2 changes: 1 addition & 1 deletion library/base/project/config/fixed_costs_osw_fixed.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ labor: 5.125 # $102.5K/year * 30 workers / Capacity (kW)
operations_management_administration: 23.5 # includes Training (fixed), Onshore logistics (fixed), Technical resource (onshore and off) (fixed) and Admin and support staff (onshore) (fixed)
operating_facilities: 1.7 #Operations control centre (fixed)
insurance: 14.3 # insurance (fixed)
annual_leases_fees: 2.72 # Calculation on the WOMBAT_cost_history.xlsx database; assumed net CF = 49%, ISO-NE NREL Cambium projected wholesale electricity prices
annual_leases_fees: 2.72 # Calculation on the WOMBAT_cost_history.xlsx database; assumed net CF = 49%, ISO-NE NLR Cambium projected wholesale electricity prices
2 changes: 1 addition & 1 deletion library/base/project/config/fixed_costs_osw_floating.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ labor: 5.125 # $102.5K/year * 30 workers / Capacity (kW)
operations_management_administration: 23.5 # includes Training (floating), Onshore logistics (floating), Technical resource (onshore and off) (floating) and Admin and support staff (onshore) (floating)
operating_facilities: 1.7 #Operations control centre (floating)
insurance: 17.9 # insurance (floating)
annual_leases_fees: 2.68 # Calculation on the WOMBAT_cost_history.xlsx database; assumed net CF = 45%, CAISO NREL Cambium projected wholesale electricity prices
annual_leases_fees: 2.68 # Calculation on the WOMBAT_cost_history.xlsx database; assumed net CF = 45%, CAISO NLR Cambium projected wholesale electricity prices
10 changes: 5 additions & 5 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
[project]
name = "WAVES"
dynamic = ["version"]
authors = [{name = "Rob Hammond", email = "rob.hammond@nrel.gov"}]
authors = [{name = "Rob Hammond", email = "rob.hammond@nlr.gov"}]
readme = "README.md"
description = "Wind Asset Value Estimation System"
requires-python = ">=3.10"
Expand Down Expand Up @@ -58,10 +58,10 @@ classifiers = [
waves = "waves.__main__:app"

[project.urls]
source = "https://github.com/NREL/WAVES"
documentation = "https://nrel.github.io/WAVES/"
issues = "https://github.com/NREL/WAVES/issues"
changelog = "https://github.com/NREL/WAVES/blob/main/CHANGELOG.md"
source = "https://github.com/NatLabRockies/WAVES"
documentation = "https://natlabrockies.github.io/WAVES/"
issues = "https://github.com/NatLabRockies/WAVES/issues"
changelog = "https://github.com/NatLabRockies/WAVES/blob/main/CHANGELOG.md"

[project.optional-dependencies]
dev = [
Expand Down
8 changes: 4 additions & 4 deletions waves/project.py
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ class Project(FromDictMixin):
The price paid per MWh of energy produced. Defaults to None.
fixed_charge_rate : float, optional
Revenue per amount of investment required to cover the investment cost, with the default
provided through the NREL 2021 Cost of Energy report [1]_. Defaults to 0.0582.
provided through the NLR 2021 Cost of Energy report [1]_. Defaults to 0.0582.
discount_rate : float, optional
The minimum acceptable rate of return, or the assumed return on an alternative
investment of comparable risk. Defaults to None.
Expand Down Expand Up @@ -1765,7 +1765,7 @@ def electrical_loss_ratio(self) -> float:
+ 0.0000000000029271 * distance_to_landfall**5
) / 100
else:
# https://www.nrel.gov/docs/fy22osti/78715.pdf Fig30
# https://www.nlr.gov/docs/fy22osti/78715.pdf Fig30
electrical_loss_ratio = 0.028

return electrical_loss_ratio
Expand All @@ -1779,7 +1779,7 @@ def loss_ratio(
electrical losses.

.. note:: This method treats different types of losses as efficiencies and is applied
as in Equation 1 from Beiter et al. 2020 (https://www.nrel.gov/docs/fy21osti/77384.pdf).
as in Equation 1 from Beiter et al. 2020 (https://www.nlr.gov/docs/fy21osti/77384.pdf).

Parameters
----------
Expand Down Expand Up @@ -2897,7 +2897,7 @@ def generate_report_lcoe_breakdown(self) -> pd.DataFrame:
def generate_report_project_details(self) -> pd.DataFrame:
"""Generates a DataFrame containing detailed project information, following the format
from the table at slide 64 in the Cost of Wind Energy Review: 2024 Edition
(https://www.nrel.gov/docs/fy25osti/91775.pdf).
(https://www.nlr.gov/docs/fy25osti/91775.pdf).

This function collects various project parameters such as turbine specifications, wind speed
data,energy capture, and efficiency metrics, and formats them into a comprehensive report.
Expand Down
Loading
Loading