mapyde

Generation, simulation, analysis, and statistical inference in one go.

https://github.com/scipp-atlas/mapyde

Science Score: 62.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
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
    Organization scipp-atlas has institutional domain (scipp.ucsc.edu)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.1%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Generation, simulation, analysis, and statistical inference in one go.

Basic Info
Statistics
  • Stars: 7
  • Watchers: 3
  • Forks: 1
  • Open Issues: 12
  • Releases: 18
Created over 4 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License Citation Zenodo

README.md

mapyde v0.5.0

MaPyDe stands for MadGraph-Pythia-Delphes which is a utility that allows one to run all of the various HEP toolings or chain them together and perform a quick analysis with the results, such as running CERN ATLAS SimpleAnalysis or pyhf.


Mapyde logo | | | | --- | --- | | CI/CD | [![CI - Test][actions-badge-ci]][actions-link-ci] [![CI - Docker][actions-badge-docker]][actions-link-docker] [![Docs][actions-badge-docs]][actions-link-docs] | | Docs | [![doc][doc-badge]][doc-link] [![Zenodo][zenodo-badge]][zenodo-link] | | Package | [![PyPI - Downloads][pypi-downloads]][pypi-link] [![PyPI - Version][pypi-version]][pypi-link] [![PyPI platforms][pypi-platforms]][pypi-link] [![Conda-Forge][conda-badge]][conda-link] | | Meta | [![GitHub - Discussion][github-discussions-badge]][github-discussions-link] [![GitHub - Issue][github-issues-badge]][github-issues-link] [![License - Apache 2.0][license-badge]][license-link] |

Docker Images

Docker images are made available in our container registry.

docker pull ghcr.io/scipp-atlas/mapyde/madgraph docker pull ghcr.io/scipp-atlas/mapyde/delphes docker pull ghcr.io/scipp-atlas/mapyde/pyplotting

If you want to run on a machine with an NVidia GPU and use it for limit setting with pyhf, then there's a container for that too:

docker pull ghcr.io/scipp-atlas/mario-mapyde/pyplotting-cuda

Running

Everyone is centralized around the concept of providing a user configuration file that references a template. By default, defaults.toml is used (if not specified). These configuration files significantly control how to run or execute the various steps in the chain of mapyde. Use the command line interface to get started:

```

display the help

mapyde --help

open Textual TUI

mapyde --tui

display the prefix path for data cards shipped with mapyde

mapyde --prefix cards

parse and display the config

mapyde config parse user.toml

run all steps

maypde run all user.toml

run only madgraph

mapyde run madgraph user.toml

display the help for running

mapyde run --help ```

Configuration Details

There are a lot of different configuration options one can specify. For right now, the user is asked to look at defaults.toml, run mapyde config parse user.toml, open a discussion, or look at the source code.

MadGraph

Produces a hepmc file. You can:

  • specify process, param, and run cards
    • define particle masses in config file
    • define additional kinematic cuts to apply at parton level
  • specify pythia card
  • define center of mass energy

Delphes

Run a parameterized detector simulation, outputting a ROOT file. You can:

  • specify Delphes card

Analysis

Analyze the Delphes output, which could be user-provided analysis code. There are some scripts already provided for you:

  • scripts/Delphes2SA.py will make an ntuple that can be parsed by SimpleAnalysis for limit setting.
  • scripts/SimpleAna.py will make a generic "flat" ntuple in a ROOT file.
  • scripts/muscan.py will use pyhf to perform a mu-scan and compute upper-limits for a public likelihood injected with results from SimpleAnalysis.

Owner

  • Name: Santa Cruz Institute for Particle Physics
  • Login: scipp-atlas
  • Kind: organization
  • Location: Santa Cruz, CA

Citation (CITATION.cff)

cff-version: 1.2.0
message: "Please cite the following works when using this software."
type: software
authors:
- family-names: "Hance"
  given-names: "Michael"
  orcid: "https://orcid.org/0000-0001-8392-0934"
  affiliation: "University of California, Santa Cruz"
- family-names: "Stark"
  given-names: "Giordon"
  orcid: "https://orcid.org/0000-0001-6616-3433"
  affiliation: "SCIPP, University of California, Santa Cruz"
title: "mapyde, v0.4.9"
version: 0.4.9
doi: 10.5281/zenodo.7796373
repository-code: "https://github.com/scipp-atlas/mapyde/tree/v0.4.9"
url: "https://scipp-atlas.github.io/mapyde/latest/"
keywords:
  - python
  - physics
  - reinterpretation
