create an automated comparison against Trixi.jl (or another external package)

slayoo commented 7 months ago

Goals:

comparison/validation against an external package (e.g., Trixi: https://trixi-framework.github.io/)
new example notebook for PyMPDATA-examples (see https://pypi.org/project/PyMPDATA-examples/)
inclusion of a new test asserting on the output consistency in the automated CI/pytest workflows (see https://github.com/open-atmos/PyMPDATA/actions)
add new visualisation to PyMPDATA README (see https://github.com/open-atmos/PyMPDATA-MPI/)
(encouraged side effects: companion PRs improving PyMPDATA README, docstrings, API, ...; likely a PR to open-atmos-jupyter-utils, see below)

Steps:

[x] confirm if the choice of Trixi.jl is apt here, consider other advection-solving packages listed in the README
[x] select a simulation from the external package examples/docs that is simple, feasible with PyMPDATA, but perhaps not entirely trivial
[x] create a Jupyter notebook performing the simulation in PyMPDATA and visualising the output (still or animated)
[ ] automate comparison against external package results (can be part of the notebook or done elsewhere)
[ ] include assertions on consistency against the external package in PyMPDATA CI (the notebook_variables fixture may be useful here: https://github.com/open-atmos/PySDM/blob/main/examples/PySDM_examples/utils/notebook_vars.py - perhaps we can then move it to become part of https://pypi.org/project/open-atmos-jupyter-utils/?)
[ ] include upload of the visualisation file on each merge to be available for rendering within the README file
[ ] update README to include the visualisation (+ some explanation)
[ ] PR review and merge

The above points would result in a new PR to PyMPDATA including:

github-actions[bot] commented 2 months ago

Stale issue message

slayoo commented 1 month ago

being addressed here: #454

open-atmos / PyMPDATA