Data

Tools

Indexes

Applications

Experiments

Open Source Science

order

Pythonic class collection that helps you structure external data from LHC / HEP experiments.

https://github.com/riga/order

Science Score: 23.0%

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

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    2 of 6 committers (33.3%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (17.7%) to scientific vocabulary
Last synced: 11 months ago · JSON representation

Repository

Pythonic class collection that helps you structure external data from LHC / HEP experiments.

Basic Info
Statistics
  • Stars: 11
  • Watchers: 2
  • Forks: 4
  • Open Issues: 2
  • Releases: 27
Created almost 9 years ago · Last pushed over 1 year ago
Metadata Files
Readme License

README.md

Documentation status Lint and test Code coverge Package version License PyPI downloads Open in colab Open in binder

If you're designing a high-energy physics analysis (e.g. with data recorded by an LHC experiment at CERN, manual bookkeeping of external data can get complicated quite fast. order provides a pythonic class collection that helps you structuring

  • analyses,
  • MC campaigns,
  • datasets,
  • physics process and cross sections,
  • channels,
  • categories,
  • variables, and
  • systematic shifts.

Getting started

See the intro.ipynb notebook for an introduction to the most important classes and an example setup of a small analysis. You can also run the notebook interactively on colab or binder:

Open in colab Open in binder

You can find the full API documentation on readthedocs.

Projects using order

Installation and dependencies

Install order via pip:

shell pip install order

The only dependencies are scinum and six (Python 2 support that will be dropped soon), which are installed with the above command.

Contributing and testing

If you like to contribute, feel free to open a pull request 🎉. Just make sure to add new test cases and run them via:

shell python -m unittest tests

In general, tests should be run for Python 2.7, 3.6 - 3.11. To run tests in a docker container, do

```shell

run the tests

./tests/docker.sh python:3.9

or interactively by adding a flag "1" to the command

./tests/docker.sh python:3.9 1

pip install -r requirements.txt python -m unittest tests ```

In addition, PEP 8 compatibility should be checked with flake8:

shell flake8 order tests setup.py

Development

Owner

  • Name: Marcel Rieger
  • Login: riga
  • Kind: user
  • Location: Geneva
  • Company: UHH / CERN

ML, Transfer Learning & Fine Tuning, RL, Workflow Management, Distributed Computing, Ahead-of-time compilation, Higgs Physics

GitHub Events

Total
  • Push event: 5
Last Year
  • Push event: 5

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 257
  • Total Committers: 6
  • Avg Commits per committer: 42.833
  • Development Distribution Score (DDS): 0.245
Past Year
  • Commits: 38
  • Committers: 3
  • Avg Commits per committer: 12.667
  • Development Distribution Score (DDS): 0.053
Top Committers
Name Email Commits
Marcel R m****r@m****m 194
Marcel R g****a@i****m 48
Benjamin Fischer b****r@c****h 5
Marcel R r****a 5
Marcel Rieger m****l@m****l 4
Peter Fackeldey p****y@r****e 1
Committer Domains (Top 20 + Academic)
rwth-aachen.de: 1 cern.ch: 1 me.com: 1

Issues and Pull Requests

Last synced: over 1 year ago

All Time
  • Total issues: 8
  • Total pull requests: 13
  • Average time to close issues: 20 days
  • Average time to close pull requests: about 2 months
  • Total issue authors: 4
  • Total pull request authors: 5
  • Average comments per issue: 1.13
  • Average comments per pull request: 0.54
  • Merged pull requests: 9
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: 10 days
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • riga (5)
  • bfis (1)
  • frengelk (1)
Pull Request Authors
  • riga (5)
  • bfis (4)
  • Nollde (2)
  • haddadanas (2)
  • pfackeldey (1)
Top Labels
Issue Labels
enhancement (3) feature (2) question (1)
Pull Request Labels
enhancement (2) bug (2)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 2,262 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 21
  • Total versions: 45
  • Total maintainers: 1
pypi.org: order

Pythonic class collection that helps you structure external data from LHC / HEP experiments.

  • Versions: 45
  • Dependent Packages: 0
  • Dependent Repositories: 21
  • Downloads: 2,262 Last month
Rankings
Dependent repos count: 3.2%
Downloads: 9.6%
Dependent packages count: 10.0%
Average: 11.5%
Forks count: 16.8%
Stargazers count: 17.7%
Maintainers (1)
Riga
Last synced: 11 months ago

Dependencies

requirements.txt pypi
  • scinum >=1.1.3
  • six *
requirements_docs.txt pypi
  • scinum >=1.1.3
  • six *
  • sphinx >=5.0,<6
  • sphinx_rtd_theme *
requirements_test.txt pypi
  • cloudpickle >=1.3 test
  • flake8 >=3.0,<4.0 test
  • flake8 >=4.0 test
  • flake8-commas >=2.1 test
  • flake8-quotes >=3.3 test
  • flake8-quotes <=3.2 test
  • pytest-cov >=3.0 test
  • scinum >=1.1.3 test
  • six * test
setup.py pypi
  • line.strip *
.github/workflows/lint_and_test.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v2 composite
.github/workflows/publish_pypi.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • pypa/gh-action-pypi-publish master composite