Skip to content

Commit e27e083

Browse files
authored
Docs: Update lab naming from NREL to NLR (#36)
* update for lab name change from NREL to NLR * update changelog
1 parent c4a03c8 commit e27e083

21 files changed

Lines changed: 57 additions & 55 deletions

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
analysis.
1212
- Fixes a bug where floating offshore substation design and installation results cause the
1313
the code to error out when extracting substation results in ORBIT.
14+
- Changes all references to NREL to NLR for the lab's name change from the National Renewable
15+
Energy Laboratory to the National Laboratory of the Rockies.
1416

1517
## v0.7 - 12 January 2026
1618

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
[![image](https://img.shields.io/pypi/pyversions/waves.svg)](https://pypi.python.org/pypi/waves)
77

88

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

1212
[![Pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
1313
[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
@@ -17,9 +17,9 @@
1717
## Overview
1818

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

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

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

6363
```bash
64-
git clone https://github.com/NREL/WAVES.git
64+
git clone https://github.com/NatLabRockies/WAVES.git
6565
cd WAVES
6666
pip install .
6767
```

docs/_config.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ bibtex_bibfiles:
3232

3333
# Information about where the book exists on the web
3434
repository:
35-
url: https://github.com/NREL/WAVES
35+
url: https://github.com/NatLabRockies/WAVES
3636
path_to_book: docs # Optional path to your book, relative to the repository root
3737
branch: main # Which branch of the repository should be used when creating links (optional)
3838

@@ -43,7 +43,7 @@ repository:
4343
# use_issues_button: true
4444
# use_repository_button: true
4545
# use_edit_page_button: true
46-
# baseurl: http://nrel.github.io/WAVES
46+
# baseurl: http://natlabrockies.github.io/WAVES
4747

4848
sphinx:
4949
extra_extensions:
@@ -61,12 +61,12 @@ sphinx:
6161
use_repository_button: true
6262
use_edit_page_button: true
6363
show_toc_level: 2
64-
repository_url: "https://github.com/NREL/WAVES"
64+
repository_url: "https://github.com/NatLabRockies/WAVES"
6565
repository_branch: main
6666
icon_links: [
6767
{
6868
name: GitHub,
69-
url: "https://github.com/NREL/WAVES",
69+
url: "https://github.com/NatLabRockies/WAVES",
7070
icon: fa-brands fa-github,
7171
},
7272
{
@@ -77,7 +77,7 @@ sphinx:
7777
},
7878
{
7979
name: Binder,
80-
url: "https://mybinder.org/v2/gh/NREL/WAVES/main?filepath=examples",
80+
url: "https://mybinder.org/v2/gh/NatLabRockies/WAVES/main?filepath=examples",
8181
icon: "https://mybinder.org/badge_logo.svg",
8282
type: url,
8383
},

docs/contributing.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
## Getting Started
1010

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

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

44-
## Keeping your fork in sync with NREL/WAVES
44+
## Keeping your fork in sync with NatLabRockies/WAVES
4545

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

@@ -58,14 +58,14 @@ inevitably arise in development work.
5858
cd /your/path/to/WAVES/
5959
```
6060
61-
2. If you haven't already, add NREL/WAVES as the "upstream" location (or whichever naming
61+
2. If you haven't already, add NatLabRockies/WAVES as the "upstream" location (or whichever naming
6262
convention you prefer).
6363

6464
```bash
65-
git remote add upstream https://github.com/NREL/WAVES.git
65+
git remote add upstream https://github.com/NatLabRockies/WAVES.git
6666
```
6767

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

7171
```bash
@@ -78,7 +78,7 @@ inevitably arise in development work.
7878
git fetch --all
7979
```
8080

81-
4. Sync the upstream (NREL) changes
81+
4. Sync the upstream (NLR) changes
8282

8383
```bash
8484
# If there was a new release this will need to be updated
@@ -101,10 +101,10 @@ inevitably arise in development work.
101101
## Issue Tracking
102102

103103
New feature requests, changes, enhancements, non-methodology features, and bug reports can be filed
104-
as new issues in the [Github.com issue tracker](https://github.com/NREL/WAVES/issues) at any time.
104+
as new issues in the [Github.com issue tracker](https://github.com/NatLabRockies/WAVES/issues) at any time.
105105
Please be sure to fully describe the issue.
106106

107-
For other issues, please email rob.hammond@nrel.gov.
107+
For other issues, please email rob.hammond@nlr.gov.
108108

109109
### Issue Submission Checklist
110110

@@ -123,7 +123,7 @@ For other issues, please email rob.hammond@nrel.gov.
123123
124124
## Repository
125125
126-
The WAVES repository is hosted on Github, and located here: http://github.com/NREL/WAVES
126+
The WAVES repository is hosted on Github, and located here: http://github.com/NatLabRockies/WAVES
127127
128128
This repository is organized using a modified git-flow system. Branches are organized as follows:
129129
@@ -138,8 +138,8 @@ To work on a feature, please fork WAVES first and then create a feature branch i
138138
Work out of this feature branch before submitting a pull request.
139139
Be sure to periodically synchronize the upstream develop branch into your feature branch to avoid conflicts in the pull request.
140140
141-
When your branch is ready, make a pull request to NREL/WAVES through the
142-
[GitHub web interface](https://github.com/NREL/WAVES/pulls).
141+
When your branch is ready, make a pull request to NatLabRockies/WAVES through the
142+
[GitHub web interface](https://github.com/NatLabRockies/WAVES/pulls).
143143
144144
## Coding Style
145145
@@ -281,5 +281,5 @@ over time, regardless of who the core developers are.
281281
```
282282
283283
- Deploying a Package to PyPi
284-
- 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".
284+
- 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".
285285
- The action is defined in `.github/workflows/tags-to-pypi.yml`.

docs/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# WAVES Offshore Wind Techno-economic Analysis
22

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

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

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

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

2525
### Installation
2626

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

3737
```bash
38-
git clone https://github.com/NREL/WAVES.git
38+
git clone https://github.com/NatLabRockies/WAVES.git
3939
cd WAVES
4040
pip install .
4141
```
@@ -61,8 +61,8 @@ pre-commit install
6161

6262
WAVES utilizes the following for coordinating development efforts
6363

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

6868
## Documentation Table of Contents

docs/install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ A source installation is great for users that want to work with the provided exa
2121
potentially modify the code at a later point in time.
2222

2323
```bash
24-
git clone https://github.com/NREL/WAVES.git
24+
git clone https://github.com/NatLabRockies/WAVES.git
2525
cd WAVES
2626
pip install .
2727
```

docs/waves_example.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ kernelspec:
1212
(example_cower)=
1313
# Cost of Wind Energy Review: 2025 Edition
1414

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

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

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

6767
````{warning}
6868
If your FLORIS installation is <3.6, then the FLORIS configuration files in

examples/iea49_analysis.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""Script to generate results for the IEA Wind Task 49 O&M model comparison between NREL's WOMBAT
1+
"""Script to generate results for the IEA Wind Task 49 O&M model comparison between NLR's WOMBAT
22
model (with WAVES supplement for additional results calculation) and TNO's UWISE model.
33
44
IMPORTANT: This analysis was originally run using the changes applied to the WOMBAT v0.12.x release

examples/waves_example.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"(example_cower)=\n",
99
"# Cost of Wind Energy Review: 2025 Edition\n",
1010
"\n",
11-
"[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/NREL/WAVES/main?filepath=examples)\n",
11+
"[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/NatLabRockies/WAVES/main?filepath=examples)\n",
1212
"\n",
1313
"Be sure to install `pip install \"waves[examples]\"` (or `pip install \".[examples]\"`) to work with\n",
1414
"this example.\n",
@@ -129,7 +129,7 @@
129129
"name": "stdout",
130130
"output_type": "stream",
131131
"text": [
132-
"ORBIT library intialized at '/Users/rhammond/GitHub_Public/NREL/WAVES/library/base'\n",
132+
"ORBIT library intialized at '/Users/rhammond/GitHub_Public/NatLabRockies/WAVES/library/base'\n",
133133
"No LandBOSSE configuration provided, skipping model setup.\n",
134134
"Fixed bottom loading time: 1.03 seconds\n",
135135
"No LandBOSSE configuration provided, skipping model setup.\n",

library/IEA_49/project/port/port_120km.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ crew:
1010
hourly_rate: 0
1111
n_hourly_rate: 0
1212
n_crews: 2 # maximum number of simultaneously operating crews to repair individual failures on a turbine
13-
annual_fee: 8100000 # https://www.nrel.gov/docs/fy22osti/83502.pdf
13+
annual_fee: 8100000 # https://www.nlr.gov/docs/fy22osti/83502.pdf

0 commit comments

Comments
 (0)