pymchelper

pymchelper is a toolkit for aiding users of the particle transport codes, such as FLUKA and SHIELD-HIT12A. Particle transport codes produce binary files (especially when running on dedicated computing clusters). It provides a command line program convertmc which can convert these binary files to graphs:

convertmc image --many "*.bdo"

This converter is capable of converting binary output to many other formats, like CSV, XLS or HDF.

Another feature of the toolkit is a command line utility runmc which speeds up particle transport simulation by splitting the calculation on multiple processes and merging the results

runmc --jobs 16 --out-type txt directory_with_input_files

Toolkit can also serve as a library in Python language, which can be used by programmers and data scientists to read data from binary files into convenient Python objects. This allows further data processing using other Python tools and libraries.

pymchelper works under Linux, Windows and Mac OSX operating systems.

Installation

To install pymchelper as a python package, type:

pip install pymchelper[full]

On Linux systems from Debian family pymchelper can be installed using apt package manager with couple of commands::

wget --quiet --output-document - https://datamedsci.github.io/deb_package_repository/public.gpg | sudo apt-key add -

sudo wget --quiet --output-document /etc/apt/sources.list.d/datamedsci.list https://datamedsci.github.io/deb_package_repository/datamedsci.list

sudo apt update

sudo apt install pymchelper

Documentation

---

Full pymchelper documentation can be found here: https://datamedsci.github.io/pymchelper/index.html

See Getting Started for installation and basic information, and the User's Guide for an overview of how to use the project.