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

Update Getting Started Instructions and Settings #246

Closed RHammond2 closed 1 year ago

RHammond2 commented 1 year ago

This PR addresses the third bullet point in #214 to improve upon the legibility of the getting started, contributing, and installation instructions. This is accomplished by a basic reorganization of the content to be more streamlined and by communicating the ideas more clearly and inline with using Python in 2023.

This also restructures the way that the examples are displayed so that can each be their own page on the documentation site instead of a single page with a high level of nesting.

codecov-commenter commented 1 year ago

Codecov Report

Patch coverage: 33.33% and no project coverage change.

Comparison is base (8d12083) 62.88% compared to head (1beafab) 62.89%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop_v3 #246 +/- ## =========================================== Coverage 62.88% 62.89% =========================================== Files 29 29 Lines 4209 4210 +1 =========================================== + Hits 2647 2648 +1 Misses 1562 1562 ``` | [Files Changed](https://app.codecov.io/gh/NREL/OpenOA/pull/246?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NREL) | Coverage Δ | | |---|---|---| | [openoa/analysis/yaw\_misalignment.py](https://app.codecov.io/gh/NREL/OpenOA/pull/246?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NREL#diff-b3Blbm9hL2FuYWx5c2lzL3lhd19taXNhbGlnbm1lbnQucHk=) | `84.77% <ø> (ø)` | | | [openoa/utils/imputing.py](https://app.codecov.io/gh/NREL/OpenOA/pull/246?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NREL#diff-b3Blbm9hL3V0aWxzL2ltcHV0aW5nLnB5) | `90.41% <ø> (ø)` | | | [openoa/utils/machine\_learning\_setup.py](https://app.codecov.io/gh/NREL/OpenOA/pull/246?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NREL#diff-b3Blbm9hL3V0aWxzL21hY2hpbmVfbGVhcm5pbmdfc2V0dXAucHk=) | `79.24% <ø> (ø)` | | | [openoa/utils/plot.py](https://app.codecov.io/gh/NREL/OpenOA/pull/246?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NREL#diff-b3Blbm9hL3V0aWxzL3Bsb3QucHk=) | `4.81% <0.00%> (ø)` | | | [openoa/analysis/aep.py](https://app.codecov.io/gh/NREL/OpenOA/pull/246?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NREL#diff-b3Blbm9hL2FuYWx5c2lzL2FlcC5weQ==) | `85.97% <100.00%> (+0.03%)` | :arrow_up: |

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

RHammond2 commented 1 year ago

@jordanperr, below are some replies as they relate to your bullets above, but separated for ease of cross referencing the original point.