Updates to Readme and Docs

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

Updates to Readme and Docs #267

Closed jordanperr closed 8 months ago

jordanperr commented 10 months ago

Add table of analysis methods with citations (placeholder for now)
updated citation instructions
add a warning box showing a disclaimer related to use

codecov-commenter commented 9 months ago

Codecov Report

Attention: Patch coverage is 66.66667% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 72.49%. Comparing base (aa11436) to head (be9c574).

Files	Patch %	Lines
openoa/logging.py	66.66%	1 Missing :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## develop #267 +/- ## =========================================== - Coverage 72.49% 72.49% -0.01% =========================================== Files 29 29 Lines 3687 3690 +3 Branches 794 796 +2 =========================================== + Hits 2673 2675 +2 - Misses 825 826 +1 Partials 189 189 ```

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

RHammond2 commented 9 months ago

@all-contributors please add @jordanperr for documentation. please add @ejsimley for documentation. please add @RHammond2 for documentation.

allcontributors[bot] commented 9 months ago

@RHammond2

File README.md was not found in the repository (NREL/OpenOA).

RHammond2 commented 9 months ago

@all-contributors please add @jordanperr for documentation. please add @ejsimley for documentation. please add @RHammond2 for documentation.

allcontributors[bot] commented 9 months ago

@RHammond2

File README.md was not found in the repository (NREL/OpenOA).

RHammond2 commented 9 months ago

@all-contributors please add @jordanperr for documentation. please add @ejsimley for documentation. please add @RHammond2 for documentation.

allcontributors[bot] commented 9 months ago

@RHammond2

File README.md was not found in the repository (NREL/OpenOA).

RHammond2 commented 8 months ago

I've just pushed a couple updates. Commit 0c52c93 should resolve #278 and b09c1e0 should fix the issue where methods or functions wrapped in @logged_xx_call show as do_something(*args, **kwargs) instead of do_something(arg1, arg2, kwarg1).