Merging dev to main after renaming of python_toolbox to openfast_toolbox (#1)

* AeroAcoustics: reorganizing folder

* Fix collections.Iterable being deprecated

* GH: testing for python version 3.12

* Lin: not using distutils (deprecated python 3.12)

* GH: using unittest instead of pytest

* GH: adding windows and mac for github action

* Renaming pyFAST to openfast_toolbox

* Changed io paths in README

* Removing gitignore of out files for examples

* Rename of repo in readme

* Readding aeroacoustic examples

Author: ebranlard

.github/workflows/development-pipeline.yml

@@ -11,13 +11,47 @@ on:
 # strategy:
 #   matrix:
 #     os: [macOS-10.14, ubuntu-18.04]
+#     runs-on: ubuntu-latest
+#     strategy:
+#       matrix:
+#         python-version: [3.7, 3.8, 3.9, 3.11, 3.12]  # 
 
 jobs:
   build-and-test:
-    runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.7, 3.8, 3.9, 3.11]  # 
+        include:
+          - os: ubuntu-latest
+            python-version: 3.7
+            python: xvfb-run python3
+            pip_arg: ""
+          - os: ubuntu-latest
+            python-version: 3.8
+            python: xvfb-run python3
+            pip_arg: ""
+          - os: ubuntu-latest
+            python-version: 3.9
+            python: xvfb-run python3
+            pip_arg: ""
+          - os: ubuntu-latest
+            python-version: 3.11
+            python: xvfb-run python3
+            pip_arg: ""
+          - os: ubuntu-latest
+            python-version: 3.12
+            python: xvfb-run python3
+            pip_arg: ""
+          - os: macos-11
+            python-version: 3.11
+            python: python3
+            pip_arg: ""
+          - os: windows-2019
+            python-version: 3.11
+            python: python
+            pip_arg: --user
+    runs-on: ${{ matrix.os }}
+
+
     steps:
       - name: Checkout
         uses: actions/checkout@main
@@ -30,10 +64,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-          pip install pytest
-          pip install pytest-cov
           pip install -e .
-      - name: Test with pytest
+      - name: Tests
         run: |
-          pytest
+          python -m unittest discover

Makefile

@@ -0,0 +1,4 @@
+
+
+test:
+	python -m unittest discover

README.md

