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]: Fixes and deployment to gh-pages #618

Open
wants to merge 185 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
185 commits
Select commit Hold shift + click to select a range
fd0fdb6
Add brief documentation for each stencil called in dycore.
OngChia May 13, 2024
4f2a47c
small docs update
jcanton Jun 10, 2024
dbb6e45
I hacked you
jcanton Jun 11, 2024
b9865bc
initial config and gitignore
jcanton Jul 15, 2024
dbd54c6
need this too
jcanton Jul 15, 2024
a8fac4f
need this one too
jcanton Jul 15, 2024
b582bde
need this directory
jcanton Jul 15, 2024
093bc01
ongoing work on docu
jcanton Jul 16, 2024
5b8d12b
more work on docs config and example docstrings
jcanton Jul 18, 2024
aa0a7d7
cleaned up the first two docstrings
jcanton Jul 18, 2024
9ea0efa
Merge branch 'main' into documentation_dycore
jcanton Jul 18, 2024
a7d8254
include this too...
jcanton Aug 2, 2024
3d3012b
wip on docs
jcanton Aug 7, 2024
414d682
wip docs with Chia Rui
jcanton Aug 12, 2024
79cd9f0
Merge branch 'main' into documentation_dycore
jcanton Sep 25, 2024
1a93f80
pre-commit
jcanton Sep 25, 2024
d5438aa
remove currently unused docstrings waiting for gt4py patch
jcanton Sep 27, 2024
9706eed
remove this while waiting
jcanton Oct 7, 2024
4b543b1
wip
jcanton Oct 7, 2024
ef8e2bc
wip, almost finished
jcanton Oct 16, 2024
79c765c
clean
jcanton Oct 16, 2024
4e66b3c
many changes, almost as discussed during the tuesday meeting
jcanton Oct 17, 2024
db1dc31
wip on style
jcanton Oct 18, 2024
1a81b63
redefine \sum symbol
jcanton Oct 18, 2024
d6b3ffd
add comments to explain a bit
jcanton Oct 18, 2024
e5015cf
not used anymore
jcanton Oct 18, 2024
cb296ae
automatic types and links
jcanton Oct 18, 2024
7b1d466
finished formatting, asking others
jcanton Oct 22, 2024
021a503
Merge branch 'main' into documentation_dycore
jcanton Oct 22, 2024
93cd3ff
remove this until gt4py is not patched
jcanton Oct 22, 2024
4fa12c4
cleanup unformatted scidocstrings to lighten the first PR
jcanton Oct 22, 2024
44a3cae
add some text
jcanton Oct 22, 2024
77fd3a7
move to a separate file (not very elegant import)
jcanton Oct 22, 2024
082f9fa
license information
jcanton Oct 22, 2024
9a77f49
updated macros
jcanton Oct 25, 2024
5e7e370
more and cleaner macros
jcanton Oct 26, 2024
639325d
merge main
jcanton Oct 28, 2024
a364734
re-introduce @OngChia's unformatted docstrings
jcanton Oct 28, 2024
e2bcbe9
wip adding advection, first need to fix on original branch
jcanton Oct 28, 2024
4e06113
hopefully more robust way of getting method names and objects
jcanton Oct 29, 2024
00468cd
merge main
jcanton Oct 29, 2024
ff337aa
Merge branch 'documentation_dycore' into documentation_dycore02
jcanton Oct 29, 2024
d0c3d75
update tocs
jcanton Oct 29, 2024
4ff44e9
now works with more complex method imports
jcanton Oct 29, 2024
95e287c
moving from docstrings to comment blocks
jcanton Oct 29, 2024
8088c8e
now works with more complex method imports
jcanton Oct 29, 2024
fcd98ae
moving from docstrings to comment blocks
jcanton Oct 29, 2024
1049ef7
now processing comment blocks
jcanton Oct 29, 2024
055587c
move latex_macros processing code to separate module
jcanton Oct 29, 2024
1bde310
add option for variable long names
jcanton Oct 29, 2024
7db9203
merge main
jcanton Oct 29, 2024
3c562c5
merge doc_dycore
jcanton Oct 30, 2024
6e398ff
a little less indentation and consistency with colons
jcanton Oct 30, 2024
f0e2cd7
a little less indentation and consistency with colons
jcanton Oct 30, 2024
8e36479
fix printing in the case when var longname == shortname
jcanton Oct 30, 2024
b24b23b
fix printing in the case when var longname == shortname
jcanton Oct 30, 2024
9b9ce0a
update macros
jcanton Oct 30, 2024
b96de26
one scidoc
jcanton Oct 30, 2024
b77890b
one more scidoc (not sure about weights symbols)
jcanton Oct 30, 2024
5de3bc0
forgot to move levels info
jcanton Oct 31, 2024
eaca83d
Apply suggestions from code review (easy ones)
jcanton Oct 31, 2024
f6f9cfb
macros with TexSoup (and in the right mathjax3_config dict)
jcanton Oct 31, 2024
8b62165
more easy suggestions
jcanton Oct 31, 2024
f80fd84
add packages to base requirements, update readme with makefile instru…
jcanton Oct 31, 2024
e11da53
alphabetical ordering
jcanton Oct 31, 2024
478a2be
more substantial changes to processing
jcanton Oct 31, 2024
3444b3b
remove references to "docstring" since now it's comment blocks
jcanton Oct 31, 2024
042d7ff
damn empty lines
jcanton Oct 31, 2024
c1ea964
small online edits
jcanton Nov 1, 2024
aba98f7
move things to _ext
jcanton Nov 1, 2024
a59b504
update from dycore_doc01
jcanton Nov 1, 2024
c30bc15
update to autoscidoc
jcanton Nov 1, 2024
b8feb5a
identify latex math, not only multiline blocks
jcanton Nov 1, 2024
9e76721
string interpolation and less duplication
jcanton Nov 4, 2024
0a00bb2
Enrique's review part 3 + renaming + drop colons
jcanton Nov 4, 2024
f98dbf9
identify latex math, not only multiline blocks
jcanton Nov 1, 2024
1603987
merge doc01 into doc02
jcanton Nov 4, 2024
a26f203
process math lines, not only multiline blocks
jcanton Nov 4, 2024
797e854
process math lines, not only multiline blocks
jcanton Nov 4, 2024
73c32f1
better symbols
jcanton Nov 4, 2024
b59a8ca
Merge branch 'main' into documentation_dycore
jcanton Nov 4, 2024
7e98ccf
fix: correct formatting in variable name construction and adjust inde…
jcanton Nov 4, 2024
93df74c
fix: update variable longname formatting to include small font size f…
jcanton Nov 4, 2024
965aabc
separate ast search part
jcanton Nov 4, 2024
10f6283
fix symbol spacing
jcanton Nov 4, 2024
20911fd
typos
jcanton Nov 4, 2024
cc1fc18
change latex interpolation symbols
jcanton Nov 4, 2024
7dcf381
fix symbol spacing
jcanton Nov 4, 2024
aa1aee9
final final v32 of prefix font style size colour
jcanton Nov 4, 2024
55e8ff8
multiline macros now work with TexSoup
jcanton Nov 4, 2024
870d35a
do not modify inplace
jcanton Nov 4, 2024
d9fc831
refactor AST processing and make it more readable
jcanton Nov 4, 2024
95548e2
Merge branch 'main' into documentation_dycore
jcanton Nov 5, 2024
52a7511
cleanup
jcanton Nov 5, 2024
ddf8005
Merge branch 'main' into documentation_dycore
jcanton Nov 5, 2024
3385a37
update from doc01
jcanton Nov 5, 2024
394b115
one more stencil and changes to derivatives definition
jcanton Nov 5, 2024
75c2258
underscores in link names
jcanton Nov 5, 2024
f6fc9aa
goes with previous commit
jcanton Nov 5, 2024
2be4b2b
add better notes
jcanton Nov 5, 2024
ba03bfa
update from main
jcanton Nov 6, 2024
f0fffe3
hyperlinks cleanup
jcanton Nov 6, 2024
2d0a1ea
minor updates
jcanton Nov 6, 2024
c8d008d
kinetic energy interpolation to half levels
jcanton Nov 6, 2024
c5b8711
sphinx really cares about indentation
jcanton Nov 6, 2024
27fc833
remove unnecessary (and buggy) bold font
jcanton Nov 6, 2024
c4b3940
reintroduce space before variable type now that we can without the bu…
jcanton Nov 6, 2024
0ef053e
better handling of multiline equations (and ~bug fix)
jcanton Nov 6, 2024
27d11e9
wip on adv progra
jcanton Nov 6, 2024
2219890
tentative offset provider figures
jcanton Nov 7, 2024
5436b77
figures without labels
jcanton Nov 7, 2024
4e6208f
more vertical space in multiline equations
jcanton Nov 7, 2024
87cd35b
add an output -> input variable
jcanton Nov 7, 2024
ab69911
more work on advective tendency for normal wind
jcanton Nov 7, 2024
82a82bc
added second derivative pressure
OngChia Nov 14, 2024
3df431d
cleanup
jcanton Nov 15, 2024
1958c81
figure generate and save
jcanton Nov 15, 2024
f540767
generate figures at runtime
jcanton Nov 15, 2024
6a25962
one more
jcanton Nov 15, 2024
40b9ffe
add offset provider figures to html
jcanton Nov 15, 2024
c161ee4
time steps
jcanton Nov 15, 2024
3396f2c
reference state without time superscript
jcanton Nov 15, 2024
3d5375a
update to offset provider figures
jcanton Nov 18, 2024
47771f5
remove "Offset provider:" prefix from figure title
jcanton Nov 18, 2024
9158802
bugfix and better variable name splitting
jcanton Nov 19, 2024
8965a9d
color vertices method
jcanton Nov 19, 2024
0560d24
one more stencil
jcanton Nov 19, 2024
6ca6649
fixes
jcanton Nov 19, 2024
cf5c2c2
Merge branch 'main' into documentation_dycore02
jcanton Nov 19, 2024
23ff78a
small additions
jcanton Nov 19, 2024
587a5ca
improved edge-normal derivative
jcanton Nov 19, 2024
60cd8da
end of tuesday
jcanton Nov 19, 2024
5542b47
Merge branch 'main' into documentation_dycore02
jcanton Nov 21, 2024
1bff4eb
moving things around
jcanton Nov 21, 2024
cd5da1c
one more stencil
jcanton Nov 21, 2024
9bc8c6e
understanding wcc now
jcanton Nov 21, 2024
118557c
end of contravariant correction
jcanton Nov 21, 2024
50f03a3
cleanup
jcanton Nov 22, 2024
7efaa4e
one more
jcanton Nov 25, 2024
a1daa56
fixes
jcanton Nov 25, 2024
e256ee4
one more
jcanton Nov 25, 2024
07e3e45
one more
jcanton Nov 25, 2024
a27be66
more pressure related docs
jcanton Nov 26, 2024
043bd22
Merge branch 'main' into documentation_dycore02
jcanton Nov 26, 2024
d36acd3
cleanup
jcanton Nov 26, 2024
5f1b3c0
cleanup TAYLOR_HYDRO ifs
jcanton Nov 26, 2024
5f6d167
fix
jcanton Nov 26, 2024
d00afac
toggolable inputs collapse
jcanton Nov 26, 2024
733d482
move things and add help page
jcanton Nov 26, 2024
8b4e14e
small stuff
jcanton Nov 27, 2024
487dc5a
convencience functions for array ns import and field transfer (#606)
halungge Nov 27, 2024
3de76eb
cleanup
jcanton Nov 27, 2024
8fc5c49
move back
jcanton Nov 27, 2024
c797cab
reduce maxdepth of documentation to improve navigation
jcanton Nov 27, 2024
84e2726
Add custom css
samkellerhals Dec 3, 2024
6f750da
More fixes
samkellerhals Dec 3, 2024
cdb6a53
Add workflow for gh-pages with shared pip cache
samkellerhals Dec 3, 2024
3d2aacf
Fix conflicts
samkellerhals Dec 3, 2024
062d3c6
Cache dependencies after installation
samkellerhals Dec 3, 2024
98ac23d
Allow triggering deploy action on PRs
samkellerhals Dec 3, 2024
d7a04ab
Add deploy to gh-pages to qa action
samkellerhals Dec 3, 2024
60282e2
help description
jcanton Dec 5, 2024
9f6411e
fix name
jcanton Dec 5, 2024
3789677
test add utterances
jcanton Dec 5, 2024
aba350e
update readme
jcanton Dec 5, 2024
d8d8d3e
add some script in scidoc_processor
jcanton Dec 5, 2024
8e2177f
it works!
jcanton Dec 5, 2024
e0f205a
more visible feedback section
jcanton Dec 5, 2024
b82faf9
moved feedback
jcanton Dec 9, 2024
a415b6d
Fix vertical advection PPM flux stencils (#615)
dastrm Dec 6, 2024
394a9f1
Interpolation fields factory (#607)
halungge Dec 6, 2024
4468399
[FIX] test assertion in test_grid_manager.py (#619)
halungge Dec 6, 2024
343069c
settings elements migration (#575)
nfarabullini Dec 6, 2024
25f4248
small fixes
jcanton Dec 9, 2024
ea14f5c
Merge branch 'main' into documentation_dycore02
jcanton Dec 9, 2024
3eaf928
one more figure
jcanton Dec 10, 2024
53bba37
Separate workflows
samkellerhals Dec 10, 2024
68d23da
Checkout repository in each workflow
samkellerhals Dec 10, 2024
8a05609
Fix workflows
samkellerhals Dec 10, 2024
4964823
most of Nikki's suggestions
jcanton Dec 16, 2024
d0de48b
a couple more of Nikki's suggestions
jcanton Dec 16, 2024
58ff8a3
pre-commit
jcanton Dec 16, 2024
39aef7b
Merge branch 'main' into documentation_dycore02
jcanton Jan 20, 2025
d22b8cd
try to fix mishaps
jcanton Jan 20, 2025
db699e1
put this back
jcanton Jan 21, 2025
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
Prev Previous commit
Next Next commit
wip adding advection, first need to fix on original branch
jcanton committed Oct 28, 2024
commit e2bcbe90b72c79fa709035e1d16c982883faca81
4 changes: 4 additions & 0 deletions model/atmosphere/dycore/docs/dycore_numerics.rst
Original file line number Diff line number Diff line change
@@ -5,5 +5,9 @@ This page contains the numerical documentation for the dycore. Each "macro" step
(e.g. predictor, corrector) is broken down into its inner steps, which are then
described in detail.

The advection terms are computed separately in dycore/advection

dycore_numerics_advection.rst

.. autofull:: icon4py.model.atmosphere.dycore.nh_solve.solve_nonhydro.SolveNonhydro.run_predictor_step
:no-index:
4 changes: 4 additions & 0 deletions model/atmosphere/dycore/docs/dycore_numerics_advection.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
This page documents the advection part of the dycore

.. autofull:: icon4py.model.atmosphere.dycore.velocity.VelocityAdvection.run_predictor_step
:no-index: