Website documentation - Githubissues

cassidymwagner / fluidsf

FluidSF is a package used to calculate structure functions from fluid data.

https://cassidymwagner.github.io/fluidsf

MIT License

5 stars 3 forks source link

Website documentation #23

Closed cassidymwagner closed 1 month ago

cassidymwagner commented 2 months ago

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.

TODO:

Structure function intro page

[x] Add more references for theory and maybe use-cases
[x] Fill in the rest of the table
[x] Note Bessel function method

Modules page

[ ] Main FluidSF workflow schematic - future work
[ ] Helper/utility function schematic/flow chart - future work

Examples

[x] Cascade rate example
[ ] Latlon example (ECCO) - future work

General edits and review

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 78.77%. Comparing base (0adaaab) to head (4252b30).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #23 +/- ## ======================================= Coverage 78.77% 78.77% ======================================= Files 18 18 Lines 801 801 ======================================= Hits 631 631 Misses 170 170 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

BrodiePearson commented 2 months ago

This is great!

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

[x] FluidSF Intro: Generalize to include broader utility of structure functions
[x] 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?
[x] Getting Started: Shift after "What are SFs" section for logical progression
[x] Getting Started: To make more interpretable, add plots of the fields (velocitity, advection) to make it clear what is going on
[x] 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 commented 2 months ago

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