OpenOA 2.0.1

This library provides a framework for working with large timeseries data from wind plants, such as SCADA. Its development has been motivated by the WP3 Benchmarking (PRUF) project, which aims to provide a reference implementation for plant-level performance assessment.

Analysis routines are grouped by purpose into methods, and these methods in turn rely on more abstract toolkits. In addition to the provided analysis methods, anyone can write their own, which is intended to provide natural growth of tools within this framework.

The library is written around Pandas Data Frames, utilizing a flexible backend so that data loading, processing, and analysis could be performed using other libraries, such as Dask and Spark, in the future.

Requirements

• Python 3.6+ with pip.

We strongly recommend using the Anaconda Python distribution and creating a new conda environment for OpenOA. You can download Anaconda through their website.

After installing Anaconda, create and activate a new conda environment with the name "openoa-env":

conda create --name openoa-env python=3
conda activate openoa-env

Installation:

Clone the repository and install the library and its dependencies using pip:

git clone https://github.com/NREL/OpenOA.git
pip install ./OpenOA

You should now be able to import operational_analysis from the Python interpreter:

python
>>> import operational_analysis

Development

Development dependencies are provided in a requirements.txt file.

We recommend utilizing a fresh virtual environment or Anaconda root before installing these requirements. To use requirements.txt:

pip install -r ./OpenOA/requirements.txt

Next, we recommend installing OpenOA in editable mode:

pip install -e ./OpenOA

Extracting Example Data

The example data will be automaticaly extracted as needed by the tests. The following command is provided for reference:

unzip examples/data/la_haute_borne.zip -d examples/data/la_haute_borne/

Testing

Tests are written in the Python unittest framework and are runnable using pytest. To run all tests with code coverage reporting:

pytest --cov=operational_analysis

To run unit tests only:

pytest --ignore=test/regression/ --cov=operational_analysis

Documentation

Documentation is automatically built by, and visible through, Read The Docs.

You can build the documentation with sphinx, but will need to ensure Pandoc is installed on your computer first:

cd sphinx
pip install -r requirements.txt
make html

Contributors

Alphabetically: Nathan Agarwal, Nicola Bodini, Anna Craig, Jason Fields, Rob Hammond, Travis Kemper, Joseph Lee, Monte Lunacek, John Meissner, Mike Optis, Jordan Perr-Sauer, Sebastian Pfaffel, Caleb Phillips, Eliot Quon, Sheungwen Sheng, Eric Simley, and Lindy Williams.