# RECAST for ATLAS
[](https://doi.org/10.5281/zenodo.5854896)
[](https://github.com/recast-hep/recast-atlas/actions/workflows/ci.yml?query=branch%3Amain)
[](https://results.pre-commit.ci/latest/github/recast-hep/recast-atlas/main)
[](https://badge.fury.io/py/recast-atlas)
ATLAS tools to facilitate integration of ATLAS analyses into RECAST
## Getting Started
### Install
`recast-atlas` is installable from PyPI using `pip` inside of your Python virtual environment
```
python -m pip install recast-atlas
```
### CLI API
The `recast-atlas` CLI API:
```
$ recast --help
Usage: recast [OPTIONS] COMMAND [ARGS]...
Options:
-l, --loglevel TEXT
--help Show this message and exit.
Commands:
auth Authentication Commands (to gain access to internal data)
backends The RECAST computational backends.
catalogue The RECAST Analysis Catalogue
ci Helper Commands for CI systems
retrieve Retrieve RECAST Results from asynchronous submissions
run Run a RECAST Workflow synchronously
software Build Container Images for RECAST
status Get the Status of a asynchronous submission
submit Submit a RECAST Workflow asynchronously
tests Run a test
```
### Running RECAST
`recast-atlas` aims to enable both local execution as well as asynchronous execution on a [REANA](http://reana.io) cluster.
#### Local backend
Run the example from the [ATLAS Exotics Rome Workshop 2018][ATLAS Exotics Workshop 2018] using the `local` backend:
```
python -m pip install --upgrade 'recast-atlas[local]'
```
```
recast run examples/rome --backend local
```
#### REANA cluster backend
Asynchronously run the example from the [ATLAS Exotics Rome Workshop 2018][ATLAS Exotics Workshop 2018] using the `reana` backend:
```
python -m pip install --upgrade 'recast-atlas[reana]'
```
```
recast submit examples/rome --backend reana
```
[ATLAS Exotics Workshop 2018]: https://indico.cern.ch/event/710748/contributions/2982534/subcontributions/254796
#### On [LXPLUS9](https://clouddocs.web.cern.ch/clients/lxplus.html)
```console
ssh lxplus9.cern.ch
source ~recast/public/setup.sh
recast catalogue ls
recast run examples/rome
```
Raw data
{
"_id": null,
"home_page": "https://github.com/recast-hep/recast-atlas",
"name": "recast-atlas",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "physics recast atlas",
"author": "Lukas Heinrich",
"author_email": "lukas.heinrich@cern.ch",
"download_url": "https://files.pythonhosted.org/packages/4e/09/ed7a2dc4829200d51f0b514267ebaacb1f2889d40fcf776d65f9f7d820c7/recast_atlas-0.4.0.tar.gz",
"platform": null,
"description": "# RECAST for ATLAS\n\n[](https://doi.org/10.5281/zenodo.5854896)\n\n[](https://github.com/recast-hep/recast-atlas/actions/workflows/ci.yml?query=branch%3Amain)\n[](https://results.pre-commit.ci/latest/github/recast-hep/recast-atlas/main)\n[](https://badge.fury.io/py/recast-atlas)\n\nATLAS tools to facilitate integration of ATLAS analyses into RECAST\n\n## Getting Started\n\n### Install\n\n`recast-atlas` is installable from PyPI using `pip` inside of your Python virtual environment\n\n```\npython -m pip install recast-atlas\n```\n\n### CLI API\n\nThe `recast-atlas` CLI API:\n\n```\n$ recast --help\nUsage: recast [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n -l, --loglevel TEXT\n --help Show this message and exit.\n\nCommands:\n auth Authentication Commands (to gain access to internal data)\n backends The RECAST computational backends.\n catalogue The RECAST Analysis Catalogue\n ci Helper Commands for CI systems\n retrieve Retrieve RECAST Results from asynchronous submissions\n run Run a RECAST Workflow synchronously\n software Build Container Images for RECAST\n status Get the Status of a asynchronous submission\n submit Submit a RECAST Workflow asynchronously\n tests Run a test\n```\n\n### Running RECAST\n\n`recast-atlas` aims to enable both local execution as well as asynchronous execution on a [REANA](http://reana.io) cluster.\n\n#### Local backend\n\nRun the example from the [ATLAS Exotics Rome Workshop 2018][ATLAS Exotics Workshop 2018] using the `local` backend:\n\n```\npython -m pip install --upgrade 'recast-atlas[local]'\n```\n\n```\nrecast run examples/rome --backend local\n```\n\n#### REANA cluster backend\n\nAsynchronously run the example from the [ATLAS Exotics Rome Workshop 2018][ATLAS Exotics Workshop 2018] using the `reana` backend:\n\n```\npython -m pip install --upgrade 'recast-atlas[reana]'\n```\n\n```\nrecast submit examples/rome --backend reana\n```\n\n[ATLAS Exotics Workshop 2018]: https://indico.cern.ch/event/710748/contributions/2982534/subcontributions/254796\n\n#### On [LXPLUS9](https://clouddocs.web.cern.ch/clients/lxplus.html)\n\n```console\nssh lxplus9.cern.ch\nsource ~recast/public/setup.sh\nrecast catalogue ls\nrecast run examples/rome\n```\n",
"bugtrack_url": null,
"license": "Apache",
"summary": "RECAST for ATLAS at the LHC",
"version": "0.4.0",
"project_urls": {
"Documentation": "https://github.com/recast-hep/recast-atlas",
"Homepage": "https://github.com/recast-hep/recast-atlas",
"Issue Tracker": "https://github.com/recast-hep/recast-atlas/issues",
"Source Code": "https://github.com/recast-hep/recast-atlas"
},
"split_keywords": [
"physics",
"recast",
"atlas"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1d1304e78cfd2500ed13d7a6e581b1d47647675c076aa8a53e7ee5392567cf53",
"md5": "8401efe21a71d2a5178c2047709204fb",
"sha256": "939bfb592d167af7e1d65d9d3c6166b9058d1922962f0e63a15eda2cae84a7c2"
},
"downloads": -1,
"filename": "recast_atlas-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8401efe21a71d2a5178c2047709204fb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 30214,
"upload_time": "2024-02-24T00:25:58",
"upload_time_iso_8601": "2024-02-24T00:25:58.740877Z",
"url": "https://files.pythonhosted.org/packages/1d/13/04e78cfd2500ed13d7a6e581b1d47647675c076aa8a53e7ee5392567cf53/recast_atlas-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4e09ed7a2dc4829200d51f0b514267ebaacb1f2889d40fcf776d65f9f7d820c7",
"md5": "613e9c633e225b20b1eb9a74a82c420b",
"sha256": "b297738179c4e7c065d27266c37e7b2527aeb99ac74eea8b87e33cc6428b45fd"
},
"downloads": -1,
"filename": "recast_atlas-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "613e9c633e225b20b1eb9a74a82c420b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 22506,
"upload_time": "2024-02-24T00:25:59",
"upload_time_iso_8601": "2024-02-24T00:25:59.881501Z",
"url": "https://files.pythonhosted.org/packages/4e/09/ed7a2dc4829200d51f0b514267ebaacb1f2889d40fcf776d65f9f7d820c7/recast_atlas-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-24 00:25:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "recast-hep",
"github_project": "recast-atlas",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "recast-atlas"
}
JSON
