Skip to main content

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.

Metadata

Release files for remu 0.8.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for remu 0.8.0
File Size Uploaded
remu-0.8.0.tar.gz 24.6 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for remu 0.8.0
File Interpreter ABI Platform
remu-0.8.0-py3-none-any.whl Python 3 none any Details

Total release size: 24.7 MB

Release files / remu-0.8.0.tar.gz

Download URL remu-0.8.0.tar.gz
Size 24.6 MB
Tags Source
SHA-256 checksum
How to use checksums
e5a291ec4499528294a2b0908164e6e774a100dfe163e712b0eca6cc65e16e2c
BLAKE2b-256 checksum
How to use checksums
271a5835f5369f1a6b7dcf990b8c7f173a893497cc750a33524913903c43e346
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.16

Release files / remu-0.8.0-py3-none-any.whl

Download URL remu-0.8.0-py3-none-any.whl
Size 60.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c0436260934d2e1f89efa825cefc374d65d0bf5d1dc5b793766343be04939e25
BLAKE2b-256 checksum
How to use checksums
5b42f56eadec45cea84dc2af842ed2c301580b758fdc67901786ac700d8d9634
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.16

Release history Release notifications | RSS feed

This release

0.8.0 This release

2 release files

0.7.0

2 release files

0.6.0

2 release files

0.5.1

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page