# Particle Dataset Downloader (v0.0.7)
A package for downloading a repository of particle physics datasets. All datasets can be accessed with a single line:
```
from particleloader import load
Data = load(DATASET_NAME, N_samples, cache_dir=dir)
```
See ```example.ipynb``` for detailed example usage.
## Public Datasets:
As of the latest release, the public datasets are:
* **Quark/Gluon Jets:** `qg_jets`, a dataset of quark and gluon jets with labels generated in Pythia or Herwig, with the option of including _b_ and _c_ quarks.
* **Top/QCD Jets:** `topqcd_jets`, a dataset of quark and gluon jets with labels generated in Pythia or Herwig.
* **SPECTER LEP dijets:** `SPECTER_ee_dijets`, a dataset of LEP-like e+e- collisions to hadrons generated in Pythia, as used in arxiv:2410:XXXXX
* **SPECTER QCD jets:** `SPECTER_qcd_jets`, a dataset of QCD jets generated in Pythia, as used in arxiv:2410:XXXXX
* **SPECTER Top jets:** `SPECTER_top_jets`, a dataset of top jets generated in Pythia, as used in arxiv:2410:XXXXX
It is relatively straightforward to add new datasets. If you have a dataset you would like to add, please let me know!
## Installation
### From this repository locally
In your Python environment from the top level of this repository run
```
python -m pip install .
```
### From GitHub
In your Python environment run
```
python -m pip install "particleloader @ git+https://github.com/rikab/ParticleLoader.git"
``````
## Dependencies
The following python packages are required by the data formatter:
* numpy
* urllib3
## Changelog
- v0.0.7: 8 October 2024. SPECTER Datasets.
- v0.0.6: 26 August 2024. SPECTER e+e- dijets.
- v0.0.5: 14 August 2024. Overhaul, multiple datasets (top/qcd and q/g).
- v0.0.3: 9 August 2023. Minor Bug Fixes.
- v0.0.2: 8 August 2023. Pip-installable.
- v0.0.1: 31 July 2023. Initial release.
Raw data
{
"_id": null,
"home_page": "https://github.com/rikab/ParticleLoader",
"name": "particleloader",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "top tagging, jet physics, machine learning",
"author": "Rikab Gambhir",
"author_email": "Rikab Gambhir <rikab@mit.edu>",
"download_url": "https://files.pythonhosted.org/packages/25/5f/758635fac75ce3ff7a2da4648e0cb6f281dfc75ffcf45abd373f38b4afbc/particleloader-0.0.7.post4.tar.gz",
"platform": null,
"description": "# Particle Dataset Downloader (v0.0.7)\n\nA package for downloading a repository of particle physics datasets. All datasets can be accessed with a single line:\n\n```\nfrom particleloader import load\nData = load(DATASET_NAME, N_samples, cache_dir=dir)\n``` \n\nSee ```example.ipynb``` for detailed example usage.\n\n\n## Public Datasets:\n\nAs of the latest release, the public datasets are:\n\n* **Quark/Gluon Jets:** `qg_jets`, a dataset of quark and gluon jets with labels generated in Pythia or Herwig, with the option of including _b_ and _c_ quarks.\n* **Top/QCD Jets:** `topqcd_jets`, a dataset of quark and gluon jets with labels generated in Pythia or Herwig.\n* **SPECTER LEP dijets:** `SPECTER_ee_dijets`, a dataset of LEP-like e+e- collisions to hadrons generated in Pythia, as used in arxiv:2410:XXXXX\n* **SPECTER QCD jets:** `SPECTER_qcd_jets`, a dataset of QCD jets generated in Pythia, as used in arxiv:2410:XXXXX\n* **SPECTER Top jets:** `SPECTER_top_jets`, a dataset of top jets generated in Pythia, as used in arxiv:2410:XXXXX\n\nIt is relatively straightforward to add new datasets. If you have a dataset you would like to add, please let me know!\n\n\n## Installation\n\n### From this repository locally\n\nIn your Python environment from the top level of this repository run\n\n```\npython -m pip install .\n```\n\n### From GitHub\n\nIn your Python environment run\n\n```\npython -m pip install \"particleloader @ git+https://github.com/rikab/ParticleLoader.git\"\n``````\n\n## Dependencies\n\nThe following python packages are required by the data formatter:\n\n* numpy\n* urllib3\n\n\n## Changelog\n\n- v0.0.7: 8 October 2024. SPECTER Datasets.\n- v0.0.6: 26 August 2024. SPECTER e+e- dijets.\n- v0.0.5: 14 August 2024. Overhaul, multiple datasets (top/qcd and q/g).\n- v0.0.3: 9 August 2023. Minor Bug Fixes.\n- v0.0.2: 8 August 2023. Pip-installable.\n- v0.0.1: 31 July 2023. Initial release.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Code for downloading Particle Physics datasets",
"version": "0.0.7.post4",
"project_urls": {
"Documentation": "https://github.com/rikab/ParticleLoader",
"Homepage": "https://github.com/rikab/ParticleLoader",
"Issue Tracker": "https://github.com/rikab/ParticleLoader/issues",
"Releases": "https://github.com/rikab/ParticleLoader/releases",
"Source Code": "https://github.com/rikab/ParticleLoader"
},
"split_keywords": [
"top tagging",
" jet physics",
" machine learning"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dc292d097ce018a658a8f6d13a205a586e04adc226df759790e821bd73e3bd56",
"md5": "5efd154be2341d7abf8fc42ebb0a329c",
"sha256": "c2940fd62c932d89713be7f5796c440ff0f2f66322f8668739ee8393337ac3ad"
},
"downloads": -1,
"filename": "particleloader-0.0.7.post4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5efd154be2341d7abf8fc42ebb0a329c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 20976,
"upload_time": "2024-10-08T23:37:23",
"upload_time_iso_8601": "2024-10-08T23:37:23.670865Z",
"url": "https://files.pythonhosted.org/packages/dc/29/2d097ce018a658a8f6d13a205a586e04adc226df759790e821bd73e3bd56/particleloader-0.0.7.post4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "255f758635fac75ce3ff7a2da4648e0cb6f281dfc75ffcf45abd373f38b4afbc",
"md5": "63f8e5d4c1803fb65b01bfa6758f245b",
"sha256": "fed231af5adb86052e11bf8a5247302a925759a06adacc1e475c0292caf7b95c"
},
"downloads": -1,
"filename": "particleloader-0.0.7.post4.tar.gz",
"has_sig": false,
"md5_digest": "63f8e5d4c1803fb65b01bfa6758f245b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 17924,
"upload_time": "2024-10-08T23:37:25",
"upload_time_iso_8601": "2024-10-08T23:37:25.443695Z",
"url": "https://files.pythonhosted.org/packages/25/5f/758635fac75ce3ff7a2da4648e0cb6f281dfc75ffcf45abd373f38b4afbc/particleloader-0.0.7.post4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-08 23:37:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rikab",
"github_project": "ParticleLoader",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "particleloader"
}
JSON
