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:
You can find the full API documentation on readthedocs.
Projects using order
- uhh-cms/cmsdb
- tba
Installation and dependencies
Install order via pip:
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:
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
# 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:
flake8 order tests setup.py
Development
- Source hosted at GitHub
- Report issues, questions, feature requests on GitHub Issues
1 maintainer
Metadata
1 maintainer
Release files for order 2.1.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| order-2.1.7.tar.gz | 44.4 kB | Without provenance | Details |
Release files / order-2.1.7.tar.gz
| Download URL | order-2.1.7.tar.gz |
|---|---|
| Size | 44.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c3b98b12ca9ea05e3647a5200e057883aec6d1f63fa690527226b477a569c19d
|
|
BLAKE2b-256 checksum How to use checksums |
2b6f62a5f639b713fd62f0c2129e25926e7ec58540b9867b1337e521e1587a99
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.0 CPython/3.12.4
|
Security for order 2.1.7
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
