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.

Sign up for GitHub

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

Jump to bottom

Documentation: Limited Area Modeling #42

Draft
wants to merge 71 commits into
base: develop
Choose a base branch
from
Draft

Documentation: Limited Area Modeling #42

wants to merge 71 commits into from

Conversation

JPXKQX
Copy link
Member

@JPXKQX JPXKQX commented Aug 20, 2024 •
edited by github-actions bot
Loading

This PR includes an future version for the documentation up to the point including the following changes:

  • Limited Area graphs
  • Stretched graphs

The folder and file layout is planned to include more content in some categories in the future.

📚 Documentation preview 📚: https://anemoi-graphs--42.org.readthedocs.build/en/42/

theissenhelen and others added 30 commits June 24, 2024 14:29
@theissenhelen
feat: Initial implementation of global graphs
38f8d15 
Co-authored by: Mario Santa Cruz <[email protected]>
@theissenhelen
add dependencies
9dc2cec
@JPXKQX
add cli command
f1fe18f
@JPXKQX
Ignore .pt files
b8b558d
@JPXKQX
run pre-commit
7f6f4bd
@JPXKQX
docstring + log erros
d5f67fd
@JPXKQX
initial tests
b12272d
@theissenhelen
feat: initial version of AttributeBuilder
cce5ea6
@theissenhelen
refactor: separate into node edge attribute builders
9ba0391
@JPXKQX
feat: edge_length moved to edges/attributes.py
9a47184
@JPXKQX
remove __init__
384adc7
@JPXKQX
feat: test edge builders
0bc176c
@JPXKQX
add blank lines
d16934b
@JPXKQX
dep: hydra-core
0f82ea7
@JPXKQX
bugfix (encoder edge lengths) + refector
a9c5ada
@JPXKQX
deps: == to >=
66ef5dc
@JPXKQX
docs: first documentation WIP
0d31c56
@JPXKQX
update docs
42e1ad4
@JPXKQX
Global Encoder-Processor-Decoder graph (#9)
3609681 
* feat: Initial implementation of global graphs

Co-authored by: Mario Santa Cruz <[email protected]>
Co-authored-by: Helen Theissen <[email protected]>
Co-authored-by: Sara Hahner <[email protected]>
Co-authored-by: Jesper Dramsch <[email protected]>
@JPXKQX
add cli command
63c090b
@JPXKQX
run pre-commit
d02be30
@theissenhelen @JPXKQX
feat: initial version of AttributeBuilder
aa59627
@theissenhelen @JPXKQX
refactor: separate into node edge attribute builders
428d799
@JPXKQX
feat: edge_length moved to edges/attributes.py
c54e491
@JPXKQX
remove __init__
221dc30
@JPXKQX
docs: first documentation WIP
541a6b2
@JPXKQX
update docs
7c4f706
@JPXKQX
Merge branch 'develop' into feature/docs
12e5950
@JPXKQX
Merge branch 'develop' of github.com:ecmwf/anemoi-graphs into feature…
0f7fce5 
…/docs
@JPXKQX
udpate documentation
9836945
@JPXKQX JPXKQX added the documentation Improvements or additions to documentation label Aug 20, 2024
@JPXKQX JPXKQX added this to the Limited Area Graphs milestone Aug 20, 2024
@JPXKQX JPXKQX self-assigned this Aug 20, 2024
JPXKQX and others added 13 commits August 20, 2024 11:20
@JPXKQX
docs: fix layout
2ab138f
@JPXKQX @theissenhelen
@gmertes @JesperDramsch @gareth-j @mc4117
docs: bring contributing guidelines from anemoi-training
f826e95 
Co-authored-by: Helen Theissen <[email protected]>
Co-authored-by: Gert Mertes <[email protected]>
Co-authored-by: Jesper Dramsch <[email protected]>
Co-authored-by: Gareth Jones <[email protected]>
Co-authored-by: Mariana Clare <[email protected]>
@JPXKQX
docs: add references to cli pages
ba0fc13
@JPXKQX
docs: add anemoi-graphs describe CLI
5354407
@JPXKQX
docs: expand docstring
bf38fe3
@JPXKQX
docs: lam documentation WIP
c6ca217
@JPXKQX
docs: include creator and inspector to modules
d68bbf1
@JPXKQX
Merge branch 'feature/docs' into docs/limited_area
0410996
@JPXKQX
docs: update usage
73b8395
@JPXKQX
Merge branch 'develop' into docs/limited_area
19a3d16
@JPXKQX
docs: fix typo
c4a592a
@JPXKQX @dietervdb-meteo
docs: CutOutZarrDatasetNodes
46d5bdf 
Co-authored-by: Dieter Van den Bleeken <[email protected]>
@JPXKQX @dietervdb-meteo
fix: typo
83f1c82 
Co-authored-by: Dieter Van den Bleeken <[email protected]>
@mchantry
Copy link
Member

Really like the docs, what do you think about specifying the number of nodes/edges at different refinement levels for the icosahedral approach?

Refinement 0 1 2 3 4 5 6
Num Nodes 12 42 162 642 2,562 10,242 40,962
Num Faces 20 80 320 1,280 5,120 20,480 81,920
Num Edges 60 240 960 3,840 15,360 61,440 245,760
Num Multilevel Edges 60 300 1,260 5,100 20,460 81,900 327,660

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@JPXKQX JPXKQX

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
Limited Area Graphs
Development

Successfully merging this pull request may close these issues.
4 participants
@JPXKQX @mchantry @theissenhelen @JesperDramsch