https://github.com/hdembinski/pyik

Python Instrument Kit: A collection of tools for data analysis and plotting
https://github.com/hdembinski/pyik

corsika matplotlib numerical-methods numpy performance plotting python

Last synced: about 1 month ago
JSON representation

Python Instrument Kit: A collection of tools for data analysis and plotting

• Host: GitHub
• URL: https://github.com/hdembinski/pyik
• Owner: HDembinski
• License: bsd-3-clause
• Created: 2017-08-29T12:00:33.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2021-08-26T12:04:02.000Z (about 3 years ago)
• Last Synced: 2024-09-28T09:21:46.881Z (about 2 months ago)
• Topics: corsika, matplotlib, numerical-methods, numpy, performance, plotting, python
• Language: Python
• Size: 77.1 KB
• Stars: 9
• Watchers: 6
• Forks: 4
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.BSD

Awesome Lists containing this project

README

        
# PyIK - The Python Instrument Kit

[![Build Status](https://travis-ci.org/HDembinski/pyik.svg?branch=master)](https://travis-ci.org/HDembinski/pyik)

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