# gammaLoop
*Computation of differential cross-sections using Local Unitarity.*
See [www.alphaloop.ch](www.alphaloop.ch) for details on the theoretical framework and related literature.
See the [wiki](https://wiki.alphaloop.ch/) 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](https://www.rust-lang.org/tools/install)
* `Python3`: v3.10+
* `gcc`: v10+
*Note*: The project has been tested on Linux and MacOS.
Windows users are encouraged to use [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/).
### > 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:
1. Preferred method is through the Python command-line interface `gammaloop`.
2. Alternatively, the same functionalities can be accessed programmatically, e.g. in a Jupyter notebook, through the Python API, by importing the `gammaloop` library.
3. 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](https://wiki.alphaloop.ch/) 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](https://wiki.alphaloop.ch/) and by running:
```
./bin/gammaloop_rust_cli --help
```
Raw data
{
"_id": null,
"home_page": null,
"name": "gammaloop",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "physics, collider, cross-section, perturbative, loop",
"author": "Valentin Hirschi <valentin.hirschi@gmail.com>",
"author_email": "Valentin Hirschi <valentin.hirschi@gmail.com>, Mathijs Fraaije <mathijsfraaije@gmail.com>, Lucien Huber <mail@lcnbr.ch>",
"download_url": "https://files.pythonhosted.org/packages/2c/d6/f6b3f8f5402f3993eefb0036ef79c5952d4803db566192b2fd087d7bcfa2/gammaloop-0.1.0.tar.gz",
"platform": null,
"description": "# gammaLoop\n\n\n*Computation of differential cross-sections using Local Unitarity.*\n\nSee [www.alphaloop.ch](www.alphaloop.ch) for details on the theoretical framework and related literature.\n\nSee the [wiki](https://wiki.alphaloop.ch/) for more information on the project.\n\n## TL;DR: I want to be running \u03b3Loop already!\n\nWe salute the eagerness of our users.\n\nIf you want to jump right in, run the following to immediately start integrating the scalar three-loop mercedes diagram!\n\n```\ngit clone https://github.com/alphal00p/gammaloop.git && cd gammaloop\n./bin/compile.sh\nsource python/gammaloop/dependencies/venv/bin/activate\n./bin/gammaloop example/cards/scalar_mercedes.gL\n```\n\n## Installation\n\n### > Requirements\n\n* `Rust`: You can easily instal Rust with this [one-liner](https://www.rust-lang.org/tools/install)\n\n* `Python3`: v3.10+\n\n* `gcc`: v10+\n\n*Note*: The project has been tested on Linux and MacOS. \n\nWindows users are encouraged to use [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/).\n\n### > Installation using `pip`\n```\npip install gammaloop\ngammaloop --build_dependencies\nsource `gammaloop -venv`\n```\n\n*Note:* when using the `fish` shell, the last command should be replaced by: `. (./bin/gammaloop -venv).fish`\n\n### > Installation from sources\n```\ngit clone https://github.com/alphal00p/gammaloop.git\ncd gammaloop\n./bin/compile.sh\nsource python/gammaloop/dependencies/venv/bin/activate\n```\nThe relevant binaries will then be in `./bin/` and the gammaloop python module is located at `./python/gammaloop`.\n\n## Tests\n\n### > Testing an installation from `pip`\n\nTesting your installation can be done by running\n```\npython -m pytest\n```\nfrom within the installation directory of the gammaloop module, which you can `cd` into with e.g.:\n```\nbash -c 'cd `python -c \"import os; import gammaloop; print(os.path.dirname(gammaloop.__file__))\"`; pwd'\n```\n\n### > Testing an installation from sources\n\nRun:\n```\n/bin/run_tests.sh python\n/bin/run_tests.sh rust\n```\n\n## Usage\n\nThere are three entry points to the `GammaLoop` functionalities:\n\n1. Preferred method is through the Python command-line interface `gammaloop`.\n\n2. Alternatively, the same functionalities can be accessed programmatically, e.g. in a Jupyter notebook, through the Python API, by importing the `gammaloop` library.\n\n3. Finally, expert users may also find it useful to steer some of functionalities directly from the rust binary `gammaloop_rust_cli`.\n\nBoth executables `gammaloop` and `gammaloop_rust_cli` are made available as scripts in the `bin` directory.\nThe `gammaloop` Python module is also exposed after installation and ready to be imported in user custom Python scripts.\n\n### 1. Usage from the Python command-line interface: ./gammaloop\n\n`GammaLoop` is typically used through the python command-line interface `gammaloop`.\nPlace your list of commands in a file named e.g. `cmd.gL`, for instance:\n\n```\n# Content of file 'cmd.gL'\nimport_model sm --format ufo\nexport_model ./sm.yaml --format yaml\n```\nand run it with:\n```\n./gammaloop cmd.gL\n```\nYou can find more information on the syntax of the available commands in the [wiki](https://wiki.alphaloop.ch/) and by running:\n```\n./gammaloop --help\n```\nto get an overview of available commands and:\n```\n./bin/gammaloop -c \"help import_model\"\n```\nto get help on any specific command.\n\nYou can find example of command files in the `<MODULE_PATH>/data/run_cards/` directory.\n\n### 2. Usage from within a Jupyter notebook: the Python API\n\nFollow the example jupyter notebook given in example to get started with the Python API.\n```\ncd <GAMMALOOP_INSTALLATION_DIRECTORY>/examples/jupyter\njupyter notebook steer_gammaloop.ipynb\n``` \n\n### 3. Usage from the rust binary executable: ./gammaloop_rust_cli\n\nAll typical usecases of `GammaLoop` are available through the Python command-line interface mentioned earlier.\nHowever, expert users might want to steer the Monte-Carlo integration directly using the `gammaloop_rust_cli` binary.\nThis is possible throught the `gammaloop_rust_cli` binary, which can be used as follows:\n```\n./bin/gammaloop_rust_cli --config <MODULE_PATH>/gammaloop/data/run_cards/rust_run_config.yaml\n```\n*Note*: You have to manually define your desired external momenta in this default `rust_run_config.yaml` file.\n\nYou will find more information on the content of the run configuration file and steering options in the [wiki](https://wiki.alphaloop.ch/) and by running:\n```\n./bin/gammaloop_rust_cli --help\n```\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Gammaloop computes differential cross-sections using Local Unitarity",
"version": "0.1.0",
"project_urls": {
"homepage": "https://alphaloop.ch",
"repository": "https://github.com/alphal00p/gammaloop"
},
"split_keywords": [
"physics",
" collider",
" cross-section",
" perturbative",
" loop"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "a455746b1aedb6385f97348b19f916bcee434026c9a641d48994b86cb5d8b9b2",
"md5": "1316c9700827ac3ea214619978b1ff2c",
"sha256": "646e0451f96d040a88b81f8b799700eb53043809fe3c44090d98cd9cafbb0086"
},
"downloads": -1,
"filename": "gammaloop-0.1.0-cp311-cp311-macosx_10_12_x86_64.whl",
"has_sig": false,
"md5_digest": "1316c9700827ac3ea214619978b1ff2c",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": null,
"size": 6182069,
"upload_time": "2024-04-02T23:02:49",
"upload_time_iso_8601": "2024-04-02T23:02:49.595776Z",
"url": "https://files.pythonhosted.org/packages/a4/55/746b1aedb6385f97348b19f916bcee434026c9a641d48994b86cb5d8b9b2/gammaloop-0.1.0-cp311-cp311-macosx_10_12_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "2cd6f6b3f8f5402f3993eefb0036ef79c5952d4803db566192b2fd087d7bcfa2",
"md5": "5c12e100a2677511f6292131e302dc3e",
"sha256": "29a7a61bc3bf5c5d9a9901d3acc86e36509ed478f91242d3cd049234f02af316"
},
"downloads": -1,
"filename": "gammaloop-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "5c12e100a2677511f6292131e302dc3e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 986478,
"upload_time": "2024-04-02T23:02:53",
"upload_time_iso_8601": "2024-04-02T23:02:53.890874Z",
"url": "https://files.pythonhosted.org/packages/2c/d6/f6b3f8f5402f3993eefb0036ef79c5952d4803db566192b2fd087d7bcfa2/gammaloop-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-02 23:02:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "alphal00p",
"github_project": "gammaloop",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "gammaloop"
}
JSON
