showerpipe 0.1.0

Data pipeline tools for particle shower and hadronisation.

showerpipe

Provides a Pythonic data pipeline for showering and hadronisation programs in HEP.

Currently wraps interface for Pythia 8, with plans for Herwig and Ariadne in future releases.

Installation

This package requires Pythia 8 to be installed on your system, and available in your PYTHONPATH.

It also requires the PYTHIA8DATA environment variable to be set. This is the path to the xmldoc/ directory under Pythia's share directory. You can do something like this in your shell config:

export PYTHIA8DATA=/home/$USER/pythia82xx/share/Pythia8/xmldoc

Without an existing Pythia installation (using conda)

If this is not already the case, a very convenient solution is to install it via conda. This is fast, and automatically sets the PYTHIA8DATA environment variable when you activate the virtual environment. An environment file is provided in the root of this repo, which will install all requirements and then showerpipe, automatically. The virtual environment can be created using:

conda env create -f environment.yml

If you have an existing conda environment, you can update it by activating the environment and then using:

conda env update -f environment.yml --prune

With existing Pythia installation

Simply:

pip install showerpipe