Metadata-Version: 2.1
Name: showerpipe
Version: 0.3.0
Summary: Data pipeline tools for particle shower and hadronisation.
Author: Jacan Chaplais
Maintainer: Jacan Chaplais
License: BSD 3-Clause License
        
        Copyright (c) 2021, Jacan Chaplais.
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        * Redistributions of source code must retain the above copyright notice, this
          list of conditions and the following disclaimer.
        
        * Redistributions in binary form must reproduce the above copyright notice,
          this list of conditions and the following disclaimer in the documentation
          and/or other materials provided with the distribution.
        
        * Neither the name of the showerpipe package developers nor the names of its
          contributors may be used to endorse or promote products derived from
          this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: repository, https://github.com/jacanchaplais/showerpipe
Project-URL: documentation, https://showerpipe.readthedocs.io
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
Provides-Extra: dev
License-File: LICENSE.txt

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
------------

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:

.. code:: bash

   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:

.. code:: bash

   conda env create -f environment.yml

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

.. code:: bash

   conda env update -f environment.yml --prune

With existing Pythia installation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Simply:

.. code:: bash

   pip install showerpipe

.. |PyPI version| image:: https://img.shields.io/pypi/v/showerpipe.svg
   :target: https://pypi.org/project/showerpipe/
.. |Tests| image:: https://github.com/jacanchaplais/showerpipe/actions/workflows/tests.yml/badge.svg
.. |Documentation| image:: https://readthedocs.org/projects/showerpipe/badge/?version=latest
   :target: https://showerpipe.readthedocs.io
.. |License| image:: https://img.shields.io/pypi/l/showerpipe
   :target: https://raw.githubusercontent.com/jacanchaplais/showerpipe/main/LICENSE.txt
.. |Code style: black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/psf/black
