Skip to main content

A toolbox for development of wind turbine controllers.

Project description

NREL's Reference OpenSource Controller (ROSCO) toolbox for wind turbine applications

NREL's Reference OpenSource Controller (ROSCO) toolbox for wind turbine applications is a toolbox designed to ease controller implementation for the wind turbine researcher. Some primary capabilities include:

  • Generic tuning of NREL's ROSCO controller
  • Simple 1-DOF turbine simulations for quick controller capability verifications
  • Parsing of OpenFAST input and output files

Introduction

The NREL Reference OpenSource Controller (ROSCO) provides an open, modular and fully adaptable baseline wind turbine controller to the scientific community. The ROSCO toolbox leverages this architecture and implementation to provide a generic tuning process for the controller. Because of the open character and modular set-up, scientists are able to collaborate and contribute in making continuous improvements to the code for the controller and the toolbox. The ROSCO toolbox is a mostly-python code base with a number of functionalities.

  • ROSCO - the fortran source code for the ROSCO controller.
  • Examples - short working examples of the capabilities of the ROSCO toolbox.
  • Tune_Cases - example generic tuning scripts for a number of open-source reference turbines.
  • Test_Cases - numerous NREL 5MW bases cases to run for controller updates and comparisons. A "test-suite", if you will...
  • Matlab_Toolbox - MATLAB scripts to parse and plot simulation output data.
  • ofTools - A number of scripts to facilitate usage of OpenFAST and manage OpenFAST input and output files.

Documentation

All relevant documentation about the ROSCO toolbox and ROSCO controller can be found at through ROSCO's readthedocs webpage. Here, users can find the information on installing the ROSCO toolbox and compiling ROSCO for control purposes. Additionally, there is information on the standard workflow and uses cases for the ROSCO toolchain, and more.

Survey

Please help us better understand the ROSCO user-base and how we can improve rosco through this brief survey: ROSCO toolchain survey

Referencing

If the ROSCO Toolbox played a role in your research, please cite it. This software can be cited as:

NREL: ROSCO Toolbox. Version 2.3.0, https://github.com/NREL/rosco_toolbox, 2021.

For LaTeX users:

@misc{ROSCO_toolbox_2021,
    author = {NREL},
    title = {{ROSCO Toolbox. Version 2.3.0}},
    year = {2021},
    publisher = {GitHub},
    journal = {GitHub repository},
    url = {https://github.com/NREL/rosco_toolbox}
    }

If the ROSCO generic tuning theory and implementation played a roll in your research, please cite the following paper

@Article{wes-2021-19,
AUTHOR = {Abbas, N. and Zalkind, D. and Pao, L. and Wright, A.},
TITLE = {A Reference Open-Source Controller for Fixed and Floating Offshore Wind Turbines},
JOURNAL = {Wind Energy Science Discussions},
VOLUME = {2021},
YEAR = {2021},
PAGES = {1--33},
URL = {https://wes.copernicus.org/preprints/wes-2021-19/},
DOI = {10.5194/wes-2021-19}
}

Additionally, if you have extensively used the ROSCO controller or WISDEM, please cite them accordingly.

Additional Contributors and Acknowledgments

Primary contributions to the ROSCO Toolbox have been provided by researchers the National Renewable Energy Laboratory (Nikhar J. Abbas, Daniel Zalkind, Alan Wright, and Paul Fleming) and the University of Colorado Boulder (Lucy Pao). Much of the intellect behind these contributions has been inspired or derived from an extensive amount of work in the literature. The bulk of this has been cited through the primary publications about this work.

There have been a number of contributors to the logic of the ROSCO controller itself. Please see the ROSCO github page for more information on who these contributors have been.

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

rosco-toolbox-2.3.0.tar.gz (211.9 kB view details)

Uploaded Source

Built Distribution

rosco_toolbox-2.3.0-py2.py3-none-any.whl (223.6 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file rosco-toolbox-2.3.0.tar.gz.

File metadata

  • Download URL: rosco-toolbox-2.3.0.tar.gz
  • Upload date:
  • Size: 211.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.8.10

File hashes

Hashes for rosco-toolbox-2.3.0.tar.gz
Algorithm Hash digest
SHA256 8830a2c764c45fff2702dbf776fabf21a37bfdd236156a36c9d3977350c2c40a
MD5 4e2423b1917987b346a3ee34cb506760
BLAKE2b-256 215c74f9a5ac423bc6a857f4dd5d2f9313b77966e99e2ecf5875d623b42c2ffb

See more details on using hashes here.

File details

Details for the file rosco_toolbox-2.3.0-py2.py3-none-any.whl.

File metadata

  • Download URL: rosco_toolbox-2.3.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 223.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.8.10

File hashes

Hashes for rosco_toolbox-2.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d4a0023999abda2f308209cc53371012b0a39859fd75a251c0c5560887c2c3db
MD5 1095891682b293db45dccb31c483d505
BLAKE2b-256 32e4fbbe25703b8fe89657e31692d1466d24c5a0040b0c670ac3d8b9d4b25e1d

See more details on using hashes here.

Supported by

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