license: "Apache-2.0"
abstract: |
  Searches for new physics at the Large Hadron Collider have constrained many models of physics beyond the Standard Model.
  Many searches also provide resources that allow them to be reinterpreted in the context of other models. We describe a
  reinterpretation pipeline that examines previously untested models of new physics using supplementary information from
  ATLAS SUSY searches, such as public analysis routines and serialized likelihoods, in a way that provides accurate limits
  even in models that differ meaningfully from the benchmark models of the original analysis. These resources are combined
  with common event generation and simulation toolkits MadGraph, Pythia, and Delphes into workflows steered by TOML
  configuration files, and bundled into the mapyde python package.
references:
  - type: article
    authors:
    - name: "Hance, M. and Stark, G."
    title: "Reduce, Reuse, Reinterpret: an end-to-end pipeline for recycling particle physics results"
    doi: TBD
    url: TBD
    year: 2023

GitHub Events

Total
  • Issues event: 2
  • Delete event: 12
  • Push event: 55
  • Pull request review event: 2
  • Pull request event: 16
  • Create event: 9
Last Year
  • Issues event: 2
  • Delete event: 12
  • Push event: 55
  • Pull request review event: 2
  • Pull request event: 16
  • Create event: 9

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 32
  • Total pull requests: 163
  • Average time to close issues: 3 months
  • Average time to close pull requests: 11 days
  • Total issue authors: 4
  • Total pull request authors: 7
  • Average comments per issue: 1.22
  • Average comments per pull request: 0.1
  • Merged pull requests: 150
  • Bot issues: 0
  • Bot pull requests: 129
Past Year
  • Issues: 1
  • Pull requests: 16
  • Average time to close issues: N/A
  • Average time to close pull requests: about 1 month
  • Issue authors: 1
  • Pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 14
  • Bot issues: 0
  • Bot pull requests: 16
Top Authors
Issue Authors
  • mhance (15)
  • kratsg (12)
  • JasonNielsen (3)
  • sambklein (2)
Pull Request Authors
  • pre-commit-ci[bot] (103)
  • dependabot[bot] (34)
  • kratsg (29)
  • mhance (2)
  • JasonNielsen (1)
  • lmorelosz (1)
  • Moelf (1)
Top Labels
Issue Labels
enhancement (3) bug (3) help wanted (1) documentation (1)
Pull Request Labels
dependencies (34) documentation (2) enhancement (2) github_actions (1)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 45 last-month
  • Total docker downloads: 9
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 27
  • Total maintainers: 2
pypi.org: mapyde

Generation, simulation, analysis, and statistical inference in one go.

  • Versions: 22
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 45 Last month
  • Docker Downloads: 9
Rankings
Dependent packages count: 6.6%
Downloads: 12.6%
Average: 21.2%
Stargazers count: 25.5%
Forks count: 30.5%
Dependent repos count: 30.6%
Maintainers (2)
Last synced: 6 months ago
conda-forge.org: mapyde

MaPyDe stands for MadGraph-Pythia-Delphes which is a utility that allows one to run all of the various HEP toolings or chain them together and perform a quick analysis with the results, such as running CERN ATLAS SimpleAnalysis or pyhf.

  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 34.0%
Dependent packages count: 51.2%
Average: 51.6%
Stargazers count: 60.1%
Forks count: 61.1%
Last synced: 6 months ago

Dependencies

stats/requirements.txt pypi
  • PyYAML ==5.3.1
  • attrs ==20.3.0
  • awkward ==1.0.0
  • awkward1 ==1.0.0
  • boost-histogram ==0.11.1
  • cabinetry ==0.1.5
  • click ==7.1.2
  • iminuit ==1.5.4
  • jsonpatch ==1.28
  • jsonpointer ==2.0
  • jsonschema ==3.2.0
  • numpy ==1.19.4
  • pyhf ==0.5.3
  • pyrsistent ==0.17.3
  • scipy ==1.5.4
  • six ==1.15.0
  • tqdm ==4.54.1
.github/workflows/ci.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • pre-commit/action v3.0.0 composite
  • pypa/gh-action-pypi-publish v1.6.4 composite
.github/workflows/docker.yml actions
  • actions/checkout v3 composite
  • actions/download-artifact v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • akhilerm/tag-push-action v2.1.0 composite
  • docker/build-push-action v3 composite
  • docker/login-action v2 composite
  • docker/setup-buildx-action v2 composite
  • docker/setup-qemu-action v2 composite
  • dorny/paths-filter v2 composite
.github/workflows/docs.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
pyproject.toml pypi