ReMU - Response Matrix Utilities

Summary

A framework for likelihood calculations and hypothesis testing using binned events and response matrices.

[Travis-CI] [Documentation] [Coverage] [license: MIT] [DOI: 10.5281/zenodo.1217572]

Setup

Installing development version from source

It is recommended to run this software in a virtual Python environment (virtualenv). This ensures that all required packages are present in the tested version and do not interfere with other packages installed on the system. So after checking out the source code, run these commands:

$ # Create a new virtual environment
$ virtualenv ENV
$ # Activate the environment
$ . ENV/bin/activate
$ # Upgrade pip to the latest version (optional)
$ pip install --upgrade pip
$ # Install all required packages
$ pip install -r requirements.txt
$ # Install actual package
$ pip install -e .

Or you can just source the provided setup.sh. It will do these steps for you:

$ . setup.sh

You might need to install additional system libraries to compile all packages.

ReMU requires Python 2.7 or >=3.4.

Installing official releases with pip

Alternatively you can install official releases directly with pip:

$ # Create a new virtual environment
$ virtualenv ENV
$ # Activate the environment
$ . ENV/bin/activate
$ # Upgrade pip to the latest version (optional)
$ pip install --upgrade pip
$ # Install remu and its dependencies
$ pip install remu==1.0.0

If you want to make sure the optional dependencies are also installed, use pip’s ‘Extras’ syntax:

$ # install remu including all optional dependencies
$ pip install remu[mcmc]==1.0.0

Tests

Run all test cases of the framework:

$ pip install -r test-requirements.txt
$ ./run_tests.sh

Online documentation

Online documentation including examples can be found on the project’s readthedocs page:

Citing

If you use ReMU in a publication, please cite it as follows:

L. Koch, ReMU - Response Matrix Utilities, http://github.com/ast0815/remu, doi:10.5281/zenodo.1217572

Or just use the DOI and let your bibliography manager handle the rest for you. You can cite specific versions of the software too. Just follow the link behind the DOI badge and choose the DOI specific for the release.