dhybridrpy 1.10

A Python package to easily read input + output data from dHybridR.

dhybridrpy

dhybridrpy allows you to easily load and plot data from dHybridR simulations. It provides programmatic access to simulation input and output data and the ability to quickly visualize that data.

Features

• Efficiently access simulation input data and output data like timesteps, fields (e.g., magnetic field), phases (e.g., distribution functions), and particle tracks.
• Quickly plot 1D, 2D, and 3D output data.
• Compute FFT power spectra and 1D spatial averages.
• Follow individual particle trajectories across a simulation.
• Lazily load large datasets using dask.
• Perform arithmetic operations on data objects directly.

Installation

The latest package version can be installed via pip:

pip install dhybridrpy

Usage

Basic usage of the package:

from dhybridrpy import DHybridrpy

# Enter your input file and output folder paths here
input_file = "examples/data/inputs/input"
output_folder = "examples/data/Output"

dpy = DHybridrpy(input_file=input_file, output_folder=output_folder)

# Print simulation timesteps
print(dpy.timesteps())

# Access an input variable
print(f"Timestep = {dpy.inputs['time']['dt']}")

# Access data at a specific timestep
ts = 1
Bx = dpy.timestep(ts).fields.Bx()
print(Bx.data)

# Plot data
import matplotlib.pyplot as plt
Bx.plot()
plt.show()

Further examples can be found in the examples folder and in the online documentation.

CLI Tool: dplot

dplot is a command-line tool for visualizing dHybridR simulation fields and phases across all timesteps, saving PNG images and optionally creating MP4 videos. It is included when you install dhybridrpy.

Discover available data

dplot -i path/to/input

Plot specific fields

dplot -i path/to/input --fields Bx --fields By

Plot phase-space distributions

dplot -i path/to/input --phases p1x1 --species 3

Plot all fields with video output

dplot -i path/to/input --all-fields --video

Key options: --video, --fps, --colormap, --dpi, --vmin/--vmax, --type, --plots-dir, -j (parallel processes), -v (verbose). Large datasets are automatically downsampled to 1080p. See the dplot documentation for full details.

Documentation

Full documentation is available at dhybridrpy.readthedocs.io.

License

Project licensed under the GNU Affero General Public License v3.0. See the LICENSE file for details.

Authors

• Bricker Ostler
• Miha Cernetic