Updates to Readme and Docs

[jordanperr]

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

[ejsimley]

This is a nice way to organize the readme. I added and reformatted some references, and added some suggested revisions to the text as comments. I still need to add some references for the wake loss and yaw misalignment methods, but will update those by the end of the week.

My only other comment is that we should also update the "About" section on GitHub when we merge this.

[RHammond2]

Thanks for putting this together @jordanperr! This is a nice update to the project's README, and looking forward to getting it integrated into the docs site main page as well. I think I may have updated the docs main page for v3, though, so it might be worthwhile to crosscheck them and see if anything is worth salvaging from there prior to swapping it out with the README.

[ejsimley]

Most of the PRUF publications describe the AEP analysis method, so we could also cite references 1 and 4 if you think that's appropriate here.

[codecov-commenter]

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 ⚠️

Additional details and impacted files

@@             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              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[RHammond2]

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

[allcontributors]

@RHammond2

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

[RHammond2]

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

[allcontributors]

@RHammond2

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

[RHammond2]

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

[allcontributors]

@RHammond2

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

[RHammond2]

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).

[ejsimley]

@RHammond2 I just looked at the compiled documentation, and think it would make more sense to start with the high-level software overview before the installation steps, to introduce people to the purpose of the software first. The order could be Software overview (intro part), installation, then analysis methods, PlantData Schema... What do you think about that order?

[RHammond2]

I think that makes a lot of sense, I'll make that change and do the 3.1 release if there's nothing else.

[ejsimley]

That sounds good to me! I don't think there's anything else, at least I didn't have any more comments.