Skip to content

Commit

Permalink
add mention of PyPartMC to the README (#193)
Browse files Browse the repository at this point in the history
  • Loading branch information
slayoo authored Dec 12, 2023
1 parent f871c30 commit 5760bfb
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -273,3 +273,18 @@ particle-resolved runs) or binned data (from sectional or exact
runs). The `extract_*` programs can read these per-timestep NetCDF
files and output ASCII data (the `extract_sectional_*` programs are
used for sectional and exact model output).

Python bindings
===============

The [PyPartMC](https://github.com/open-atmos/PyPartMC) project offers
pip-installable Python bindings to PartMC. Both source and binary
packages are available and ship with all PartMC dependencies included.
PyPartMC exposes internal components of PartMC (utility routines and
derived types) which then can serve as building blocks to develop PartMC
simulations in Python. Time stepping can be performed either using the
internal PartMC time-stepper or externally within a Python loop. The
latter allows to couple the simulation with external Python components
in each timestep. PyPartMC features examples developed as Jupyter notebooks.
Snippets of code provided in the README file depict how to use PyPartMC
from Julia (using PyCall.jl) and Matlab (using Matlab's built-in Python bridge).

0 comments on commit 5760bfb

Please sign in to comment.