This library provides a framework for assessing wind plant performance using operational assessment (OA) methodologies that consume time series data from wind plants. The goal of the project is to provide an open source implementation of common data structures, analysis methods, and utility functions relevant to wind plant OA.
This a draft for an ongoing PR to overhaul the documentation site build for Read the Docs. The main changes are as follows:
Using the Pydata Sphinx Theme and updating sphinx/conf.py to format the site as expected
Removing sphinx/requirements.txt in favor of using setup.py with pip install -e "openoa[docs]" workflow to setup the build dependencies
Fixing the formatting and layout contained in the main pages so that heading syntax is used properly and consistently
Rewriting the PlantData page to be better show what information is expected from the user
Incorporation of the rewritten examples notebooks
This PR should be the last to be merged in the current list so that the current batch of updates can be incorporated into the code base, and the documentation updated accordingly.
Note: to build these locally, just run from within the top-level of openoa/ (essentially the same instructions as before):
pip install ".[docs'}
cd sphinx
make html
open _docs/html/index.html in the browser of your choice
This a draft for an ongoing PR to overhaul the documentation site build for Read the Docs. The main changes are as follows:
sphinx/conf.py
to format the site as expectedsphinx/requirements.txt
in favor of usingsetup.py
withpip install -e "openoa[docs]"
workflow to setup the build dependenciesThis PR should be the last to be merged in the current list so that the current batch of updates can be incorporated into the code base, and the documentation updated accordingly.
Note: to build these locally, just run from within the top-level of openoa/ (essentially the same instructions as before):
pip install ".[docs'}
_docs/html/index.html
in the browser of your choice