Gammaloop computes differential cross-sections using Local Unitarity
Project description
gammaLoop
Computation of differential cross-sections using Local Unitarity.
See www.alphaloop.ch for details on the theoretical framework and related literature.
See the wiki for more information on the project.
TL;DR: I want to be running γLoop already!
We salute the eagerness of our users.
If you want to jump right in, run the following to immediately start integrating the scalar three-loop mercedes diagram!
git clone https://github.com/alphal00p/gammaloop.git && cd gammaloop
./bin/compile.sh
source python/gammaloop/dependencies/venv/bin/activate
./bin/gammaloop example/cards/scalar_mercedes.gL
Installation
> Requirements
-
Rust
: You can easily instal Rust with this one-liner -
Python3
: v3.10+ -
gcc
: v10+
Note: The project has been tested on Linux and MacOS.
Windows users are encouraged to use WSL 2.
> Installation using pip
pip install gammaloop
gammaloop --build_dependencies
source `gammaloop -venv`
Note: when using the fish
shell, the last command should be replaced by: . (./bin/gammaloop -venv).fish
> Installation from sources
git clone https://github.com/alphal00p/gammaloop.git
cd gammaloop
./bin/compile.sh
source python/gammaloop/dependencies/venv/bin/activate
The relevant binaries will then be in ./bin/
and the gammaloop python module is located at ./python/gammaloop
.
Tests
> Testing an installation from pip
Testing your installation can be done by running
python -m pytest
from within the installation directory of the gammaloop module, which you can cd
into with e.g.:
bash -c 'cd `python -c "import os; import gammaloop; print(os.path.dirname(gammaloop.__file__))"`; pwd'
> Testing an installation from sources
Run:
/bin/run_tests.sh python
/bin/run_tests.sh rust
Usage
There are three entry points to the GammaLoop
functionalities:
-
Preferred method is through the Python command-line interface
gammaloop
. -
Alternatively, the same functionalities can be accessed programmatically, e.g. in a Jupyter notebook, through the Python API, by importing the
gammaloop
library. -
Finally, expert users may also find it useful to steer some of functionalities directly from the rust binary
gammaloop_rust_cli
.
Both executables gammaloop
and gammaloop_rust_cli
are made available as scripts in the bin
directory.
The gammaloop
Python module is also exposed after installation and ready to be imported in user custom Python scripts.
1. Usage from the Python command-line interface: ./gammaloop
GammaLoop
is typically used through the python command-line interface gammaloop
.
Place your list of commands in a file named e.g. cmd.gL
, for instance:
# Content of file 'cmd.gL'
import_model sm --format ufo
export_model ./sm.yaml --format yaml
and run it with:
./gammaloop cmd.gL
You can find more information on the syntax of the available commands in the wiki and by running:
./gammaloop --help
to get an overview of available commands and:
./bin/gammaloop -c "help import_model"
to get help on any specific command.
You can find example of command files in the <MODULE_PATH>/data/run_cards/
directory.
2. Usage from within a Jupyter notebook: the Python API
Follow the example jupyter notebook given in example to get started with the Python API.
cd <GAMMALOOP_INSTALLATION_DIRECTORY>/examples/jupyter
jupyter notebook steer_gammaloop.ipynb
3. Usage from the rust binary executable: ./gammaloop_rust_cli
All typical usecases of GammaLoop
are available through the Python command-line interface mentioned earlier.
However, expert users might want to steer the Monte-Carlo integration directly using the gammaloop_rust_cli
binary.
This is possible throught the gammaloop_rust_cli
binary, which can be used as follows:
./bin/gammaloop_rust_cli --config <MODULE_PATH>/gammaloop/data/run_cards/rust_run_config.yaml
Note: You have to manually define your desired external momenta in this default rust_run_config.yaml
file.
You will find more information on the content of the run configuration file and steering options in the wiki and by running:
./bin/gammaloop_rust_cli --help
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for gammaloop-0.1.0-cp311-cp311-macosx_10_12_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 646e0451f96d040a88b81f8b799700eb53043809fe3c44090d98cd9cafbb0086 |
|
MD5 | 1316c9700827ac3ea214619978b1ff2c |
|
BLAKE2b-256 | a455746b1aedb6385f97348b19f916bcee434026c9a641d48994b86cb5d8b9b2 |