Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build out v4 documentation #860

Merged
merged 112 commits into from
Apr 7, 2024
Merged

Build out v4 documentation #860

merged 112 commits into from
Apr 7, 2024

Conversation

misi9170
Copy link
Collaborator

@misi9170 misi9170 commented Apr 1, 2024

Main pull request for documentation updates for v4. See checklist below for assignments.

Places for adding documentation:

  • User Reference: high-level information for normal users, ideally using simple examples
  • Theory and Background: Detailed information, including mathematical models.
  • Developer Reference: information needed for developers to add to existing capabilities

The major focus of this PR is on getting the User Reference up to speed with changes for v4. However, adding to the Theory and Background and Developer Reference sections is also encouraged :)

When adding documentation to the User Reference, consider:

  • What would a normal user need to know to run a simple example and interpret the outputs?
  • What basic options does the user have to customize the calculations and performance?
  • Could a short example script that produces an output or plot be added to demonstrate the options and functionality? (if so, consider formulating the section as a jupyter notebook)

Assignments

  • wind data objects (general, WindRose, TimeSeries, WindTIRose) @paulf81
  • Floating wind @bayc
  • Value-based optimization @ejsimley , may live on the same file as the wind data objects
  • Operation models @misi9170
  • Helix @jfrederik-nrel , add to the operation_models_user.ipynb notebook for turbine performance, possibly new notebook for wake model? Unsure.
  • Converting from v3 to v4 @rafmudaf @misi9170

Please go ahead and push changes to this branch (v4-ms/docs). To see the compiled docs after you have pushed, see https://misi9170.github.io/floris/index.html (you'll need to wait a few minutes for them to build).

Final steps:

misi9170 and others added 30 commits January 11, 2024 08:40
Solve merge conflict between v4 and helix branch
@paulf81
Copy link
Collaborator

paulf81 commented Apr 6, 2024

I think we should merge this branch soon. One last annoying issue that I wouldn't mind fixing is the first comment block, jupyter-book is collapsing white space (new lines and tab indents) in a way that makes the blocks less readable. There appear to be solutions (one is we can adjust the config.yml file to change this behavior) but maybe someone else could have a quick look?

@misi9170
Copy link
Collaborator Author

misi9170 commented Apr 7, 2024

One last annoying issue that I wouldn't mind fixing is the first comment block, jupyter-book is collapsing white space (new lines and tab indents) in a way that makes the blocks less readable.

In the interest of moving this forward, I'm going to go ahead and merge. We can open a PR to develop at a later date to address this.

@misi9170 misi9170 merged commit 0073dba into NREL:v4 Apr 7, 2024
8 checks passed
@misi9170 misi9170 mentioned this pull request Apr 8, 2024
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation v4 Focus of FLORIS v4
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

6 participants