Welcome to showerpipe’s documentation!

showerpipe

PyPI version Tests Documentation License Code style: black

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

The easiest solution is to just install via conda:

conda install -c jacanchaplais showerpipe

Pythia will be included as a dependency, and all relevant paths and environment variables will be properly set.

Using existing Pythia installation

If Pythia 8 is already installed on your system, and available in your PYTHONPATH, you can just install this package via pip.

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

With everything set up properly, simply run:

pip install showerpipe

Index


Last update: Oct 23, 2023