PyMPDATA-examples

v1.2.5

PyMPDATA usage examples reproducing results from literature and depicting how to use PyMPDATA in Python from Jupyter notebooks For more information about how to use this package see README

Latest version published 12 days ago

License: GPL-3.0

PyPI

GitHub

Package Health Score

63 / 100

security
Security review needed
popularity
Limited
maintenance
Healthy
community
Sustainable

Popularity

Limited

GitHub Stars: 27
Forks: 17
Contributors: 20

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package PyMPDATA-examples, we found that it has been starred 27 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Dec 11, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 3
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

GPL-3.0

Non-Permissive License

We noticed that this project uses a license which requires less permissive conditions such as disclosing the source code, stating changes or redistributing the source under the same license. It is advised to further consult the license terms before use.

Security Policy

We found a way for you to contribute to the project! Looks like PyMPDATA-examples is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 12
Open PR: 6
Last Release: 12 days ago
Last Commit: 12 days ago

Further analysis of the maintenance status of PyMPDATA-examples based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that PyMPDATA-examples demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Sustainable

Readme: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the PyMPDATA-examples repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like PyMPDATA-examples is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: Unspecified

Age: 3 years
Latest Release: 12 days ago
Dependencies: 10 Direct / 46 Total
Versions: 37
Maintainers: 0
Wheels: OS Independent

Readme

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*
Spectral-spatial advection, particle population condensational growth in a vertical column of air, time dependent flow	Shipway_and_Hill_2012
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
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.

PyMPDATA-examples dependencies

imageio joblib matplotlib meshio open-atmos-jupyter-utils pint pympdata pystrict scipy sympy

FAQs

What is PyMPDATA-examples?

PyMPDATA usage examples reproducing results from literature and depicting how to use PyMPDATA in Python from Jupyter no... Visit Snyk Advisor to see a full health score report for PyMPDATA-examples, including popularity, security, maintenance & community analysis.

Is PyMPDATA-examples popular?

The python package PyMPDATA-examples receives a total of 728 weekly downloads. As such, PyMPDATA-examples popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is PyMPDATA-examples well maintained?

We found that PyMPDATA-examples demonstrated a healthy version release cadence and project activity. It has a community of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is PyMPDATA-examples safe to use?

While scanning the latest version of PyMPDATA-examples, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 14 December-2024, at 04:10 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP