# EnergyFlow
[](https://github.com/thaler-lab/EnergyFlow/actions/workflows/test-energyflow.yml?query=branch%3Amaster)
[](https://mybinder.org/v2/gh/thaler-lab/EnergyFlow/master)
EnergyFlow is a Python package that computes Energy Flow Polynomials (EFPs) as defined in Ref. [1], implements Energy Flow Networks (EFNs) and Particle Flow Networks (PFNs) as defined in Ref. [2], computes Energy Mover's Distances as defined in Ref. [3], and provides access to some particle physics [datasets hosted on Zenodo](https://zenodo.org/search?page=1&size=20&q=komiske&sort=title) including the jet datasets in MOD HDF5 format used in Ref. [4].
#### Installation
To install EnergyFlow with pip, simply execute:
```console
python -m pip install energyflow
```
#### Documentation
The documentation is maintained at [https://energyflow.network](https://energyflow.network).
##### References
[1] P. T. Komiske, E. M. Metodiev, and J. Thaler, _Energy Flow Polynomials: A complete linear basis for jet substructure_, [JHEP __04__ (2018) 013](https://doi.org/10.1007/JHEP04(2018)013) [[1712.07124](https://arxiv.org/abs/1712.07124)].
[2] P. T. Komiske, E. M. Metodiev, and J. Thaler, _Energy Flow Networks: Deep Sets for Particle Jets_, [JHEP __01__ (2019) 121](https://doi.org/10.1007/JHEP01(2019)121) [[1810.05165](https://arxiv.org/abs/1810.05165)].
[3] P. T. Komiske, E. M. Metodiev, and J. Thaler, _The Metric Space of Collider Events_, [Phys. Rev. Lett. __123__ (2019) 041801](https://doi.org/10.1103/PhysRevLett.123.041801) [[1902.02346](https://arxiv.org/abs/1902.02346)].
[4] P. T. Komiske, R. Mastandrea, E. M. Metodiev, P. Naik, and J. Thaler, _Exploring the Space of Jets with CMS Open Data_, [Phys. Rev. D **101** (2020) 034009](https://doi.org/10.1103/PhysRevD.101.034009) [[1908.08542](https://arxiv.org/abs/1908.08542)].
[5] P. T. Komiske, E. M. Metodiev, and J. Thaler, _Cutting Multiparticle Correlators Down to Size_, [Phys. Rev. D **101** (2020) 036019](https://doi.org/10.1103/PhysRevD.101.036019) [[1911.04491](https://arxiv.org/abs/1911.04491)].
[6] A. Andreassen, P. T. Komiske, E. M. Metodiev, B. Nachman, and J. Thaler, _OmniFold: A Method to Simultaneously Unfold All Observables_, [Phys. Rev. Lett. __124__ (2020) 182001](https://doi.org/10.1103/PhysRevLett.124.182001) [[1911.09107](https://arxiv.org/abs/1911.09107)].
[7] P. T. Komiske, E. M. Metodiev, and J. Thaler, _The Hidden Geometry of Particle Collisions_, [JHEP __07__ (2020) 006](https://doi.org/10.1007/JHEP07(2020)006) [[2004.04159](https://arxiv.org/abs/2004.04159)].
Raw data
{
"_id": null,
"home_page": null,
"name": "EnergyFlow",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Rikab Gambhir <rikab@mit.edu>, Jordan Ashley <jordan.ashley@cern.ch>",
"keywords": "CMS, Deep Sets, EFM, EFN, EFP, EMD, Earth Mover Distance, Energy Flow Moment, Energy Flow Network, Energy Flow Polynomial, MOD, Open Data, PFN, Particle Flow Network, Wasserstein, architecture, collider, correlator, energy flow, energyflow, jets, metric, multigraph, neural network, open, physics, polynomial, substructure",
"author": null,
"author_email": "\"Patrick T. Komiske III\" <pkomiske@mit.edu>",
"download_url": "https://files.pythonhosted.org/packages/99/06/3c94ec859689c348eaa40b6d702d68ec99f1304d4a667a78fbba1c6305ab/energyflow-1.4.0.tar.gz",
"platform": null,
"description": "# EnergyFlow\n[](https://github.com/thaler-lab/EnergyFlow/actions/workflows/test-energyflow.yml?query=branch%3Amaster)\n[](https://mybinder.org/v2/gh/thaler-lab/EnergyFlow/master)\n\nEnergyFlow is a Python package that computes Energy Flow Polynomials (EFPs) as defined in Ref. [1], implements Energy Flow Networks (EFNs) and Particle Flow Networks (PFNs) as defined in Ref. [2], computes Energy Mover's Distances as defined in Ref. [3], and provides access to some particle physics [datasets hosted on Zenodo](https://zenodo.org/search?page=1&size=20&q=komiske&sort=title) including the jet datasets in MOD HDF5 format used in Ref. [4].\n\n#### Installation\n\nTo install EnergyFlow with pip, simply execute:\n\n```console\npython -m pip install energyflow\n```\n\n#### Documentation\n\nThe documentation is maintained at [https://energyflow.network](https://energyflow.network).\n\n##### References\n\n[1] P. T. Komiske, E. M. Metodiev, and J. Thaler, _Energy Flow Polynomials: A complete linear basis for jet substructure_, [JHEP __04__ (2018) 013](https://doi.org/10.1007/JHEP04(2018)013) [[1712.07124](https://arxiv.org/abs/1712.07124)].\n\n[2] P. T. Komiske, E. M. Metodiev, and J. Thaler, _Energy Flow Networks: Deep Sets for Particle Jets_, [JHEP __01__ (2019) 121](https://doi.org/10.1007/JHEP01(2019)121) [[1810.05165](https://arxiv.org/abs/1810.05165)].\n\n[3] P. T. Komiske, E. M. Metodiev, and J. Thaler, _The Metric Space of Collider Events_, [Phys. Rev. Lett. __123__ (2019) 041801](https://doi.org/10.1103/PhysRevLett.123.041801) [[1902.02346](https://arxiv.org/abs/1902.02346)].\n\n[4] P. T. Komiske, R. Mastandrea, E. M. Metodiev, P. Naik, and J. Thaler, _Exploring the Space of Jets with CMS Open Data_, [Phys. Rev. D **101** (2020) 034009](https://doi.org/10.1103/PhysRevD.101.034009) [[1908.08542](https://arxiv.org/abs/1908.08542)].\n\n[5] P. T. Komiske, E. M. Metodiev, and J. Thaler, _Cutting Multiparticle Correlators Down to Size_, [Phys. Rev. D **101** (2020) 036019](https://doi.org/10.1103/PhysRevD.101.036019) [[1911.04491](https://arxiv.org/abs/1911.04491)].\n\n[6] A. Andreassen, P. T. Komiske, E. M. Metodiev, B. Nachman, and J. Thaler, _OmniFold: A Method to Simultaneously Unfold All Observables_, [Phys. Rev. Lett. __124__ (2020) 182001](https://doi.org/10.1103/PhysRevLett.124.182001) [[1911.09107](https://arxiv.org/abs/1911.09107)].\n\n[7] P. T. Komiske, E. M. Metodiev, and J. Thaler, _The Hidden Geometry of Particle Collisions_, [JHEP __07__ (2020) 006](https://doi.org/10.1007/JHEP07(2020)006) [[2004.04159](https://arxiv.org/abs/2004.04159)].\n",
"bugtrack_url": null,
"license": null,
"summary": "Python package for the Energy Flow suite of particle physics tools",
"version": "1.4.0",
"project_urls": {
"Homepage": "https://energyflow.network",
"Issues": "https://github.com/thaler-lab/EnergyFlow/issues",
"Source Code": "https://github.com/thaler-lab/EnergyFlow"
},
"split_keywords": [
"cms",
" deep sets",
" efm",
" efn",
" efp",
" emd",
" earth mover distance",
" energy flow moment",
" energy flow network",
" energy flow polynomial",
" mod",
" open data",
" pfn",
" particle flow network",
" wasserstein",
" architecture",
" collider",
" correlator",
" energy flow",
" energyflow",
" jets",
" metric",
" multigraph",
" neural network",
" open",
" physics",
" polynomial",
" substructure"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b30c6415d36ecfedc589f86b9c5eb55933dc0bda86341a370f6cd1d016d88783",
"md5": "5725a5d0499874a4cc73f94bfa5d1cf0",
"sha256": "90ed6d8b8553c69226b9f28d45c1aa362c0ad918426e1264f0b73cfe5cdf33f6"
},
"downloads": -1,
"filename": "energyflow-1.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5725a5d0499874a4cc73f94bfa5d1cf0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 700812,
"upload_time": "2024-11-01T09:05:39",
"upload_time_iso_8601": "2024-11-01T09:05:39.134188Z",
"url": "https://files.pythonhosted.org/packages/b3/0c/6415d36ecfedc589f86b9c5eb55933dc0bda86341a370f6cd1d016d88783/energyflow-1.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "99063c94ec859689c348eaa40b6d702d68ec99f1304d4a667a78fbba1c6305ab",
"md5": "b3dcedbb92677f65f2a5bb51c3773016",
"sha256": "f79cfe109b3944ae94b363cdda77cc0f8d4ee3d1b59d50cad3b7165751e14099"
},
"downloads": -1,
"filename": "energyflow-1.4.0.tar.gz",
"has_sig": false,
"md5_digest": "b3dcedbb92677f65f2a5bb51c3773016",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 694226,
"upload_time": "2024-11-01T09:05:42",
"upload_time_iso_8601": "2024-11-01T09:05:42.130976Z",
"url": "https://files.pythonhosted.org/packages/99/06/3c94ec859689c348eaa40b6d702d68ec99f1304d4a667a78fbba1c6305ab/energyflow-1.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-01 09:05:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thaler-lab",
"github_project": "EnergyFlow",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "energyflow"
}
JSON
