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

Docs: simplify notation + update Docs/Forcing section + remove Ito comments from modules/tests #178

Merged
merged 34 commits into from
Dec 30, 2020
Merged
Show file tree
Hide file tree
Changes from 33 commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
a1e4426
simplify notation + smooth Docs/Forcing + remove Ito comments
navidcy Dec 26, 2020
7af5f30
updates stochastic forcing doc section
navidcy Dec 26, 2020
d47e8b7
forcing.md -> stochastic_forcing.md
navidcy Dec 26, 2020
88f05fa
changed dollars to double quotes
navidcy Dec 26, 2020
a573ec4
k^2 -> |𝐤|^2
navidcy Dec 26, 2020
92b4cc5
fix typo
navidcy Dec 26, 2020
e16426e
Merge branch 'master' into ncc/docs-simplify
navidcy Dec 26, 2020
b25e5a0
incorporate simpleSDEItoStratonovich.jl in Docs
navidcy Dec 26, 2020
43cea1a
some phrasal enhancements
navidcy Dec 26, 2020
7cd0378
typo in energy budget plot titles
navidcy Dec 26, 2020
3e5f060
adds more explanatory remarks
navidcy Dec 26, 2020
b687ba1
adds assets directory
navidcy Dec 26, 2020
ecc2f5c
removes commented out docs section
navidcy Dec 26, 2020
8660664
fix equation (8) numbering typo
navidcy Dec 27, 2020
9a73c73
fix equations (9)-(10) numbering typo
navidcy Dec 27, 2020
54f83eb
align a ]
navidcy Dec 27, 2020
35551f6
some more phrasal enhancements
navidcy Dec 27, 2020
252bdf8
enhance docstrings and update Docs/MultilayerQG module
navidcy Dec 27, 2020
ae5fbd8
minor typo
navidcy Dec 27, 2020
ac9fd5b
LinearEquation needs calcNlinear!
navidcy Dec 27, 2020
bc0f626
fix conflicts
navidcy Dec 27, 2020
375f560
hyperdiffusion -> hyperviscosity
navidcy Dec 27, 2020
cb20167
hyperdissipation -> hyperviscosity
navidcy Dec 27, 2020
b1965c2
Merge branch 'master' into ncc/docs-simplify
navidcy Dec 27, 2020
b2a145d
MultilayerQG -> MultiLayerQG
navidcy Dec 27, 2020
3b014cd
fix docstring in set_ψ! and calcN_linearadvection!
navidcy Dec 27, 2020
67799a8
forcing is F not f (avoid confusion with Coriolis)
navidcy Dec 27, 2020
3892777
let's turn on push preview momentarily
navidcy Dec 27, 2020
98aa4a8
adds Theo's remark and fix some typos
navidcy Dec 28, 2020
011213c
typo + fix url
navidcy Dec 28, 2020
0782571
two more typos; code in example follows notation
navidcy Dec 28, 2020
c944311
disable previews again
navidcy Dec 28, 2020
f40a18f
simplify SDE example
navidcy Dec 28, 2020
afe5f4f
Merge branch 'master' into ncc/docs-simplify
navidcy Dec 30, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -94,10 +94,11 @@ sitename = "GeophysicalFlows.jl",
"modules/multilayerqg.md",
"modules/surfaceqg.md"
],
"Forcing" => "forcing.md",
"Stochastic Forcing" => "stochastic_forcing.md",
"DocStrings" => Any[
"man/types.md",
"man/functions.md"]
"man/functions.md"
]
]
)

Expand Down
1 change: 1 addition & 0 deletions docs/src/assets/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
### a placeholder directory for output generated by Docs
Binary file removed docs/src/assets/energy_budgets_Ito.png
Binary file not shown.
Binary file not shown.
Binary file removed docs/src/assets/energy_budgets_Stratonovich.png
Binary file not shown.
Binary file removed docs/src/assets/energy_comparison.png
Binary file not shown.
174 changes: 0 additions & 174 deletions docs/src/basics.md

This file was deleted.

Loading