Skip to content

Documentation: Add a wake model description page#631

Merged
rafmudaf merged 25 commits intoNatLabRockies:developfrom
RHammond2:docs/model_comparison
May 6, 2023
Merged

Documentation: Add a wake model description page#631
rafmudaf merged 25 commits intoNatLabRockies:developfrom
RHammond2:docs/model_comparison

Conversation

@RHammond2
Copy link
Collaborator

@RHammond2 RHammond2 commented Apr 24, 2023

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 the jupyter-book maximum version
  • .gitignore: Adds in Jupyter checkpoint files

@RHammond2 RHammond2 added this to the v3.4 milestone Apr 24, 2023
@RHammond2 RHammond2 requested review from paulf81 and rafmudaf April 24, 2023 23:07
@rafmudaf
Copy link
Collaborator

rafmudaf commented May 5, 2023

@paulf81 can you check what I've written for the velocity models here and expand on the TurbOPark and CC models?

Copy link
Collaborator

@rafmudaf rafmudaf left a 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 rafmudaf changed the title Documentation: Model Comparison/Theory Page Documentation: Add a wake model description page May 6, 2023
@rafmudaf rafmudaf merged commit d2f7a45 into NatLabRockies:develop May 6, 2023
@paulf81
Copy link
Collaborator

paulf81 commented May 6, 2023

The page looks awesome, thank you @rafmudaf !

@RHammond2 RHammond2 deleted the docs/model_comparison branch May 8, 2023 15:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants