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

Documentation: Add a wake model description page #631

Merged
merged 25 commits into from
May 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
1b611f7
update jupyter-book versioning to ensure successful builds
RHammond2 Apr 24, 2023
ef96c15
add first pass of wake comparison page
RHammond2 Apr 24, 2023
d372da8
add bibtex reference for myst
RHammond2 Apr 24, 2023
1cef001
add in docstring content for each model
RHammond2 Apr 24, 2023
72ec9bc
add ipython notebook checkpoints
RHammond2 Apr 24, 2023
d7dc050
update comment
RHammond2 Apr 24, 2023
c74d642
add some in-line comments and put Jensen in the right place
RHammond2 Apr 24, 2023
dc6ac31
remove placeholder
RHammond2 Apr 24, 2023
364a39c
Add additional wake model descriptions
paulf81 Apr 25, 2023
c7ae458
Update wake_comparison.md
paulf81 Apr 25, 2023
7e157b4
add AEP comparison to the results section
RHammond2 Apr 25, 2023
ca2c231
fix conflict
RHammond2 Apr 25, 2023
d518ad6
add wake losses
RHammond2 Apr 25, 2023
415a3e3
fix formatting error
RHammond2 Apr 25, 2023
3f7b48b
Merge branch 'develop' into pr/RHammond2/631
rafmudaf Apr 26, 2023
627ac38
Formatting clean up
rafmudaf Apr 26, 2023
cab6512
Bib clean up
rafmudaf Apr 26, 2023
0d5b919
Expand into
rafmudaf Apr 26, 2023
c7dd8be
Convert md to Jupyter Notebook
rafmudaf May 3, 2023
48cd633
Add Jensen plot
rafmudaf May 3, 2023
e6ddf6f
Add info for Jensen and GCH velocty models
rafmudaf May 5, 2023
1a5a25a
Add descriptions of the wake deflection and combination models
rafmudaf May 6, 2023
144d10b
Hide code cells
rafmudaf May 6, 2023
4dde47c
Add a bibliography page
rafmudaf May 6, 2023
1c55465
Formatting clean up
rafmudaf May 6, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
__pycache__/
.cache
*.ipynb
*.ipynb_checkpoints
*.pyc
*.egg-info
dist
Expand Down
2 changes: 1 addition & 1 deletion docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ bibtex_bibfiles:

# Information about where the book exists on the web
repository:
url: https://github.com/nrel/floris
url: https://github.com/NREL/floris
path_to_book: docs
branch: main

Expand Down
3 changes: 2 additions & 1 deletion docs/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ parts:

- caption: Theory and Background
chapters:
- file: reference
- file: wake_models
- file: bibliography

- caption: Developer Reference
chapters:
Expand Down
6 changes: 6 additions & 0 deletions docs/bibliography.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@

# Bibliography

```{bibliography}
:style: unsrt
```
589 changes: 589 additions & 0 deletions docs/wake_models.ipynb

Large diffs are not rendered by default.