A framework for likelihood calculations and hypothesis testing using binned events and response matrices.
It is recommended to run this software in an isolated virtual Python
environment. This ensures that all required packages are present in the
tested version and do not interfere with other packages installed on the
system. The environment is managed by uv.
The easiest way to create it is to simply source setup.sh after checking
out the source code:
$ . setup.sh
This will automatically do something along these lines:
$ # Create the virtual environment and install all dependencies $ uv sync --all-extras $ # Activate the environment $ . .venv/bin/activate
It will only create the environment if it does not exist already (and keep it
up to date otherwise). You can select a specific Python version by passing it
on to uv, e.g. . setup.sh -p 3.12. You might need to install
additional system libraries to compile all packages.
ReMU requires Python >=3.11.
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
Run all test cases of the framework with nox (uses the Python versions installed on your system):
$ uv run nox -s tests
Or, inside the environment created by setup.sh, run them directly with
coverage:
$ ./run_tests.sh
Online documentation including examples can be found on the project's readthedocs page:
https://remu.readthedocs.io
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.