Data

Tools

Indexes

Applications

Experiments

Open Source Science

recast-atlas

CLI for ATLAS RECAST contributors

https://github.com/recast-hep/recast-atlas

Science Score: 77.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 2 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ✓
    Committers with academic emails
    1 of 5 committers (20.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.1%) to scientific vocabulary

Keywords

recast

Keywords from Contributors

jax asymptotic-formulas closember cls frequentist-statistics hep hep-ex high-energy-physics histfactory scikit-hep
Last synced: 6 months ago · JSON representation ·

Repository

CLI for ATLAS RECAST contributors

Basic Info
  • Host: GitHub
  • Owner: recast-hep
  • License: apache-2.0
  • Language: Python
  • Default Branch: main
  • Homepage: https://recast.docs.cern.ch/
  • Size: 618 KB
Statistics
  • Stars: 7
  • Watchers: 3
  • Forks: 5
  • Open Issues: 27
  • Releases: 8
Topics
recast
Created over 7 years ago · Last pushed 8 months ago
Metadata Files
Readme Contributing License Code of conduct Citation

README.md

RECAST for ATLAS

DOI

CI pre-commit.ci status PyPI version

Ruff

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.

Docker backend

Example: Run the example from the ATLAS Exotics Rome Workshop 2018 using the (default) docker backend.

Install recast-atlas from PyPI

python -m pip install --upgrade recast-atlas coolname

Submit the RECAST workflow, orchestrated in a recast/recastatlas Docker container

recast run examples/rome --backend docker --tag "docker-$(coolname 2)"

Local backend

Example: Run the example from the ATLAS Exotics Rome Workshop 2018 using the local backend.

Install recast-atlas with the local extra

python -m pip install --upgrade 'recast-atlas[local]' coolname

Submit the RECAST workflow to run locally

PACKTIVITY_DOCKER_CMD_MOD="-u root" recast run examples/rome --backend local --tag "local-$(coolname 2)"

The local backend orchestrates the workflow graph locally, but note that the different workflow steps still run in Linux containers.

REANA cluster backend

Example: Asynchronously run the example from the ATLAS Exotics Rome Workshop 2018 using the reana backend.

Install recast-atlas with the reana extra

python -m pip install --upgrade 'recast-atlas[reana]' coolname

Authenticate to use the REANA cluster (remember to clean up later with eval $(recast auth destroy))

```

Set these variables to your personal secret values

export RECASTAUTHUSERNAME="" export RECASTAUTHPASSWORD="" export RECASTAUTHTOKEN=""

eval "$(recast auth setup -a ${RECASTAUTHUSERNAME} -a ${RECASTAUTHPASSWORD} -a ${RECASTAUTHTOKEN} -a default)" eval "$(recast auth write --basedir authdir)"

export REANASERVERURL=https://reana.cern.ch export REANAACCESSTOKEN="" ```

Submit the RECAST workflow to the REANA cluster

``` reanatag="reana-$(coolname 2)" recast submit examples/rome --backend reana --tag "${reanatag}"

REANA_WORKON sets the workflow automatically

export REANAWORKON="recast-${reanatag}" ```

Monitor the state of the workflow on REANA

``` reana-client status

or if REANA_WORKON not set

reana-client status --workflow ""

```

Download the results after the workflow succeeds

``` reana-client download statanalysis --output-directory output

or if REANA_WORKON not set

reana-client download statanalysis --workflow "" --output-directory output

```

Clean up the environment of personal information in environmental variables

eval $(recast auth destroy)

On LXPLUS9

console ssh lxplus9.cern.ch source ~recast/public/setup.sh recast catalogue ls recast run examples/rome

Owner

  • Name: The RECAST Project
  • Login: recast-hep
  • Kind: organization

Extending the results of high energy physics experiments with reusable workflows.

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "Please cite the following works when using this software."
type: software
authors:
- family-names: "Heinrich"
  given-names: "Lukas"
  orcid: "https://orcid.org/0000-0002-4048-7584"
  affiliation: "Technical University of Munich"
- family-names: "Feickert"
  given-names: "Matthew"
  orcid: "https://orcid.org/0000-0003-4124-7862"
  affiliation: "University of Wisconsin-Madison"
title: "recast-atlas: v0.4.2"
version: 0.4.2
doi: 10.5281/zenodo.5854896
repository-code: "https://github.com/recast-hep/recast-atlas/releases/tag/v0.4.2"
url: "https://github.com/recast-hep/recast-atlas/"
keywords:
  - python
  - physics
  - RECAST
  - ATLAS
  - reinterpretation
  - analysis reuse
