openfast_toolbox

Python package to work with NREL-supported OpenFAST tool. This repository intends to provide simple scripts to help OpenFAST users setup models, run simulations and postprocess the results.

Installation and testing

git clone http://github.com/OpenFAST/openfast_toolbox
cd openfast_toolbox
python -m pip install -e .
pytest

Subpackages

The repository contains a set of small packages:

input_output: read/write OpenFAST/FAST.Farm/OLAF input and output files (see README)
postpro: postprocess OpenFAST outputs (extract radial data, compute fatigue loads) (see examples)
linearization: tools to deal with OpenFAST linearization, e.g. generate a Campbell diagram (see 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)

QuickStart and main usage

Read and write files

Find examples scripts in this folder and the different fileformats here.

Read an AeroDyn file (or any OpenFAST input file), modifies some values and write the modified file:

from openfast_toolbox.io import FASTInputFile
filename = 'AeroDyn.dat'
f = FASTInputFile(filename)
f['TwrAero'] = True
f['AirDens'] = 1.225
f.write('AeroDyn_Changed.dat')

Read an OpenFAST binary output file and convert it to a pandas DataFrame

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

from openfast_toolbox.io import TurbSimFile
ts = TurbSimFile('Turb.bts')
print(ts.keys())
print(ts['u'].shape)  
ts['u'][0,:,:,:] += 1 # Adding 1 m/s in the streamwise
tw.write('NewTurbulenceBox.bts')

Polar/airfoil manipulation

Find examples scripts in this folder.

Read a CSV file with alpha, Cl, Cd, Cm, and write it to AeroDyn format (also computes unsteady coefficients)

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.

Postprocessing

Below are different scripts to manipulate OpenFAST outputs:

Future work and friend projects

This repository intends to provide simple scripts to help users of OpenFAST. The repo is still in its early phase, so you may find that functionalities are missing or not bullet proof. Your contributions would be much appreciated, feel free to post issues and pull-requests. We will thrive to provide tests and examples.

In the meantime, you can also find relevant python scripts in the following repositories:

WISDEM: models for assessing overall wind plant cost of energy (COE), also contains file IO, (DLC) case generation, polar manipulations, visualization, and much more!
weio : reader and writer for typical files used by the wind energy community
welib: misc tools for wind energy applications (BEM, FEM, polars, ...)
ROSCO_toolbox: tools to work with the ROSCO controller that is supported by OpenFAST
windtools: toolsfor wind simulation setup, data processing and analysis
pyDatView: cross-platform visualization and processing program for input and output files

Matlab script are found in the matlab-toolbox.

Open-source OpenFAST wind turbine models can be found here:

openfast-turbine-models: open source wind turbine models (in development)
r-test: regression tests for OpenFAST, contains models for OpenFAST and its drivers (AeroDyn, SubDyn, HydroDyn, etc.). This repository is not intended to be used as a "database" of models, but it has the advantage that the input files are alwasy up to date with the latest format specifications

General documentation for OpenFAST is found on its readthedocs page.

Contributing

This repository is still work in progress, thank you for your understanding. Any contribution is much appreciated, feel free to post issues or pull-requests.

OpenFAST / openfast_toolbox

readme