Merge pull request #59 from NREL/develop

Version 2.3

.github/pull_request_template.md

@@ -0,0 +1,19 @@
+## Description and Purpose
+
+## Type of change
+What types of change is it?
+_Select the appropriate type(s) that describe this PR_
+
+- [ ] Bugfix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (non-backwards-compatible fix or feature)
+- [ ] Code style update (formatting, renaming)
+- [ ] Refactoring (no functional changes, no API changes)
+- [ ] Documentation update
+- [ ] Maintenance update
+- [ ] Other (please describe)
+
+## Github issues addressed, if one exists
+
+## Examples/Testing, if applicable
+

.github/workflows/CI_rosco-toolbox.yml

@@ -0,0 +1,157 @@
+name: CI_rosco-toolbox
+
+# We run CI on push commits on all branches
+on: [push, pull_request]
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  build:
+    name: Build (${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      matrix:
+        os: ["ubuntu-latest", "macOS-latest", "windows-latest"]
+        python-version: ["3.8"]
+    defaults:
+      run:
+        shell: bash -l {0}
+
+    steps:
+      - name: Checkout repository and submodules
+        uses: actions/checkout@v2
+        with:
+          submodules: recursive
+
+      - name: Setup environment
+        uses: conda-incubator/setup-miniconda@v2
+        with:
+          miniconda-version: "latest"
+          channels: conda-forge, general
+          auto-update-conda: true
+          python-version: 3.8
+          environment-file: environment.yml
+
+
+      # Install dependencies of ROSCO toolbox
+      - name: Add dependencies ubuntu specific
+        if: false == contains( matrix.os, 'windows')
+        run: |
+          conda install -y compilers
+          conda install -y wisdem
+      - name: Add dependencies windows specific
+        if: true == contains( matrix.os, 'windows')
+        run: |
+          conda install -y m2w64-toolchain libpython 
+          conda install -y wisdem
+        
+
+      # Install ROSCO toolbox
+      - name: Install ROSCO toolbox
+        run: |
+          python setup.py develop --compile-rosco
+          
+
+  run_examples:
+    name: Run Examples
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      matrix:
+        os: ["ubuntu-latest"] #, "macOS-latest"]
+        python-version: ["3.8"]
+    defaults:
+      run:
+        shell: bash -l {0}
+
+    steps:
+      - name: Checkout repository and submodules
+        uses: actions/checkout@v2
+        with:
+          submodules: recursive
+
+      - name: Setup environment
+        uses: conda-incubator/setup-miniconda@v2
+        with:
+          miniconda-version: "latest"
+          channels: conda-forge, general
+          auto-update-conda: true
+          python-version: 3.8
+          environment-file: environment.yml
+
+
+      # Install dependencies of ROSCO toolbox
+      - name: Add dependencies ubuntu specific
+        if: false == contains( matrix.os, 'windows')
+        run: |
+          conda install -y compilers
+          conda install -y wisdem
+        
+
+      # Install ROSCO toolbox
+      - name: Install ROSCO toolbox
+        run: |
+          python setup.py develop --compile-rosco
+          
+      # Install OpenFAST
+      - name: Install OpenFAST
+        run: |
+          conda install openfast==3.0.0
+          
+      # Run examples
+      - name: Run examples
+        run: |
+          cd Examples
+          python run_examples.py
+
+  run_testing:
+    name: Run Testing
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      matrix:
+        os: ["ubuntu-latest"] #, "macOS-latest"]
+        python-version: ["3.8"]
+    defaults:
+      run:
+        shell: bash -l {0}
+
+    steps:
+      - name: Checkout repository and submodules
+        uses: actions/checkout@v2
+        with:
+          submodules: recursive
+
+      - name: Setup environment
+        uses: conda-incubator/setup-miniconda@v2
+        with:
+          miniconda-version: "latest"
+          channels: conda-forge, general
+          auto-update-conda: true
+          python-version: 3.8
+          environment-file: environment.yml
+
+
+      # Install dependencies of ROSCO toolbox
+      - name: Add dependencies ubuntu specific
+        if: false == contains( matrix.os, 'windows')
+        run: |
+          conda install -y compilers
+          conda install -y wisdem
+        
+
+      # Install ROSCO toolbox
+      - name: Install ROSCO toolbox
+        run: |
+          python setup.py develop --compile-rosco
+          
+      # Install OpenFAST
+      - name: Install OpenFAST
+        run: |
+          conda install openfast==3.0.0
+
+      # Run Testing
+      - name: Run testing
+        run: |
+          cd ROSCO_testing
+          python ROSCO_testing.py

.github/workflows/publish_to_pypi.yml

@@ -0,0 +1,27 @@
+name: Upload to PyPi
+
+on:
+  release:
+    types: [released]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build and publish
+      if: startsWith(github.ref, 'refs/tags')
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+      run: |
+        python setup.py sdist bdist_wheel
+        twine upload dist/*

.gitmodules

@@ -1,4 +1,4 @@
 [submodule "ROSCO"]
 	path = ROSCO
 	url = https://github.com/NREL/ROSCO
-	branch = main
+	branch = main

Examples/example_07.py

@@ -45,11 +45,12 @@
 controller.tune_controller(turbine)
 
 # Plot minimum pitch schedule
-plt.plot(controller.v, controller.pitch_op,label='Steady State Operation')
-plt.plot(controller.v, controller.ps_min_bld_pitch, label='Minimum Pitch Schedule')
-plt.legend()
-plt.xlabel('Wind speed (m/s)')
-plt.ylabel('Blade pitch (rad)')
+fig, ax = plt.subplots(1,1)
+ax.plot(controller.v, controller.pitch_op,label='Steady State Operation')
+ax.plot(controller.v, controller.ps_min_bld_pitch, label='Minimum Pitch Schedule')
+ax.legend()
+ax.set_xlabel('Wind speed (m/s)')
+ax.set_ylabel('Blade pitch (rad)')
 
 if False:
   plt.show()

Examples/example_09.py

@@ -20,5 +20,7 @@
 wind_directory = os.path.join(this_dir,'../Test_Cases/Wind/')
 turbsim_infile = '90m_12mps_twr.inp'
 
-run_openfast(wind_directory, fastcall='turbsim', fastfile=turbsim_infile, chdir=False)
+run_openfast(wind_directory, fastcall='turbsim',
+             fastfile=os.path.join(wind_directory, turbsim_infile), chdir=False)
 
+print('test')

Examples/run_examples.py

@@ -1,5 +1,6 @@
 import os
 import unittest
+import sys
 from time import time
 import importlib
 
@@ -100,4 +101,5 @@ def suite():
 
 
 if __name__ == "__main__":
-    unittest.TextTestRunner().run(suite())
+    result = unittest.TextTestRunner().run(suite())
+    sys.exit(not result.wasSuccessful())

README.md

@@ -19,18 +19,22 @@ The NREL Reference OpenSource Controller (ROSCO) provides an open, modular and f
 ## Documentation
 All relevant documentation about the ROSCO toolbox and ROSCO controller can be found at through [ROSCO's readthedocs webpage](https://rosco-toolbox.readthedocs.io/en/latest/). Here, users can find the information on [installing the ROSCO toolbox](https://rosco-toolbox.readthedocs.io/en/latest/source/install.html#installing-the-rosco-toolbox) and [compiling ROSCO](https://rosco-toolbox.readthedocs.io/en/latest/source/install.html#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](https://forms.office.com/Pages/ResponsePage.aspx?id=fp3yoM0oVE-EQniFrufAgGWnC45k8q5Kl90RBkHijqBUN0JTNzBJT1QwMjIzNDhCWDlDTUZPWDdMWC4u)
+
 ## 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.2.0, https://github.com/NREL/rosco_toolbox, 2021.
+   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.2.0}},
+    title = {{ROSCO Toolbox. Version 2.3.0}},
     year = {2021},
     publisher = {GitHub},
     journal = {GitHub repository},
@@ -39,17 +43,15 @@ For LaTeX users:
 ```
 If the ROSCO generic tuning theory and implementation played a roll in your research, please cite the following paper
 ```
-@inproceedings{Abbas_WindTech2019,
-	doi = {10.1088/1742-6596/1452/1/012002},
-	url = {https://doi.org/10.1088%2F1742-6596%2F1452%2F1%2F012002},
-	year = 2020,
-	month = {jan},
-	publisher = {{IOP} Publishing},
-	volume = {1452},
-	pages = {012002},
-	author = {Nikhar J. Abbas and Alan Wright and Lucy Pao},
-	title = {An Update to the National Renewable Energy Laboratory Baseline Wind Turbine Controller},
-	journal = {Journal of Physics: Conference Series}
+@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](https://github.com/NREL/ROSCO) controller or [WISDEM](https://github.com/wisdem/wisdem), please cite them accordingly.