Smoothed particle hydrodynamics analysis and visualization with Python.
Project description
Plonk
Smoothed particle hydrodynamics analysis and visualization with Python.
Description
Plonk is a Python tool for analysis and visualization of smoothed particle hydrodynamics data with a focus on astrophysical fluid dynamics.
With Plonk we aim to integrate the high quality SPH visualisation of Splash into the modern Python astronomer workflow, and provide a framework for analysis of smoothed particle hydrodynamics simulation data.
Usage
Plonk supports the following SPH file formats:
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.plot(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 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 from conda-forge.
conda install plonk
This will install the required dependencies. Note: you may need to first add the conda-forge
channel with conda config --add channels conda-forge
. I also recommend strictly using conda-forge which you can do with conda config --set channel_priority true
. 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, please try the following, in order:
- Check the documentation.
- Check the built-in help, e.g.
help(plonk.load_snap)
. - Raise an issue, as a bug report or feature request, using the issue tracker.
Please don't be afraid to raise an issue. Even if your issue is not a bug, it's nice to have the question and answer available in a public forum so we can all learn from it together.
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. All types of contributions are welcome from all types of people with different skill levels.
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.