Roadmap

[leifdenby]

v0.1.0

• graph creation
  • mesh creation
    • [x] support for cartesian grid coordinates
  • graph archetypes
    • [x] Keisler nearest-neighbour
    • [x] GraphCast multi-range
    • [x] Oscarsson hierarchical
• graph visualisation
  • [x] 2D using matplotlib+networkx with node and edge rendering with arched directed edges and colouring of edges and nodes by attribute value
• graph splitting
  • [x] split graph by attribute value
• saving graphs
  • [x] pytorch-geometric format for neural-lam (uses torch.pickle and specific splitting of graph and filename format)
  • [x] pickle of networkx.DiGraph objects
• readme
  • [ ] install instructions, detailing optional dependency on pytorch and pytorch geometric
  • [x] background on graph-based weather models and design of package
  • [x] package module overview

TODO

• [x] fix typo architype to archetype
• [x] add docstrings to archetype creation functions
• [ ] rename weather_model_graphs.visualise.nx_draw_with_pos_and_attr(...) with weather_model_graphs.visualise.draw_2d(...), double check doc string
• [ ] add install instructions, remove pytorch from deps and explain how to install for gpu or cpu if needed
• [x] add g2m, m2m, m2g visualisation to notebooks in jupyterbook docs
• [ ] setup pypi deploy github action, create first release and publish on pypi

v0.2.0

• add support for lat/lon coordinates
  • [ ] support for creating mesh from lat/lon grid coordinates by using a local equal area projection
  • [ ] add support for plotting on maps with cartopy when coordinates are lat/lon rather than cartesian

v0.3.0

• [ ] add a LAM architype where two sets of xy-coordinates are passed in (for the global and local grid) and the connectivity between all nodes can be made
• [ ] remove the assumption that the input grid is regular (i.e. that the input coordinates have shape [2, nx, ny]) and instead make it so mesh node coordinates can be computed from bounding box of input coordinates (or something like that)
• [ ] add optional support for faster graph backend, for example graph-tool with underlying routines written in c++. Should wrap graph-tool digraph representation in new class wmg.graphtool.WrappedDiGraph which behaves like a networkx.DiGraph for the operations we need
• [ ] add 3D visualisation using the Plotly based routines in https://github.com/joeloskarsson/neural-lam/blob/main/plot_graph.py

[leifdenby]

@joeloskarsson I am happy to revisit this roadmap to create a new release with just the PRs you have been working on. Maybe you could see if you would like to have a tagged release at some point and let me know? I can always push the functionality I mention above to later version numbers. I only made the roadmap to give an idea of features I would like to add and in what order

[joeloskarsson]

Yes it would probably be good to have the things I am working on / planning to work on in here. I don't have any strong opinions about the ordering of these things, or creating specific releases, so I'll let you plan that out. But I'll list here the things I have been doing and are planning to do, so you can add them to the roadmap:

Done / on the way

• 19 (merged)

• 21 (PR)

Planned (roughly in this order)

• Create "better" strategy for m2g-connection than 4-nearest-neighbors, that is close to GraphCast strategy but for a quadrilateral LAM mesh graph. Specifically, find the "square" in the mesh containing the grid node and connect it to the four corner mesh nodes. Connect grid nodes outside the mesh bounding box only to the two closest neighbors.
• (already on the roadmap) Remove the assumption that the input grid is regular
• Triangular mesh graphs, by similar type of refinement as in GraphCast.

Maybe @TomasLandelius would want to also add an entry about the SOM-based graph creation discussed here: https://github.com/mllam/neural-lam/issues/4#issuecomment-2141308373