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
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
paulf81
approved these changes
Apr 25, 2023
@paulf81 can you check what I've written for the velocity models here and expand on the TurbOPark and CC models? |
rafmudaf
approved these changes
May 6, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's always more to add to the docs but this is a good start.
rafmudaf
changed the title
Documentation: Model Comparison/Theory Page
Documentation: Add a wake model description page
May 6, 2023
The page looks awesome, thank you @rafmudaf ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Create high-level documentation for the wake models
This PR adds in a page (with content!) for the wake model theory and how our example model settings relate to each other. The content is structured as a combination of prose and code to be more effective for users.
In addition, this PR fixes the maximum version for the
jupyter-book
dependency to avoid a slew of documentation build errors, and adds Jupyter checkpoint files to the.gitignore
configuration.@rafmudaf and @paulf81 it would be great to get some direct edits from the both of you to fill in the sparse documentation that was copied over from our existing and old documentation pages about what the models are, and how they relate.
Related issue
N/A
Impacted areas of the software
setup.py
: Fixes thejupyter-book
maximum version.gitignore
: Adds in Jupyter checkpoint files