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

Website documentation #23

Open
wants to merge 109 commits into
base: main
Choose a base branch
from
Open

Website documentation #23

wants to merge 109 commits into from

Conversation

cassidymwagner
Copy link
Owner

@cassidymwagner cassidymwagner commented Jul 8, 2024

This pull request will merge all of the documentation currently hosted on the GitHub Pages website. This will make it a bit easier to avoid breaking changes while also make the doc development process more collaborative.

Unfortunately it might not be straightforward to preview the documentation html files, so this may have to happen locally for each developer.

TODO:

Structure function intro page

  • General edits
  • Add more references for theory and maybe use-cases
  • Fill in the rest of the table

Supported data page

  • General edits
  • Add more detailed information(?)

SWOT example notebook

  • General edits

Key terms page

  • General edits

@BrodiePearson
Copy link
Collaborator

BrodiePearson commented Jul 10, 2024

This is great!

Some of the places where I see some some work needed (I can assist/lead parts of this!):

  • FluidSF Intro: Generalize to include broader utility of structure functions
  • Getting Started: Adapt the example to use some real or physically-meaningful synthetic data (i.e., a field with a mean gradient or an oscillatory variation in one direction). This will be more interpretable/useful to a new user?
  • Getting Started: Shift after "What are SFs" section for logical progression
  • Getting Started: To make more interpretable, add plots of the fields (velocitity, advection) to make it clear what is going on
  • What are SFs: Focus discussion on the SFs that can be calculated or are physically useful and/or calculable with the current package (longitudinal/transverse; advective; scalar-blended; second-, third- and higher-order)

@cassidymwagner
Copy link
Owner Author

I reran the example notebooks that calculated structure functions before the bug fix in #26.

Added some general context of package
Update overview
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants