Skip to main content

WAVES: Wind Asset Value Estimation System

PyPI version PyPI downloads DOI Apache 2.0 image

Binder Jupyter Book Badge

Pre-commit Black isort Ruff

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.

Please visit our documentation site for API documentation, a reference guide, and examples.

Requirements

Python 3.10+

Environment Setup

Download the latest version of Miniconda for the appropriate OS. Follow the remaining steps for the appropriate OS version.

Using conda, create a new virtual environment and replace "waves" with a different environment name, if preferred:

conda create -n waves python=3.14
conda activate waves
conda install -c anaconda pip
conda config --set pip_interop_enabled true

# to deactivate
conda deactivate

Installation

Requires Python 3.10+.

For basic usage, users can install WAVES directly from PyPI, or from source for more advanced usage.

Pip

pip install waves

From Source

A source installation is great for users that want to work with the provided example, and potentially modify the code at a later point in time.

git clone https://github.com/NREL/WAVES.git
cd WAVES
pip install .

If working with the example, or running with Jupyter Notebooks, be sure to install the examples dependencies like the following:

pip install ".[examples]"

Tinkering

Use the -e for an editable installation, in case you plan on editing any underlying code.

pip install -e .

Usage

After installation, the package can imported:

python
import waves
waves.__version__

CLI

waves library-path configuration1.yaml configuration2.yaml

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

waves-0.7.1.tar.gz (66.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

waves-0.7.1-py3-none-any.whl (43.0 kB view details)

Uploaded Python 3

File details

Details for the file waves-0.7.1.tar.gz.

File metadata

  • Download URL: waves-0.7.1.tar.gz
  • Upload date:
  • Size: 66.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for waves-0.7.1.tar.gz
Algorithm Hash digest
SHA256 bd9971824495a235dd8c159a38c129a6ac3ba4ef8781049471327da67ad6edd9
MD5 0b5555c177e3e559700fc654e11b2c4c
BLAKE2b-256 bd1949f87e5fa514d892080ea7f5fd88aa2d7440d31bb32b593190f0abcdf50c

See more details on using hashes here.

Provenance

The following attestation bundles were made for waves-0.7.1.tar.gz:

Publisher: python-publish.yml on NatLabRockies/WAVES

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file waves-0.7.1-py3-none-any.whl.

File metadata

  • Download URL: waves-0.7.1-py3-none-any.whl
  • Upload date:
  • Size: 43.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for waves-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a9316c49083a99fab6871492000aac13c3c7111d53fbf987aed7d9592cb29a24
MD5 f14d56985f5d00fd04b6b1e8e6b0f998
BLAKE2b-256 1437e11d5fb228f79f612b7f0c21b776b87d03121bea337bc588cb7c97d416c5

See more details on using hashes here.

Provenance

The following attestation bundles were made for waves-0.7.1-py3-none-any.whl:

Publisher: python-publish.yml on NatLabRockies/WAVES

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.7.1 This release

2 files

0.7

2 files

0.6.2

2 files

0.6.1

2 files

0.6

2 files

0.5.3

2 files

0.5.2

2 files

0.5.1

2 files

0.5

2 files

0.0.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page