Metadata-Version: 2.4
Name: turbine-csm
Version: 0.0.1
Summary: Wind Turbine Cost and Scaling Model
Author-email: Rob Hammond <rob.hammond@nlr.gov>
License: BSD 3-Clause License
        
        Copyright (c) 2026, Alliance for Sustainable Energy, LLC
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        * Redistributions of source code must retain the above copyright notice, this
          list of conditions and the following disclaimer.
        
        * Redistributions in binary form must reproduce the above copyright notice,
          this list of conditions and the following disclaimer in the documentation
          and/or other materials provided with the distribution.
        
        * Neither the name of the copyright holder nor the names of its
          contributors may be used to endorse or promote products derived from
          this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Keywords: python3,wind-energy,cost-model,wind-turbine
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Other Audience
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: attrs>=23
Requires-Dist: numpy>=1.26
Requires-Dist: pandas>=2.2
Requires-Dist: pyyaml>=6
Requires-Dist: networkx
Requires-Dist: matplotlib>=3.8
Provides-Extra: develop
Requires-Dist: pre-commit>=2.20; extra == "develop"
Requires-Dist: isort>=5.10; extra == "develop"
Requires-Dist: pytest>=9; extra == "develop"
Requires-Dist: pytest-cov>=4; extra == "develop"
Requires-Dist: pytest-check; extra == "develop"
Requires-Dist: ruff>=0.2; extra == "develop"
Requires-Dist: ty; extra == "develop"
Requires-Dist: jupyter-book<2; extra == "develop"
Requires-Dist: sphinxcontrib-napoleon; extra == "develop"
Provides-Extra: experimental
Requires-Dist: scipy>=1.11; extra == "experimental"
Requires-Dist: python-pptx>=1.0; extra == "experimental"
Dynamic: license-file

# NLR Wind Turbine Cost and Scaling Model (CSM)

[![PyPI version](https://badge.fury.io/py/turbine-csm.svg)](https://badge.fury.io/py/turbine-csm)
![CI Tests](https://github.com/NLRWindSystems/CSM/actions/workflows/ci.yml/badge.svg)
[![Supported Python](https://img.shields.io/pypi/pyversions/turbine-csm.svg)](https://pypi.python.org/pypi/turbine-csm)
[![Jupyter Book Badge](https://raw.githubusercontent.com/jupyter-book/jupyter-book/next/docs/media/images/badge.svg)](https://nlrwindsystems.github.io/CSM)
[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)

[![Pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)

The purpose of the cost and scaling model is to approximate the relationships between
the size and cost of various major wind turbine components. These relationships can be
used to approximate the impact that changes in design or technology might have on the
turbine as a whole.

For example, putting in a larger blade should increase the energy generation from the
turbine. However, doing so may also require a larger gearbox, rotor, etc. and it may be
the case that the increased cost of these larger components outweighs the benefit of the
larger blade.

## Citing CSM

Zenodo Coming Soon.

## Installation

```bash
pip install turbine-csm
```

For details about installing from source or working with environments, please see the
[Installation Guide](https://nlrwindsystems.github.io/CSM/intro/install) on the documentation site.

## Available Models

At a glance the following models have been validated and documented, and are ready for public use.

For complete details on each of the models, please see visit the
[API documentation](https://nlrwindsystems.github.io/CSM/api/models), and for general details on
working with the model, please visit the
[User Guide](https://nlrwindsystems.github.io/CSM/intro/demo).

[](https://nlrwindsystems.github.io/CSM/)

### `Land2015NLR`

A replication of the WISDEM-based CSM model, which is an updated version of the original 2006
Excel-based implementation. For more details on these implementations, please see the
[theory behind the model](https://nlrwindsystems.github.io/CSM/user_guide/theory) on
the documentation site.

### `Land2020NLR`

A more holistically updated variant of the 2015 model with some new scaling relationships and
updated default variables. The 2020 model also removes the high speed shaft and adds a
transportation cost model.

### `Land2021NLR`

A further refined variant of the 2020 model.

### `Land2026NLR`

Coming soon.

### Offshore Models

Coming soon.
