Metadata-Version: 2.1
Name: funfolding
Version: 0.3.0
Summary: Having fun with unfolding.
Home-page: https://github.com/tudo-astroparticlephysics/funfolding
Author: Mathis Boerner
Author-email: mathis.boerner@tu-dortmund.de
License: MIT
Keywords: unfolding
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >= 3.9, <3.12a0
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: corner
Requires-Dist: emcee >=3.0
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: pymc3
Requires-Dist: scikit-learn >=0.19.0
Requires-Dist: scipy
Provides-Extra: all
Requires-Dist: pytest ; extra == 'all'
Requires-Dist: sphinx ; extra == 'all'
Requires-Dist: sphinx-rtd-theme ; extra == 'all'
Provides-Extra: docs
Requires-Dist: sphinx ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Provides-Extra: tests
Requires-Dist: pytest ; extra == 'tests'

# FUNFOLDING [![Build Status](https://travis-ci.com/tudo-astroparticlephysics/funfolding.svg?branch=master)](https://travis-ci.com/tudo-astroparticlephysics/funfolding) [![PyPI version](https://badge.fury.io/py/funfolding.svg)](https://badge.fury.io/py/funfolding)

```
         _____
     _-~~     ~~-_//
   /~             ~\
  |              _  |_
 |         _--~~~ )~~ )___
\|        /   ___   _-~   ~-_
\          _-~   ~-_         \
|         /         \         |
|        |           |     (O  |
 |      |             |        |
 |      |   O)        |       |
 /|      |           |       /
 / \ _--_ \         /-_   _-~)
   /~    \ ~-_   _-~   ~~~__/
  |   |\  ~-_ ~~~ _-~~---~  \
  |   | |    ~--~~  / \      ~-_
   |   \ |                      ~-_
    \   ~-|                        ~~--__ _-~~-,
     ~-_   |                             /     |
        ~~--|                                 /
          |  |                               /
          |   |              _            _-~
          |  /~~--_   __---~~          _-~
          |  \                   __--~~
          |  |~~--__     ___---~~
          |  |      ~~~~~
          |  |

```

Python library to perform spectral unfoldings.

## Getting Started



### Prerequisites

The prerequesites are handled by the `setup.py`, if you are using conda, you might
want to install the available packages via `conda` first.
```
matplotlib
numpy
pymc3
scikit-learn>=0.19.0
scipy
```

### Installing

Install via pip:

```
pip install funfolding
```

## Running the tests

The package has some basic unit tests. You can test them by

```
python setup.py test

```

Another way to test the installation is to run the examples from the examples folder.
