Science Score: 59.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 1 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
✓Committers with academic emails
3 of 14 committers (21.4%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.3%) to scientific vocabulary
Keywords from Contributors
Repository
A Reference Open Source Controller for Wind Turbines
Basic Info
- Host: GitHub
- Owner: NREL
- License: apache-2.0
- Language: Python
- Default Branch: main
- Homepage: https://rosco.readthedocs.io/en/latest/
- Size: 21.7 MB
Statistics
- Stars: 138
- Watchers: 11
- Forks: 108
- Open Issues: 11
- Releases: 33
Metadata Files
README.md
NREL's Reference OpenSource Controller (ROSCO) toolbox for wind turbine applications
NREL's Reference OpenSource Controller (ROSCO) for wind turbine applications is a toolset designed to ease controller use and implementation for the wind turbine researcher. Some primary capabilities include: * A reference controller with industry-standard functionality * 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 controller is implemented in FORTRAN, while the remainder of the toolset 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.
- linear - Scripts to aid with the use of linear models for controller tuning and simplified simulation.
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 tools for control purposes. Additionally, there is information on the standard workflow, details of the input files, use cases for the ROSCO tool-chain, and more.
Issues and Discussion
If you find issues with any of the code that resides in this repository, it is encouraged for you to open a GitHub issue. If you have general questions or comments regarding the code, please start a discussion via GitHub. We encourage you to use these resources for all ROSCO-related questions and comments, rather than other resources such as the FAST forums. This helps us keep ROSCO-related items centralized, and provides a singular place for the community to look when they have questions that might arise. Please keep in mind that we will do our very best to respond in a timely manner, but may take a few days to get back to you if you catch us during a busy time.
Contributing
If it wasn't obvious from open-source being in the title of the tool-set, this is an open-source code base that we would love for the community to contribute to. If you find yourself fixing any bugs, writing new routines, or even making small typo changes, please submit a pull request.
Survey
Please help us better understand the ROSCO user-base and how we can improve rosco through this brief survey: ROSCO toolchain survey
Referencing
To reference the ROSCO source code directly, please use the following DOI:
If the ROSCO Toolbox played a role in your research, please cite it. This software can be cited as:
NREL: ROSCO. Version 2.4.1, https://github.com/NREL/ROSCO, 2021.
For LaTeX users:
@misc{ROSCO_toolbox_2021,
author = {NREL},
title = {{ROSCO. Version 2.4.1}},
year = {2021},
publisher = {GitHub},
journal = {GitHub repository},
url = {https://github.com/NREL/ROSCO}
}
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}
}
Additional Contributors and Acknowledgments
Primary contributions to ROSCO have been provided by researchers the National Renewable Energy Laboratory and the University of Colorado Boulder. Additionally, the ROSCO controller was built upon the foundations of the Delft Research Controller. 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.
Owner
- Name: National Renewable Energy Laboratory
- Login: NREL
- Kind: organization
- Location: Golden, CO
- Website: http://www.nrel.gov
- Repositories: 599
- Profile: https://github.com/NREL
GitHub Events
Total
- Create event: 16
- Release event: 5
- Issues event: 78
- Watch event: 26
- Delete event: 16
- Issue comment event: 137
- Push event: 101
- Pull request review event: 51
- Pull request review comment event: 54
- Pull request event: 52
- Fork event: 20
Last Year
- Create event: 16
- Release event: 5
- Issues event: 78
- Watch event: 26
- Delete event: 16
- Issue comment event: 137
- Push event: 101
- Pull request review event: 51
- Pull request review comment event: 54
- Pull request event: 52
- Fork event: 20
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Nikhar Abbas | n****s@c****u | 259 |
| Sebastiaan Mulders | s****s@t****l | 79 |
| dzalkind | d****d@n****v | 64 |
| Rafael M Mudafort | r****f@g****m | 8 |
| Bartdoekemeijer | B****r@t****l | 4 |
| nikhar-abbas | n****s@g****m | 3 |
| info@sebastiaanmulders.nl | i****o@s****l | 2 |
| Gustavo Hylander | 7****r | 2 |
| jnsburke | 7****e | 1 |
| Pietro Bortolotti | p****i@g****m | 1 |
| David Heffernan | d****f@g****m | 1 |
| Abhineet Gupta | a****a@n****v | 1 |
| Sebastiaan Mulders | s****d@t****t | 1 |
| Bart Doekemeijer | b****r@h****c | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 172
- Total pull requests: 256
- Average time to close issues: about 2 months
- Average time to close pull requests: 21 days
- Total issue authors: 102
- Total pull request authors: 35
- Average comments per issue: 3.49
- Average comments per pull request: 0.74
- Merged pull requests: 200
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 47
- Pull requests: 53
- Average time to close issues: 27 days
- Average time to close pull requests: 9 days
- Issue authors: 31
- Pull request authors: 11
- Average comments per issue: 2.04
- Average comments per pull request: 0.87
- Merged pull requests: 38
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- dzalkind (13)
- ghylander (7)
- rdamiani (6)
- WANG-KUI-TJU (5)
- Fede-274 (4)
- Tomedssa (4)
- SYZ622 (4)
- Yuksel-Rudy (3)
- lqw075 (3)
- Sam-Ramsahoye (3)
- ElioDaka (3)
- abelvanweert123 (3)
- GBA217 (3)
- hugocastroo (2)
- TordMalmei (2)
Pull Request Authors
- dzalkind (120)
- nikhar-abbas (46)
- abhineet-gupta (13)
- gbarter (9)
- ptrbortolotti (7)
- rthedin (5)
- Zeffar (4)
- dstockhouse (4)
- mfekrysaidahmed (3)
- AthulKrishnaSundarrajan (3)
- aclerc (3)
- rafmudaf (3)
- jfrederik-nrel (3)
- mayankchetan (3)
- ArnoldTUB (2)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 3
-
Total downloads:
- pypi 546 last-month
-
Total dependent packages: 0
(may contain duplicates) -
Total dependent repositories: 0
(may contain duplicates) - Total versions: 44
- Total maintainers: 1
proxy.golang.org: github.com/nrel/rosco
- Documentation: https://pkg.go.dev/github.com/nrel/rosco#section-documentation
- License: apache-2.0
-
Latest release: v2.9.7+incompatible
published about 1 year ago
Rankings
conda-forge.org: rosco
NREL-developed wind turbine controller for bladed-style communications
- Homepage: https://github.com/NREL/rosco
- License: Apache-2.0
-
Latest release: 2.6.0
published over 3 years ago
Rankings
pypi.org: rosco
A reference open source controller toolset for wind turbine applications.
- Homepage: https://github.com/NREL/ROSCO
- Documentation: https://rosco.readthedocs.io
- License: Apache-2.0
-
Latest release: 2.9.5
published about 1 year ago
Rankings
Maintainers (1)
Dependencies
- actions/checkout v3 composite
- conda-incubator/setup-miniconda v2 composite
- furo *
- sphinx >4.0.0
- actions/checkout v3 composite
- actions/checkout v4 composite
- actions/download-artifact v4 composite
- actions/upload-artifact v4 composite
- awvwgk/setup-fortran v1 composite
- pypa/cibuildwheel v2.16.2 composite
- pypa/gh-action-pypi-publish release/v1 composite
- cmake
- cmake-build-extension
- compilers
- control
- make
- matplotlib
- ninja
- numpy
- pandas
- pyparsing
- pytest
- pyyaml
- pyzmq
- scipy
- sphinx_rtd_theme
- treon
- wisdem
- control *
- matplotlib *
- numpy *
- pandas *
- pyYAML *
- pyparsing *
- pyzmq *
- ruamel.yaml *
- scipy *
- treon *
- wisdem *