license: "Apache-2.0"
references:
  - type: article
    authors:
    - family-names: "Cranmer"
      given-names: "Kyle"
      orcid: "https://orcid.org/0000-0002-5769-7094"
      affiliation: "New York University"
    - family-names: "Yavin"
      given-names: "Itay"
      affiliation: "New York University"
    title: "RECAST: Extending the Impact of Existing Analyses"
    doi: 10.1007/JHEP04(2011)038
    url: "https://doi.org/10.1007/JHEP04(2011)038"
    year: 2011
    publisher:
      name: "Springer"
    volume: 2011
    number: 38
    pages: 2823
    journal: Journal of High Energy Physics

GitHub Events

Total
  • Delete event: 3
  • Issue comment event: 2
  • Push event: 4
  • Pull request review event: 1
  • Pull request event: 5
  • Create event: 3
Last Year
  • Delete event: 3
  • Issue comment event: 2
  • Push event: 4
  • Pull request review event: 1
  • Pull request event: 5
  • Create event: 3

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 264
  • Total Committers: 5
  • Avg Commits per committer: 52.8
  • Development Distribution Score (DDS): 0.223
Top Committers
Name Email Commits
Lukas Heinrich l****h@g****m 205
Matthew Feickert m****t@c****h 51
pre-commit-ci[bot] 6****]@u****m 5
Lukas Heinrich l****h@l****l 2
GitHub Action a****n@g****m 1
Committer Domains (Top 20 + Academic)
github.com: 1 cern.ch: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 43
  • Total pull requests: 121
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 5 days
  • Total issue authors: 7
  • Total pull request authors: 5
  • Average comments per issue: 1.51
  • Average comments per pull request: 0.43
  • Merged pull requests: 111
  • Bot issues: 0
  • Bot pull requests: 27
Past Year
  • Issues: 0
  • Pull requests: 9
  • Average time to close issues: N/A
  • Average time to close pull requests: about 1 month
  • Issue authors: 0
  • Pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.44
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 9
View more stats
Top Authors
Issue Authors
  • matthewfeickert (21)
  • lukasheinrich (8)
  • danikam (6)
  • ntadej (4)
  • Nollde (2)
  • LittlePawer (1)
  • robinnewhouse (1)
Pull Request Authors
  • matthewfeickert (87)
  • lukasheinrich (28)
  • dependabot[bot] (27)
  • pre-commit-ci[bot] (17)
  • danikam (1)
Top Labels
Issue Labels
bug (10) enhancement (4) reana (4) ci (2) docs (2) upstream (2) chore (1) question (1) build (1) API (1) tests (1)
Pull Request Labels
ci (35) github-actions (24) dependencies (24) chore (20) docs (19) fix (15) build (14) enhancement (8) docker (7) reana (4) deploy (2) refactor (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 95 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 31
  • Total maintainers: 3
pypi.org: recast-atlas

RECAST for ATLAS at the LHC

  • Versions: 31
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 95 Last month
Rankings
Dependent packages count: 10.1%
Forks count: 14.2%
Average: 18.1%
Dependent repos count: 21.6%
Stargazers count: 21.6%
Downloads: 22.8%
Maintainers (3)
lukasheinrich matthewfeickert recast
Last synced: 7 months ago

Dependencies

deploy/recast-atlas-0.1.8-requirements.txt pypi
  • adage ==0.10.1
  • kubernetes ==9.0.0
  • packtivity ==0.14.23
  • pydotplus ==2.0.2
  • reana-client ==0.7.5
  • reana-commons ==0.7.5
  • recast-atlas ==0.1.8
  • yadage ==0.20.1
  • yadage-schemas ==0.10.6
deploy/recast-atlas-0.1.9-requirements.txt pypi
  • adage ==0.10.2
  • kubernetes ==9.0.0
  • packtivity ==0.14.24
  • pydotplus ==2.0.2
  • reana-client ==0.8.0
  • reana-commons ==0.8.1
  • recast-atlas ==0.1.9
  • yadage ==0.20.1
  • yadage-schemas ==0.10.7
.github/workflows/bump-version.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/ci.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/docker.yml actions
  • actions/checkout v2 composite
  • docker/build-push-action v2 composite
  • docker/login-action v1 composite
  • docker/setup-buildx-action v1 composite
  • docker/setup-qemu-action v1 composite
.github/workflows/head-of-dependencies.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/lint.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/publish-package.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • pypa/gh-action-pypi-publish v1.4.2 composite
docker/Dockerfile docker
  • docker 20.10.5 build
pyproject.toml pypi
deploy/recast-atlas-0.3.0-requirements.txt pypi
  • adage ==0.10.3
  • kubernetes ==9.0.0
  • packtivity ==0.16.2
  • pydotplus ==2.0.2
  • reana-client ==0.9.1
  • reana-commons ==0.9.3
  • recast-atlas ==0.3.0
  • yadage ==0.20.1
  • yadage-schemas ==0.10.8