PyIK - The Python Instrument Kit

This package provides tools to simplify common analysis tasks in particle physics. The main goal is to provide functionality which is currently missing in numpy, scipy, and matplotlib.

The tools are grouped by topic into several modules which are listed below. Most of them depend on external modules which are not shipped with Python. The respective dependencies are also listed.

Installation

PyIK supports Python2 and Python3. Install it with pip.

pip install pyik

Optional: If you want to use the fitting routines in PyIK, you need libnlopt. Installation instructions are here http://ab-initio.mit.edu/wiki/index.php/NLopt#Download_and_installation pip install nlopt may also work

Documentation

PyIK uses the Python self-documentation system. In the Python interpreter, execute "help()", followed by "pyik" or "pyik.numpyext", for example.

Please submit an issue via GitHub if you find issues. Pull requests are also welcome.

Content

• corsika: Tools to work with CORSIKA files
• ellipse: Fast and robust fit of an ellipse to noisy data
• fit: Classes and functions for function minimization Requires nlopt
• locked_shelve: Functionality to read shelve files and prevent write collisions
• misc: Miscellanious helper functions/classes that cannot be grouped into any of the other submodules
• mplext: Missing plotting tools in matplotlib Requires matplotlib
• numpyext: Missing numerical tools in numpy Requires numpy, scipy
• performance: Tools to increase performance (e.g. the cached decorator and pmap for easy parallelization)
• rootext: Convert Python to ROOT objects and vice-versa Requires ROOT
• time_conversion: Contains tools to convert between UTC and GPS

Notes

The example folder contains working examples to copy-paste from.

Authors

• Ariel Bridgeman
• Hans Dembinski (maintainer)
• Benjamin Fuchs
• Detlef Maurel
• Daniela Mockler
• Alexander Schulz
• Felix Werner