Welcome to pyharm’s documentation!¶
This is the documentation for pyharm, a Python package for analyzing GRMHD results. Specifically, pyharm is a library for reading, plotting, and analyzing the output of GRMHD codes implemented in the style of HARM Gammie et. al. (2003), written in Python. It includes tools for working with the output from several GRMHD codes, notably the iharm3d and KHARMA HDF5 output formats.
pyharm is centered around the pyharm.fluid_dump.FluidDump object, which corresponds to a particular GRMHD output file, but allows accessing a bunch of additional derived properties as though they were members of the file, by calculating & caching them on the fly. This is used extensively by the included scripts to allow plotting many different variables simply by specifying them on the
command line.
You might want to start with the documentation on the different Keys that are supported directly by FluidDump, or on the available Figures and Finished Plots and Analysis Packages functions, which can provide a template for any plotting and reductions. Anything added to these files can automatically be parallelized and controlled with the pyharm-movie and pyharm-analysis scripts.
This documentation sometimes lags development, feel free to submit bugs at the GitHub page when things don’t work as described.
