<center>
<a href="https://github.com/riga/order">
<img src="https://media.githubusercontent.com/media/riga/order/master/assets/logo240.png" />
</a>
</center>
<!-- marker-after-logo -->
[](http://python-order.readthedocs.io/en/latest)
[](https://github.com/riga/order/actions/workflows/lint_and_test.yml)
[](https://codecov.io/gh/riga/order)
[](https://pypi.python.org/pypi/order)
[](https://github.com/riga/order/blob/master/LICENSE)
[](https://pypi.python.org/pypi/order)
[](https://colab.research.google.com/github/riga/order/blob/master/examples/intro.ipynb)
[](https://mybinder.org/v2/gh/riga/order/master?filepath=examples%2Fintro.ipynb)
If you're designing a high-energy physics analysis (e.g. with data recorded by an [LHC](https://home.cern/topics/large-hadron-collider) experiment at [CERN](http://home.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.
<!-- marker-after-header -->
## Getting started
See the [intro.ipynb](https://github.com/riga/order/blob/master/examples/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:
[](https://colab.research.google.com/github/riga/order/blob/master/examples/intro.ipynb)
[](https://mybinder.org/v2/gh/riga/order/master?filepath=examples%2Fintro.ipynb)
You can find the full [API documentation on readthedocs](http://python-order.readthedocs.io).
<!-- marker-after-getting-started -->
## Projects using order
- [uhh-cms/cmsdb](https://github.com/uhh-cms/cmsdb)
- tba
## Installation and dependencies
Install *order* via [pip](https://pypi.python.org/pypi/order):
```shell
pip install order
```
The only dependencies are [scinum](https://pypi.python.org/pypi/scinum) and [six](https://pypi.python.org/pypi/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](https://www.python.org/dev/peps/pep-0008) compatibility should be checked with [flake8](https://pypi.org/project/flake8):
```shell
flake8 order tests setup.py
```
## Development
- Source hosted at [GitHub](https://github.com/riga/order)
- Report issues, questions, feature requests on [GitHub Issues](https://github.com/riga/order/issues)
Raw data
{
"_id": null,
"home_page": "https://github.com/riga/order",
"name": "order",
"maintainer": "",
"docs_url": null,
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, <4",
"maintainer_email": "",
"keywords": "physics,analysis,experiment,order,structure,database,lhc,hep,alice,atlas,cms,lhcb",
"author": "Marcel Rieger",
"author_email": "github.riga@icloud.com",
"download_url": "https://files.pythonhosted.org/packages/e5/66/0d98dab40e7a7ed416f3ef343379c218d18a5090c1ffc516bfda3f7a88b8/order-2.1.4.tar.gz",
"platform": null,
"description": "<center>\n <a href=\"https://github.com/riga/order\">\n <img src=\"https://media.githubusercontent.com/media/riga/order/master/assets/logo240.png\" />\n </a>\n</center>\n\n\n<!-- marker-after-logo -->\n\n\n[](http://python-order.readthedocs.io/en/latest)\n[](https://github.com/riga/order/actions/workflows/lint_and_test.yml)\n[](https://codecov.io/gh/riga/order)\n[](https://pypi.python.org/pypi/order)\n[](https://github.com/riga/order/blob/master/LICENSE)\n[](https://pypi.python.org/pypi/order)\n[](https://colab.research.google.com/github/riga/order/blob/master/examples/intro.ipynb)\n[](https://mybinder.org/v2/gh/riga/order/master?filepath=examples%2Fintro.ipynb)\n\nIf you're designing a high-energy physics analysis (e.g. with data recorded by an [LHC](https://home.cern/topics/large-hadron-collider) experiment at [CERN](http://home.cern), manual bookkeeping of external data can get complicated quite fast.\n*order* provides a pythonic class collection that helps you structuring\n\n- analyses,\n- MC campaigns,\n- datasets,\n- physics process and cross sections,\n- channels,\n- categories,\n- variables, and\n- systematic shifts.\n\n\n<!-- marker-after-header -->\n\n\n## Getting started\n\nSee the [intro.ipynb](https://github.com/riga/order/blob/master/examples/intro.ipynb) notebook for an introduction to the most important classes and an example setup of a small analysis.\nYou can also run the notebook interactively on colab or binder:\n\n[](https://colab.research.google.com/github/riga/order/blob/master/examples/intro.ipynb)\n[](https://mybinder.org/v2/gh/riga/order/master?filepath=examples%2Fintro.ipynb)\n\nYou can find the full [API documentation on readthedocs](http://python-order.readthedocs.io).\n\n\n<!-- marker-after-getting-started -->\n\n\n## Projects using order\n\n- [uhh-cms/cmsdb](https://github.com/uhh-cms/cmsdb)\n- tba\n\n\n## Installation and dependencies\n\nInstall *order* via [pip](https://pypi.python.org/pypi/order):\n\n```shell\npip install order\n```\n\nThe only dependencies are [scinum](https://pypi.python.org/pypi/scinum) and [six](https://pypi.python.org/pypi/six) (Python 2 support that will be dropped soon), which are installed with the above command.\n\n\n## Contributing and testing\n\nIf you like to contribute, feel free to open a pull request \ud83c\udf89.\nJust make sure to add new test cases and run them via:\n\n```shell\npython -m unittest tests\n```\n\nIn general, tests should be run for Python 2.7, 3.6 - 3.11.\nTo run tests in a docker container, do\n\n```shell\n# run the tests\n./tests/docker.sh python:3.9\n\n# or interactively by adding a flag \"1\" to the command\n./tests/docker.sh python:3.9 1\n> pip install -r requirements.txt\n> python -m unittest tests\n```\n\nIn addition, [PEP 8](https://www.python.org/dev/peps/pep-0008) compatibility should be checked with [flake8](https://pypi.org/project/flake8):\n\n```shell\nflake8 order tests setup.py\n```\n\n\n## Development\n\n- Source hosted at [GitHub](https://github.com/riga/order)\n- Report issues, questions, feature requests on [GitHub Issues](https://github.com/riga/order/issues)\n\n\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Pythonic class collection that helps you structure external data from LHC / HEP experiments.",
"version": "2.1.4",
"project_urls": {
"Homepage": "https://github.com/riga/order"
},
"split_keywords": [
"physics",
"analysis",
"experiment",
"order",
"structure",
"database",
"lhc",
"hep",
"alice",
"atlas",
"cms",
"lhcb"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e5660d98dab40e7a7ed416f3ef343379c218d18a5090c1ffc516bfda3f7a88b8",
"md5": "6700e76c933a1bd4303fd89220168a45",
"sha256": "97982b6322a2313099db3d63d58ad6159cf1969342de4b9f73643407e099cbc0"
},
"downloads": -1,
"filename": "order-2.1.4.tar.gz",
"has_sig": false,
"md5_digest": "6700e76c933a1bd4303fd89220168a45",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, <4",
"size": 43649,
"upload_time": "2023-07-20T08:44:07",
"upload_time_iso_8601": "2023-07-20T08:44:07.752210Z",
"url": "https://files.pythonhosted.org/packages/e5/66/0d98dab40e7a7ed416f3ef343379c218d18a5090c1ffc516bfda3f7a88b8/order-2.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-20 08:44:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "riga",
"github_project": "order",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "order"
}
JSON
