Plonk

Smoothed particle hydrodynamics analysis and visualization with Python.

• Docs: https://plonk.readthedocs.io/
• Repo: https://www.github.com/dmentipl/plonk

Usage

Plonk supports the following SPH file formats:

• Phantom output in HDF5 format.

Note: you can convert Phantom non-HDF5 snapshots to HDF5. See the Phantom docs.

Accessing data

To read in a simulation with snapshot files like disc_00000.h5, and global quantity time series files like disc01.ev, in the current directory, and see what snapshots there are:

>>> import plonk

>>> simulation = plonk.load_sim(prefix='disc')
>>> simulation.snaps
[<plonk.Snap: "disc_00000.h5">,
 ...
 <plonk.Snap: "disc_01000.h5">]

The Snap objects contain the particle arrays, lazily loaded from the HDF5 file, as well as simulation metadata properties stored as a dictionary.

Visualization

To render the density on a snapshot:

>>> snap = plonk.load_snap('disc_00000.h5')
>>> plonk.visualize.render(snap=snap, quantity='density')

For a more complicated example, here is the deviation from Keplerian velocity around a planet embedded in a protoplanetary disc.

Deviation from Keplerian velocity around a planet: at the disc midplane (left), and 10 (middle) and 20 au (right) above the disc midplane. Data from a Phantom simulation.

More

For further usage, see examples folder and documentation. The code is internally documented with docstrings. Try, for example, help(plonk.Snap) or help(plonk.load_snap).

Install

Conda

You can install Plonk via the package manager Conda

conda install plonk --channel dmentipl

This will install the required dependencies. For details on Conda, see https://docs.conda.io/.

pip

You can also install Plonk via pip.

pip install plonk

This should install the required dependencies. For details on pip, see https://pip.pypa.io/.

Getting help

If you need help, try the following, in order:

1. Check the documentation.
2. Ask questions on Stack Overflow using the plonk tag.
3. File an issue, as a bug report or feature request, using the issue tracker.

If you don't get an immediate response, please be patient. Plonk is maintained by one person, @dmentipl.

Contributing

Thank you for considering contributing to Plonk. Contributions are welcome.

See CONTRIBUTING.md for guidelines on how to contribute.

Citation

If you use Plonk in a scientific publication, please cite the paper published in JOSS.

Plonk: Smoothed particle hydrodynamics analysis and visualization with Python

You should also consider citing any other scientific software packages that you use.