Skip to main content

Wind Asset Value Estimation System

Project description

WAVES: Wind Asset Value Estimation System

PyPI version PyPI downloads Apache 2.0 image

Binder Jupyter Book

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

Project details


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.tar.gz (43.2 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-py3-none-any.whl (42.8 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: waves-0.7.tar.gz
  • Upload date:
  • Size: 43.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for waves-0.7.tar.gz
Algorithm Hash digest
SHA256 8599793fb6f1e39c1d02d3fe492af54f85e4f843ef5b40496e5ee3801d57613b
MD5 35941e85fc4697ad3617dd3740f57ace
BLAKE2b-256 391bfcfde0c544ea69b4c51f2f38a0994a7a9d504a56dd835071d382f0a226cf

See more details on using hashes here.

Provenance

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

Publisher: python-publish.yml on NREL/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-py3-none-any.whl.

File metadata

  • Download URL: waves-0.7-py3-none-any.whl
  • Upload date:
  • Size: 42.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for waves-0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 c68c6b165117ae18bc88f75ad5ad8ece0875200c5b3a00f78af0394757fc42fc
MD5 6e7376235ca10f6f0c23c86a13dbffcf
BLAKE2b-256 70ad2e383c9c3fcb4f27762e682ca68181c81e8e87092c33b9ddf4b28e6939c2

See more details on using hashes here.

Provenance

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

Publisher: python-publish.yml on NREL/WAVES

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

Supported by

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