Skip to content

recast-hep/recast-atlas

Repository files navigation

RECAST for ATLAS

DOI

CI pre-commit.ci status PyPI version

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 cluster.

Local backend

Run the example from the ATLAS Exotics Rome 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 using the reana backend:

python -m pip install --upgrade 'recast-atlas[reana]'
recast submit examples/rome --backend reana
ssh lxplus9.cern.ch
source ~recast/public/setup.sh
recast catalogue ls
recast run examples/rome