Skip to main content

PyMPDATA usage examples reproducing results from literature and depicting how to use PyMPDATA in Python from Jupyter notebooks

Project description

Introduction

PyMPDATA examples are bundled with PyMPDATA and located in the examples subfolder. They constitute a separate PyMPDATA_examples Python package which is also available at PyPI. The examples have additional dependencies listed in PyMPDATA_examples package setup.py file. Running the examples requires the PyMPDATA_examples package to be installed.

We recommend you look through the example gallery below to see the examples in action.

Example gallery

Unless stated otherwise the following examples solve the basic advection equation: $$ \partial_t (\psi) + \nabla \cdot (u \psi) = 0 $$

The examples are grouped by the dimensionality of the computational grid.

in 1D

tags link
advection-diffusion equation
$$ \partial_t (\psi) + \nabla \cdot (u \psi) + \mu \Delta (\psi) = 0 $$
advection_diffusion_1d*
Black-Scholes equation, option pricing
$$ \frac{\partial f}{\partial t} + rS \frac{\partial f}{\partial S} + \frac{\sigma^2}{2} S^2 \frac{\partial^2 f}{\partial S^2} - rf = 0$$
Arabas_and_Farhat_2020*
advection equation, homogeneous, several algorithm variants comparison: infinite-gauge, flux-corrected,.. Smolarkiewicz_2006_Figs_3_4_10_11_12
Size-spectral advection, particle population condensational growth, coordinate transformation
$$ \partial_t (G \psi) + \nabla \cdot (Gu \psi) = 0 $$
Olesik_et_al_2022*
advection equation, double-pass donor-cell option DPDC

in 2D

tags link
advection-diffusion equation
$$ \partial_t (\psi) + \nabla \cdot (u \psi) + \mu \Delta (\psi) = 0 $$
advection_diffusion_2d*
adv-diff
Spectral-spatial advection, particle population condensational growth in a vertical column of air, time dependent flow Shipway_and_Hill_2012
spectral-spatial
shallow-water equations
$$\begin{eqnarray} \partial_t h + \partial_x (uh) + \partial_y (vh) &=& 0~ \\ \partial_t (uh) + \partial_x ( uuh) + \partial_y (vuh) &=& - h \partial_x h~ \\ \partial_t (vh) + \partial_x ( uvh) + \partial_y (vvh) &=& - h \partial_y h~ \end{eqnarray}$$
Jarecka_et_al_2015*
advection equation, solid body rotation Molenkamp_test_as_in_Jaruga_et_al_2015_Fig_12*
advection equation, coordinate transformation, spherical coordinates, see also examples in PyMPDATA-MPI $$ \partial_t (G \psi) + \nabla \cdot (Gu \psi) = 0 $$ Williamson_and_Rasch_1989_as_in_Jaruga_et_al_2015_Fig_14
mpi-gif
advection equation, comparison against DG solution using Trixi.jl trixi_comparison

in 3D

tags link
homogeneous advection equation Smolarkiewicz_1984
homogeneous advection equation, performance comparison against libmpdata++, scalability analysis in respect to threads Bartman_et_al_2022

* - with comparison against analytic solution

Installation

Since the examples package includes Jupyter notebooks (and their execution requires write access), the suggested install and launch steps are:

git clone https://github.com/open-atmos/PyMPDATA-examples.git cd PyMPDATA-examples pip install -e . jupyter-notebook

Alternatively, one can also install the examples package from pypi.org by using pip install PyMPDATA-examples.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pympdata_examples-1.2.4.tar.gz (30.6 kB view details)

Uploaded Source

Built Distribution

PyMPDATA_examples-1.2.4-py3-none-any.whl (44.2 kB view details)

Uploaded Python 3

File details

Details for the file pympdata_examples-1.2.4.tar.gz.

File metadata

  • Download URL: pympdata_examples-1.2.4.tar.gz
  • Upload date:
  • Size: 30.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for pympdata_examples-1.2.4.tar.gz
Algorithm Hash digest
SHA256 11a20bc19a78771f858ac75d00af3943961adbd1585359b87905aaae884775fd
MD5 70c2d5609465333bf43d137ae1cc92c7
BLAKE2b-256 ccbc4a34e7a0ef0991d15ad4b4a7d71e90b7835e5b7dd621602c4bf3cbe8698c

See more details on using hashes here.

File details

Details for the file PyMPDATA_examples-1.2.4-py3-none-any.whl.

File metadata

File hashes

Hashes for PyMPDATA_examples-1.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 9e76dcfbe7763daca17dbe469f2c8b6fb001bf52229837879ef9a2e9e07e4c1a
MD5 d03947b356ec2e7a2b09104a2d8da149
BLAKE2b-256 2793350b1b2ec48bdeaa9442f5b0f47d8c052224f84b4db71423a19e5f6a1504

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page