Skip to main content

Response Matrix Utilities for likelihood calculations and hypothesis testing

Project description

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

[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. The easiest way to do so, is to simply source setup.sh after checking out the source code:

$ . setup.sh

This will automatically do something along these lines:

$ # 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 .

It will only create a new virtual environment if one does not exist already. You can also specify which Python version to use by providing the respective virtualenv argument to setup.sh, e.g. . setup.sh -p python3. You might need to install additional system libraries to compile all packages.

ReMU requires Python >=3.7.

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:

https://remu.readthedocs.io

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

remu-0.8.0.tar.gz (24.6 MB view details)

Uploaded Source

Built Distribution

remu-0.8.0-py3-none-any.whl (60.6 kB view details)

Uploaded Python 3

File details

Details for the file remu-0.8.0.tar.gz.

File metadata

  • Download URL: remu-0.8.0.tar.gz
  • Upload date:
  • Size: 24.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for remu-0.8.0.tar.gz
Algorithm Hash digest
SHA256 e5a291ec4499528294a2b0908164e6e774a100dfe163e712b0eca6cc65e16e2c
MD5 cdb0f4d67d7f66fdded85f65a415454d
BLAKE2b-256 271a5835f5369f1a6b7dcf990b8c7f173a893497cc750a33524913903c43e346

See more details on using hashes here.

File details

Details for the file remu-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: remu-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 60.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for remu-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c0436260934d2e1f89efa825cefc374d65d0bf5d1dc5b793766343be04939e25
MD5 2fcfef07aff14b66a037f5d32a47828c
BLAKE2b-256 5b42f56eadec45cea84dc2af842ed2c301580b758fdc67901786ac700d8d9634

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page