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

Clarify LAM/global scope and relation to existing works #17

Open
joeloskarsson opened this issue Jun 12, 2024 · 1 comment · Fixed by #19
Open

Clarify LAM/global scope and relation to existing works #17

joeloskarsson opened this issue Jun 12, 2024 · 1 comment · Fixed by #19
Labels
documentation Improvements or additions to documentation

Comments

@joeloskarsson
Copy link
Contributor

I've been reading through the documentation and code of the repo a bit more in depth (it's very nicely described!). Something that I think needs some clarification is if this is purely focused on LAM or also global graphs? I guess it could start out with 2D LAM graphs and potentially include global ones later, but it would be good to clarify.

Related to this I found the way graphs from existing works are referenced somewhat inaccurate, as both Keisler and Lam et al. purely propose global, triangular mesh graphs. This relates to the archetypes and the documentation around these (https://mllam.github.io/weather-model-graphs/creating_the_graph.html#graph-archetypes). What is described there are the adaptations of Keisler and Lam et al. to rectangular meshes made in Oskarsson et al.

I don't mind the names being used in the archetypes, but I think the documentation of these should make a more clear distinction between what was actually proposed in these papers and the LAM adaptation by Oskarsson et al. of this. E.g.

def create_graphcast_graph(xy_grid, refinement_factor=3, max_num_levels=None):
"""
Create a graph following the Lam et al (2023, https://arxiv.org/abs/2212.12794) GraphCast architecture.

is a bit misleading as this will not create the graph from Lam et al.

@joeloskarsson
Copy link
Contributor Author

#19 clarifies this a bit in the docstrings of the archetype, but does not change how these graphs are discussed in the documentation. Because of this I think this issue should stay open.

@joeloskarsson joeloskarsson reopened this Sep 12, 2024
@joeloskarsson joeloskarsson added the documentation Improvements or additions to documentation label Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant