https://github.com/jrbourbeau/pyunfold
Raw File
Tip revision: 0b50d43d17380d2663c3d1a8c3356fadde4917aa authored by James Bourbeau on 19 November 2018, 04:50:42 UTC
Version 0.5.0 release (#104)
Tip revision: 0b50d43
README.md
# PyUnfold

[![Build Status](https://travis-ci.org/jrbourbeau/pyunfold.svg?branch=master)](https://travis-ci.org/jrbourbeau/pyunfold)
[![Build status](https://ci.appveyor.com/api/projects/status/wphmmposuctye5ye/branch/master?svg=true)](https://ci.appveyor.com/project/jrbourbeau/pyunfold/branch/master)
[![codecov](https://codecov.io/gh/jrbourbeau/pyunfold/branch/master/graph/badge.svg)](https://codecov.io/gh/jrbourbeau/pyunfold)
[![pypi version](https://img.shields.io/pypi/v/pyunfold.svg 'pypi version')](https://pypi.org/project/PyUnfold/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyunfold.svg)](https://pypi.org/project/PyUnfold/)
[![DOI](http://joss.theoj.org/papers/10.21105/joss.00741/status.svg)](https://doi.org/10.21105/joss.00741)
[![license](https://img.shields.io/pypi/l/pyunfold.svg 'license')](https://github.com/jrbourbeau/pyunfold/blob/master/LICENSE)


PyUnfold is a Python package for implementing iterative unfolding.


## Documentation

The documentation for PyUnfold can be found at https://jrbourbeau.github.io/pyunfold/


## Installation

PyUnfold can be installed using `pip`

```
pip install pyunfold
```

or `conda`

```
conda install -c conda-forge pyunfold
```

For more information see the [installation instructions](https://jrbourbeau.github.io/pyunfold/installation.html) in the [documentation](https://jrbourbeau.github.io/pyunfold/).


## Citation

If you find PyUnfold useful in your work, please consider [citing it](https://jrbourbeau.github.io/pyunfold/citing.html).


## License

[MIT License](LICENSE)

Copyright (c) 2018 James Bourbeau and Zigfried Hampel-Arias
back to top