NREL / OpenOA

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.
https://openoa.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
193 stars 63 forks source link

Documentation Improvements #214

Closed RHammond2 closed 1 year ago

RHammond2 commented 2 years ago

This issue is a reflection of the unaddressed content improvements from @jordanperr and @ejsimley in #207.

ejsimley commented 2 years ago

When looking at the new documentation I noticed that example 2b is not included in the examples documentation. Should this be added, or is there a reason it isn't included yet?

RHammond2 commented 2 years ago

It was intentional but only because it hadn't been updated with example 2, so I was unsure if it should be included or not. Happy to bring up to date and reinstate it though.

ejsimley commented 2 years ago

I think we should include example 2b, since it highlights the more advanced features of the AEP analysis. Let me know if there's anything I can do to help with that.

jordanperr commented 1 year ago

Additionally, it would be nice to have some tables or lists in the documentation showing the tag names, units, frequencies, and any other requirements, broken out by analysis type.

We could also compile a superset of all possible columns into one large schema document.

I suggest this all be defined in JSON files somewhere (such as an Analysis_Requirements JSON file, and a PlantSchema JSON file), which is then read in by Sphinx to generate the tables automatically. Related to #227