Metadata-Version: 2.4
Name: turbine-models
Version: 0.2.2
Summary: Retrieves power curves and key data for commonly used turbine models in industry and R&D community.
Author: Travis Williams
Author-email: Patrick Duffy <patrick.duffy@nlr.gov>
Maintainer-email: Patrick Duffy <patrick.duffy@nlr.gov>, Elenya Grant <elenya.grant@nlr.gov>, Rob Hammond <rob.hammond@nlr.gov>
Project-URL: source, https://github.com/NatLabRockies/turbine-models
Project-URL: documentation, https://natlabrockies.github.io/turbine-models/
Project-URL: issues, https://github.com/NatLabRockies/turbine-models/issues
Project-URL: changelog, https://github.com/NatLabRockies/turbine-models/blob/main/RELEASE.md
Keywords: python3,turbine-library,wind-turbines,power-curve,power-curves,data,wind-energy
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Python: <3.14,>=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: matplotlib
Requires-Dist: pyyaml
Requires-Dist: pyyaml-include
Provides-Extra: develop
Requires-Dist: pytest; extra == "develop"
Requires-Dist: pytest-subtests; extra == "develop"
Requires-Dist: pytest-dependency; extra == "develop"
Requires-Dist: responses; extra == "develop"
Requires-Dist: jupyter-book; extra == "develop"
Requires-Dist: sphinxcontrib-napoleon; extra == "develop"
Dynamic: license-file

# NLR Wind Turbine Power Curve Archive

[![PyPI version](https://badge.fury.io/py/turbine-models.svg)](https://badge.fury.io/py/turbine-models)
[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
[![docs - GitHub Pages](https://img.shields.io/badge/docs-GitHub_Pages-blue)](https://natlabrockies.github.io/turbine-models/)
[![DOI 10.11578/dc.20210112.1](https://img.shields.io/badge/DOI-10.11578/dc.20210112.1-brightgreen?link=https://doi.org/10.11578/dc.20210112.1)](https://doi.org/10.11578/dc.20210112.1)

## Welcome to the repository for the wind turbine power curve archive.

The intention of this repositiory is to provide power curves and key data for commonly used turbine models in industry the R&D community. 

    
## Structure
Tabular power (and thrust when available) curve data is stored in the following folders:
- Distributed Wind Turbines
- Offshore Wind Turbines
- Onshore Wind Turbines

Here you can find .csv files with the following turbine data:
1. Power curve
2. Thrust curve (when available)
3. Cp curve (when available)
4. Ct curve (when available)

## Documentation
Each turbine included in the repository is documented in detail:
https://natlabrockies.github.io/turbine-models/

The name of the turbine on the .csv file with tabular data should match up with a corresponding documentation page.

## Installing via pip

To use the turbine-models data library and helpers in your project, we now support pip installations, so projects
can be configured correctly and still use this data set.

```bash
pip install turbine-models
```

## Installing from Source
1. Using Git, navigate to a local target directory and clone repository:

    ```bash
    git clone https://github.com/NatLabRockies/turbine-models.git
    ```

2. Navigate to `turbine-models`

    ```bash
    cd turbine-models
    ```

3. Create a new virtual environment and change to it. Using Conda and naming it `turb_lib`:

    ```bash
    conda create --name turb_lib python=3.11 -y
    conda activate turb_lib
    ```

4. Install turbine-models and its dependencies:
    - for general use:

        ```bash
        pip install .
        ```

    - for general use and running examples:

        ```bash
        pip install ".[examples]"
        ```
    
    - for development dependencies and running tests. Note the `-e` flag which installs turbine-models in-place so you can edit the turbine-models package files: 
        
        ```bash
        pip install -e ".[develop]"
        ```


## Getting started
The [Examples](./examples/) contain Python scripts for common usage scenarios.