@@ -1,4 +1,4 @@
-# pyfast
+# openfast_toolbox
 
 [![Build status](https://github.com/openfast/python-toolbox/workflows/Development%20Pipeline/badge.svg)](https://github.com/OpenFAST/python-toolbox/actions?query=workflow%3A%22Development+Pipeline%22)
 [![Python: 3.6+](https://img.shields.io/badge/python-3.6%2B-informational)](https://www.python.org/)
@@ -22,21 +22,21 @@ pytest
 
 The repository contains a set of small packages:
 
-- input\_output: read/write OpenFAST/FAST.Farm/OLAF input and output files (see [README](pyFAST/input_output)) 
-- postpro: postprocess OpenFAST outputs (extract radial data, compute fatigue loads) (see [examples](pyFAST/postpro/examples))
-- linearization: tools to deal with OpenFAST linearization, e.g. generate a Campbell diagram (see [examples](pyFAST/linearization/examples/))
+- input\_output: read/write OpenFAST/FAST.Farm/OLAF input and output files (see [README](openfast_toolbox/io)) 
+- postpro: postprocess OpenFAST outputs (extract radial data, compute fatigue loads) (see [examples](openfast_toolbox/postpro/examples))
+- linearization: tools to deal with OpenFAST linearization, e.g. generate a Campbell diagram (see [examples](openfast_toolbox/linearization/examples/))
 - aeroacoustics: tools for aeroacoustics (generate BL files and plot outputs)
-- case\_generation: tools to generate and run a set of input of OpenFAST input files (see [examples](pyFAST/case_generation/examples))
+- case\_generation: tools to generate and run a set of input of OpenFAST input files (see [examples](openfast_toolbox/case_generation/examples))
 
 
 ## QuickStart and main usage
 
 ### Read and write files
-Find examples scripts in this [folder](pyFAST/input_output/examples) and the different fileformats [here](pyFAST/input_output). 
+Find examples scripts in this [folder](openfast_toolbox/io/examples) and the different fileformats [here](openfast_toolbox/io). 
 
 Read an AeroDyn file (or any OpenFAST input file), modifies some values and write the modified file:
 ```python
-from pyFAST.input_output import FASTInputFile
+from openfast_toolbox.io import FASTInputFile
 filename = 'AeroDyn.dat'
 f = FASTInputFile(filename)
 f['TwrAero'] = True
@@ -46,15 +46,15 @@ f.write('AeroDyn_Changed.dat')
 
 Read an OpenFAST binary output file and convert it to a pandas DataFrame
 ```python
-from pyFAST.input_output import FASTOutputFile
+from openfast_toolbox.io import FASTOutputFile
 df = FASTOutputFile('5MW.outb').toDataFrame()
 time  = df['Time_[s]']
 Omega = df['RotSpeed_[rpm]']
 ```
 
 Read a TurbSim binary file, modify it and write it back
 ```python 
-from pyFAST.input_output import TurbSimFile
+from openfast_toolbox.io import TurbSimFile
 ts = TurbSimFile('Turb.bts')
 print(ts.keys())
 print(ts['u'].shape)  
@@ -63,27 +63,27 @@ tw.write('NewTurbulenceBox.bts')
 ```
 
 ### Polar/airfoil manipulation
-Find examples scripts in this [folder](pyFAST/polar/examples).
+Find examples scripts in this [folder](openfast_toolbox/polar/examples).
 
 
 Read a CSV file with `alpha, Cl, Cd, Cm`, and write it to AeroDyn format (also computes unsteady coefficients)
 ```python 
-from pyFAST.airfoils.Polar import Polar
-polar = Polar('pyFAST/airfoils/data/DU21_A17.csv', fformat='delimited')
+from openfast_toolbox.airfoils.Polar import Polar
+polar = Polar('openfast_toolbox/airfoils/data/DU21_A17.csv', fformat='delimited')
 ADpol = polar.toAeroDyn('AeroDyn_Polar_DU21_A17.dat')
 ```
 
 ### Write a set of OpenFAST input file for multiple simulations
-Find examples scripts in this [folder](pyFAST/case_generation/examples).
+Find examples scripts in this [folder](openfast_toolbox/case_generation/examples).
 
 ### Postprocessing
 
 Below are different scripts to manipulate OpenFAST outputs:
 
-- [Extract average radial data](pyFAST/postpro/examples/Example_RadialPostPro.py).
-- [Interpolate data at different radial positions](pyFAST/postpro/examples/Example_RadialInterp.py).
-- [Compute damage equivalent loads](pyFAST/postpro/examples/Example_EquivalentLoad.py).
-- [Change column names and units](pyFAST/postpro/examples/Example_Remap.py).
+- [Extract average radial data](openfast_toolbox/postpro/examples/Example_RadialPostPro.py).
+- [Interpolate data at different radial positions](openfast_toolbox/postpro/examples/Example_RadialInterp.py).
+- [Compute damage equivalent loads](openfast_toolbox/postpro/examples/Example_EquivalentLoad.py).
+- [Change column names and units](openfast_toolbox/postpro/examples/Example_Remap.py).
 
 
 ## Future work and friend projects

data/NREL5MW/5MW_Land_Lin_Rotating/postpro_MultiLinFiles_OneOP.py

@@ -2,14 +2,14 @@
 Script to postprocess linearization files from OpenFAST for one operating point.
 
 Adapted from:
-     https://github.com/OpenFAST/python-toolbox/blob/dev/pyFAST/linearization/examples/ex2a_MultiLinFiles_OneOP.py
+     https://github.com/OpenFAST/python-toolbox/blob/dev/openfast_toolbox/linearization/examples/ex2a_MultiLinFiles_OneOP.py
 
 """
 import os
 import glob
 import numpy as np
-import pyFAST
-import pyFAST.linearization as lin
+import openfast_toolbox
+import openfast_toolbox.linearization as lin
 
 ## Script Parameters
 fstFile = './Main.fst' # Main .fst file, .lin files will be sought for with same basename

data/linearization_outputs/README.md

@@ -1,5 +1,5 @@
 The outputs in this directory should match the ones given by the example script:
-     pyFAST/linearization/runCampbell.
+     openfast_toolbox/linearization/runCampbell.
 
 Using the 5MW Land turbine, at given operating points.
 

developper_notes.md

@@ -0,0 +1,76 @@
+# Developer Notes 
+
+
+
+## Release Steps
+Typically releases are done for each new version of OpenFAST
+
+1. Create a pull request from main to dev
+2. Make sure the input files in the `data` directory are compatible with the new OpenFAST version
+3. Change the file VERSION  (and/or setup.py) and push to the pull request
+4. Merge pull request to main
+5. Tag the commit using `git tag -a vX.X.X` and push to remote: `git push --tags``.
+6. Upload to pypi and conda (see below)
+7. Merge main to dev
+
+
+## Upload a new version for pip
+Detailled steps are provided further below.
+
+### Summary 
+Remember to change VERSION file and/or setup.py 
+```bash
+python setup.py sdist
+twine upload dist/*     # upload to pypi
+```
+
+
+
+### (Step 0 : create an account on pypi)
+
+### Step 1: go to your repo
+Go to folder
+```bash
+cd path/to/python-toolbox
+```
+
+### Step 2: change version in setup.py and tag it
+change VERSION in setup.py 
+```
+git add setup.py VERSION
+git commit "Version X.X.X"
+git tag -a 
+```
+
+### Step 3: Create a source distribution
+```bash
+python setup.py sdist
+```
+
+### Step 4: Install twine
+```bash
+pip install twine
+```
+
+### Step 5: Ubplot to pypi
+Run twine to upload to Pypi (will ask for username and password)
+```bash
+twine upload dist/*
+```
+
+### After clone / first time
+Add `.gitconfig` to your path, to apply filters on jupyter notebooks
+```bash
+git config --local include.path ../.gitconfig
+```
+
+
+
+## Upload a new version to Conda 
+TODO TODO TODO
+
+conda-forge, 
+make a pull request there.
+ - setup build script (https://conda-forge.org/docs/maintainer/adding_pkgs.html). 
+    see e.g. FLORIS (https://github.com/conda-forge/floris-feedstock/blob/master/recipe/meta.yaml).
+ - make a pull request to https://github.com/conda-forge/staged-recipes/ 

openfast_toolbox/__init__.py

@@ -0,0 +1,14 @@
+"""Initialize everything"""
+import os
+from openfast_toolbox.common import *
+# Make main io tools available
+from .io import read
+from .io.fast_input_file import FASTInputFile
+from .io.fast_output_file import FASTOutputFile
+from .io.fast_input_deck import FASTInputDeck
+
+# Add version to package
+with open(os.path.join(os.path.dirname(__file__), "..", "VERSION")) as fid:
+    __version__ = fid.read().strip()
+
+

openfast_toolbox/aeroacoustics/__init__.py

@@ -0,0 +1 @@
+from .aa_tools import *

pyFAST/airfoils/tests/__init__.py renamed to openfast_toolbox/aeroacoustics/aa_tools.py

@@ -0,0 +1,3 @@
+Examples provided in this directory need to be adapted to specific use cases.
+
+Examples starting with an underscore `(_*.py)` are currently not expected to be "runable" out of the box.