| Name | pylhe JSON |
| Version |
0.9.1
JSON |
| download |
| home_page | None |
| Summary | A small package to get structured data out of Les Houches Event files |
| upload_time | 2024-11-05 06:59:09 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | Apache-2.0 |
| keywords |
lhe
physics
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
# pylhe: Python LHE interface
<img src="https://raw.githubusercontent.com/scikit-hep/pylhe/main/docs/_static/img/pylhe-logo.png" alt="pylhe logo" width="250"/>
[](https://github.com/scikit-hep/pylhe)
[](https://doi.org/10.5281/zenodo.1217031)
[](https://scikit-hep.org/)
[](https://pypi.org/project/pylhe/)
[](https://github.com/conda-forge/pylhe-feedstock)
[](https://pypi.org/project/pylhe/)
[](https://github.com/scikit-hep/pylhe/actions/workflows/ci.yml?query=branch%3Amain)
[](https://codecov.io/gh/scikit-hep/pylhe?branch=main)
[](https://results.pre-commit.ci/latest/github/scikit-hep/pylhe/main)
[](https://github.com/psf/black)
Small and thin Python interface to read [Les Houches Event (LHE)](https://inspirehep.net/record/725284) files
## Install
To install `pylhe` from PyPI you can just do
```
python -m pip install pylhe
```
The visualization capabilities require the external dependency of [Graphviz](https://graphviz.org/).
## Get started
The example below provides a simple overview.
Full functionality can be inspected from the functions provided in the `pylhe` module.
### Reading
```python
import itertools
# You can use LHE files from scikit-hep-testdata
from skhep_testdata import data_path
import pylhe
lhe_file = data_path("pylhe-testlhef3.lhe")
events = pylhe.read_lhe_with_attributes(lhe_file)
print(f"Number of events: {pylhe.read_num_events(lhe_file)}")
# Get event 1
event = next(itertools.islice(events, 1, 2))
# A DOT language graph of the event can be inspected as follows
print(event.graph.source)
# The graph is nicely displayed as SVG in Jupyter notebooks
event
# To save a DOT graph render the graph to a supported image format
# (refer to the Graphviz documentation for more)
event.graph.render(filename="test", format="png", cleanup=True)
event.graph.render(filename="test", format="pdf", cleanup=True)
```
### Writing
For a full example see [write](examples/write_monte_carlo_example.ipynb) or [filter](examples/filter_events_example.ipynb).
The values in the sketch below are intentionally left empty since they depend on the use-case.
The data structure of `pylhe` is:
```python
import pylhe
file=pylhe.LHEFile(
init=pylhe.LHEInit(
initInfo=pylhe.LHEInitInfo(
beamA=,
beamB=,
energyA=,
energyB=,
PDFgroupA=,
PDFgroupB=,
PDFsetA=,
PDFsetB=,
weightinStrategy=,
numProcesses=,
),
procInfo=pylhe.LHEProcInfo(
xSection=,
error=,
unitWeight=,
procId=,
),
),
events=[
pylhe.LHEEvent(
eventinfo=pylhe.LHEEventInfo(
nparticles=,
pid=,
weight=,
scale=,
aqed=,
aqcd=,
),
particles=[
pylhe.LHEParticle(
id=,
status=,
mother1=,
mother2=,
color1=,
color2=,
px=,
py=,
pz=,
e=,
m=,
lifetime=,
spin=,
),
...
],
weights=None,
attributes=None,
optional=None,
),
...
]
)
# write to file, compressed if gz/gzip suffix
write_lhe_file(file.init, file.events, "myevents.lhe.gz", rwgt=True, weights=False)
```
## Citation
The preferred BibTeX entry for citation of `pylhe` is
```
@software{pylhe,
author = {Lukas Heinrich and Matthew Feickert and Eduardo Rodrigues and Alexander Puck Neuwirth},
title = "{pylhe: v0.9.1}",
version = {v0.9.1},
doi = {10.5281/zenodo.1217031},
url = {https://github.com/scikit-hep/pylhe},
}
```
## Contributors
We hereby acknowledge the contributors that made this project possible ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tbody>
<tr>
<td align="center" valign="top" width="14.28%"><a href="http://www.matthewfeickert.com/"><img src="https://avatars.githubusercontent.com/u/5142394?v=4?s=100" width="100px;" alt="Matthew Feickert"/><br /><sub><b>Matthew Feickert</b></sub></a><br /><a href="#maintenance-matthewfeickert" title="Maintenance">🚧</a> <a href="#design-matthewfeickert" title="Design">🎨</a> <a href="https://github.com/scikit-hep/pylhe/commits?author=matthewfeickert" title="Code">💻</a> <a href="https://github.com/scikit-hep/pylhe/commits?author=matthewfeickert" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://www.lukasheinrich.com"><img src="https://avatars.githubusercontent.com/u/2318083?v=4?s=100" width="100px;" alt="Lukas"/><br /><sub><b>Lukas</b></sub></a><br /><a href="#maintenance-lukasheinrich" title="Maintenance">🚧</a> <a href="#design-lukasheinrich" title="Design">🎨</a> <a href="https://github.com/scikit-hep/pylhe/commits?author=lukasheinrich" title="Code">💻</a> <a href="https://github.com/scikit-hep/pylhe/commits?author=lukasheinrich" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://cern.ch/eduardo.rodrigues"><img src="https://avatars.githubusercontent.com/u/5013581?v=4?s=100" width="100px;" alt="Eduardo Rodrigues"/><br /><sub><b>Eduardo Rodrigues</b></sub></a><br /><a href="#maintenance-eduardo-rodrigues" title="Maintenance">🚧</a> <a href="https://github.com/scikit-hep/pylhe/commits?author=eduardo-rodrigues" title="Code">💻</a> <a href="https://github.com/scikit-hep/pylhe/commits?author=eduardo-rodrigues" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/8me"><img src="https://avatars.githubusercontent.com/u/17862090?v=4?s=100" width="100px;" alt="Johannes Schumann"/><br /><sub><b>Johannes Schumann</b></sub></a><br /><a href="https://github.com/scikit-hep/pylhe/commits?author=8me" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://iscinumpy.dev"><img src="https://avatars.githubusercontent.com/u/4616906?v=4?s=100" width="100px;" alt="Henry Schreiner"/><br /><sub><b>Henry Schreiner</b></sub></a><br /><a href="https://github.com/scikit-hep/pylhe/commits?author=henryiii" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/ariaradick"><img src="https://avatars.githubusercontent.com/u/53235605?v=4?s=100" width="100px;" alt="ariaradick"/><br /><sub><b>ariaradick</b></sub></a><br /><a href="https://github.com/scikit-hep/pylhe/commits?author=ariaradick" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/jhgoh"><img src="https://avatars.githubusercontent.com/u/4388926?v=4?s=100" width="100px;" alt="Junghwan John Goh"/><br /><sub><b>Junghwan John Goh</b></sub></a><br /><a href="https://github.com/scikit-hep/pylhe/commits?author=jhgoh" title="Code">💻</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/fuenfundachtzig"><img src="https://avatars.githubusercontent.com/u/8006302?v=4?s=100" width="100px;" alt="fuenfundachtzig"/><br /><sub><b>fuenfundachtzig</b></sub></a><br /><a href="https://github.com/scikit-hep/pylhe/commits?author=fuenfundachtzig" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://shantanu-gontia.github.io"><img src="https://avatars.githubusercontent.com/u/4872525?v=4?s=100" width="100px;" alt="Shantanu Gontia"/><br /><sub><b>Shantanu Gontia</b></sub></a><br /><a href="https://github.com/scikit-hep/pylhe/commits?author=shantanu-gontia" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/tomeichlersmith"><img src="https://avatars.githubusercontent.com/u/31970302?v=4?s=100" width="100px;" alt="Tom Eichlersmith"/><br /><sub><b>Tom Eichlersmith</b></sub></a><br /><a href="https://github.com/scikit-hep/pylhe/commits?author=tomeichlersmith" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/APN-Pucky"><img src="https://avatars.githubusercontent.com/u/4533248?v=4?s=100" width="100px;" alt="Alexander Puck Neuwirth"/><br /><sub><b>Alexander Puck Neuwirth</b></sub></a><br /><a href="https://github.com/scikit-hep/pylhe/commits?author=APN-Pucky" title="Code">💻</a></td>
</tr>
</tbody>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.
Raw data
{
"_id": null,
"home_page": null,
"name": "pylhe",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "The Scikit-HEP admins <scikit-hep-admins@googlegroups.com>",
"keywords": "lhe, physics",
"author": null,
"author_email": "Lukas Heinrich <lukas.heinrich@cern.ch>, Matthew Feickert <matthew.feickert@cern.ch>, Eduardo Rodrigues <eduardo.rodrigues@cern.ch>, Alexander Puck Neuwirth <a_neuw01@uni-muenster.de>",
"download_url": "https://files.pythonhosted.org/packages/cf/76/bfcf49d2df49ec91cb7174c41f00d03b73de8f818ae280ad523b36eb4cb5/pylhe-0.9.1.tar.gz",
"platform": null,
"description": "# pylhe: Python LHE interface\n\n<img src=\"https://raw.githubusercontent.com/scikit-hep/pylhe/main/docs/_static/img/pylhe-logo.png\" alt=\"pylhe logo\" width=\"250\"/>\n\n[](https://github.com/scikit-hep/pylhe)\n[](https://doi.org/10.5281/zenodo.1217031)\n[](https://scikit-hep.org/)\n\n[](https://pypi.org/project/pylhe/)\n[](https://github.com/conda-forge/pylhe-feedstock)\n[](https://pypi.org/project/pylhe/)\n\n[](https://github.com/scikit-hep/pylhe/actions/workflows/ci.yml?query=branch%3Amain)\n[](https://codecov.io/gh/scikit-hep/pylhe?branch=main)\n[](https://results.pre-commit.ci/latest/github/scikit-hep/pylhe/main)\n[](https://github.com/psf/black)\n\nSmall and thin Python interface to read [Les Houches Event (LHE)](https://inspirehep.net/record/725284) files\n\n## Install\n\nTo install `pylhe` from PyPI you can just do\n\n```\npython -m pip install pylhe\n```\n\nThe visualization capabilities require the external dependency of [Graphviz](https://graphviz.org/).\n\n## Get started\n\nThe example below provides a simple overview.\nFull functionality can be inspected from the functions provided in the `pylhe` module.\n\n### Reading\n\n```python\nimport itertools\n\n# You can use LHE files from scikit-hep-testdata\nfrom skhep_testdata import data_path\n\nimport pylhe\n\nlhe_file = data_path(\"pylhe-testlhef3.lhe\")\nevents = pylhe.read_lhe_with_attributes(lhe_file)\nprint(f\"Number of events: {pylhe.read_num_events(lhe_file)}\")\n\n# Get event 1\nevent = next(itertools.islice(events, 1, 2))\n\n# A DOT language graph of the event can be inspected as follows\nprint(event.graph.source)\n\n# The graph is nicely displayed as SVG in Jupyter notebooks\nevent\n\n# To save a DOT graph render the graph to a supported image format\n# (refer to the Graphviz documentation for more)\nevent.graph.render(filename=\"test\", format=\"png\", cleanup=True)\nevent.graph.render(filename=\"test\", format=\"pdf\", cleanup=True)\n```\n\n### Writing\n\nFor a full example see [write](examples/write_monte_carlo_example.ipynb) or [filter](examples/filter_events_example.ipynb).\nThe values in the sketch below are intentionally left empty since they depend on the use-case.\nThe data structure of `pylhe` is:\n\n```python\nimport pylhe\n\nfile=pylhe.LHEFile(\n init=pylhe.LHEInit(\n initInfo=pylhe.LHEInitInfo(\n beamA=,\n beamB=,\n energyA=,\n energyB=,\n PDFgroupA=,\n PDFgroupB=,\n PDFsetA=,\n PDFsetB=,\n weightinStrategy=,\n numProcesses=,\n ),\n procInfo=pylhe.LHEProcInfo(\n xSection=,\n error=,\n unitWeight=,\n procId=,\n ),\n ),\n events=[\n pylhe.LHEEvent(\n eventinfo=pylhe.LHEEventInfo(\n nparticles=,\n pid=,\n weight=,\n scale=,\n aqed=,\n aqcd=,\n ),\n particles=[\n pylhe.LHEParticle(\n id=,\n status=,\n mother1=,\n mother2=,\n color1=,\n color2=,\n px=,\n py=,\n pz=,\n e=,\n m=,\n lifetime=,\n spin=,\n ),\n ...\n ],\n weights=None,\n attributes=None,\n optional=None,\n ),\n ...\n ]\n)\n\n# write to file, compressed if gz/gzip suffix\nwrite_lhe_file(file.init, file.events, \"myevents.lhe.gz\", rwgt=True, weights=False)\n\n```\n\n\n## Citation\n\nThe preferred BibTeX entry for citation of `pylhe` is\n\n```\n@software{pylhe,\n author = {Lukas Heinrich and Matthew Feickert and Eduardo Rodrigues and Alexander Puck Neuwirth},\n title = \"{pylhe: v0.9.1}\",\n version = {v0.9.1},\n doi = {10.5281/zenodo.1217031},\n url = {https://github.com/scikit-hep/pylhe},\n}\n```\n\n## Contributors\n\nWe hereby acknowledge the contributors that made this project possible ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->\n<!-- prettier-ignore-start -->\n<!-- markdownlint-disable -->\n<table>\n <tbody>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"http://www.matthewfeickert.com/\"><img src=\"https://avatars.githubusercontent.com/u/5142394?v=4?s=100\" width=\"100px;\" alt=\"Matthew Feickert\"/><br /><sub><b>Matthew Feickert</b></sub></a><br /><a href=\"#maintenance-matthewfeickert\" title=\"Maintenance\">\ud83d\udea7</a> <a href=\"#design-matthewfeickert\" title=\"Design\">\ud83c\udfa8</a> <a href=\"https://github.com/scikit-hep/pylhe/commits?author=matthewfeickert\" title=\"Code\">\ud83d\udcbb</a> <a href=\"https://github.com/scikit-hep/pylhe/commits?author=matthewfeickert\" title=\"Documentation\">\ud83d\udcd6</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"http://www.lukasheinrich.com\"><img src=\"https://avatars.githubusercontent.com/u/2318083?v=4?s=100\" width=\"100px;\" alt=\"Lukas\"/><br /><sub><b>Lukas</b></sub></a><br /><a href=\"#maintenance-lukasheinrich\" title=\"Maintenance\">\ud83d\udea7</a> <a href=\"#design-lukasheinrich\" title=\"Design\">\ud83c\udfa8</a> <a href=\"https://github.com/scikit-hep/pylhe/commits?author=lukasheinrich\" title=\"Code\">\ud83d\udcbb</a> <a href=\"https://github.com/scikit-hep/pylhe/commits?author=lukasheinrich\" title=\"Documentation\">\ud83d\udcd6</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"http://cern.ch/eduardo.rodrigues\"><img src=\"https://avatars.githubusercontent.com/u/5013581?v=4?s=100\" width=\"100px;\" alt=\"Eduardo Rodrigues\"/><br /><sub><b>Eduardo Rodrigues</b></sub></a><br /><a href=\"#maintenance-eduardo-rodrigues\" title=\"Maintenance\">\ud83d\udea7</a> <a href=\"https://github.com/scikit-hep/pylhe/commits?author=eduardo-rodrigues\" title=\"Code\">\ud83d\udcbb</a> <a href=\"https://github.com/scikit-hep/pylhe/commits?author=eduardo-rodrigues\" title=\"Documentation\">\ud83d\udcd6</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/8me\"><img src=\"https://avatars.githubusercontent.com/u/17862090?v=4?s=100\" width=\"100px;\" alt=\"Johannes Schumann\"/><br /><sub><b>Johannes Schumann</b></sub></a><br /><a href=\"https://github.com/scikit-hep/pylhe/commits?author=8me\" title=\"Code\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"http://iscinumpy.dev\"><img src=\"https://avatars.githubusercontent.com/u/4616906?v=4?s=100\" width=\"100px;\" alt=\"Henry Schreiner\"/><br /><sub><b>Henry Schreiner</b></sub></a><br /><a href=\"https://github.com/scikit-hep/pylhe/commits?author=henryiii\" title=\"Code\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/ariaradick\"><img src=\"https://avatars.githubusercontent.com/u/53235605?v=4?s=100\" width=\"100px;\" alt=\"ariaradick\"/><br /><sub><b>ariaradick</b></sub></a><br /><a href=\"https://github.com/scikit-hep/pylhe/commits?author=ariaradick\" title=\"Code\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/jhgoh\"><img src=\"https://avatars.githubusercontent.com/u/4388926?v=4?s=100\" width=\"100px;\" alt=\"Junghwan John Goh\"/><br /><sub><b>Junghwan John Goh</b></sub></a><br /><a href=\"https://github.com/scikit-hep/pylhe/commits?author=jhgoh\" title=\"Code\">\ud83d\udcbb</a></td>\n </tr>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/fuenfundachtzig\"><img src=\"https://avatars.githubusercontent.com/u/8006302?v=4?s=100\" width=\"100px;\" alt=\"fuenfundachtzig\"/><br /><sub><b>fuenfundachtzig</b></sub></a><br /><a href=\"https://github.com/scikit-hep/pylhe/commits?author=fuenfundachtzig\" title=\"Code\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://shantanu-gontia.github.io\"><img src=\"https://avatars.githubusercontent.com/u/4872525?v=4?s=100\" width=\"100px;\" alt=\"Shantanu Gontia\"/><br /><sub><b>Shantanu Gontia</b></sub></a><br /><a href=\"https://github.com/scikit-hep/pylhe/commits?author=shantanu-gontia\" title=\"Code\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/tomeichlersmith\"><img src=\"https://avatars.githubusercontent.com/u/31970302?v=4?s=100\" width=\"100px;\" alt=\"Tom Eichlersmith\"/><br /><sub><b>Tom Eichlersmith</b></sub></a><br /><a href=\"https://github.com/scikit-hep/pylhe/commits?author=tomeichlersmith\" title=\"Code\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/APN-Pucky\"><img src=\"https://avatars.githubusercontent.com/u/4533248?v=4?s=100\" width=\"100px;\" alt=\"Alexander Puck Neuwirth\"/><br /><sub><b>Alexander Puck Neuwirth</b></sub></a><br /><a href=\"https://github.com/scikit-hep/pylhe/commits?author=APN-Pucky\" title=\"Code\">\ud83d\udcbb</a></td>\n </tr>\n </tbody>\n</table>\n\n<!-- markdownlint-restore -->\n<!-- prettier-ignore-end -->\n\n<!-- ALL-CONTRIBUTORS-LIST:END -->\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A small package to get structured data out of Les Houches Event files",
"version": "0.9.1",
"project_urls": {
"Homepage": "https://github.com/scikit-hep/pylhe",
"Issue Tracker": "https://github.com/scikit-hep/pylhe/issues",
"Releases": "https://github.com/scikit-hep/pylhe/releases",
"Source Code": "https://github.com/scikit-hep/pylhe"
},
"split_keywords": [
"lhe",
" physics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cdc41a6616e2f3037407696b06b7fd0105f541c2cfb26cf6097821751aa5043e",
"md5": "7327cc70387829c53eb9d4604624a29e",
"sha256": "406f8418d84e240ccb3174b7692416c6b5c993f41f432af96e59b390017baaf9"
},
"downloads": -1,
"filename": "pylhe-0.9.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7327cc70387829c53eb9d4604624a29e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 14252,
"upload_time": "2024-11-05T06:59:08",
"upload_time_iso_8601": "2024-11-05T06:59:08.269348Z",
"url": "https://files.pythonhosted.org/packages/cd/c4/1a6616e2f3037407696b06b7fd0105f541c2cfb26cf6097821751aa5043e/pylhe-0.9.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cf76bfcf49d2df49ec91cb7174c41f00d03b73de8f818ae280ad523b36eb4cb5",
"md5": "5af4f5903deed966182416f0f9308927",
"sha256": "920c84f344f4e4dbcc080d11a51b4a9d34dec6edadc6feacd258732ba729a668"
},
"downloads": -1,
"filename": "pylhe-0.9.1.tar.gz",
"has_sig": false,
"md5_digest": "5af4f5903deed966182416f0f9308927",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 18550,
"upload_time": "2024-11-05T06:59:09",
"upload_time_iso_8601": "2024-11-05T06:59:09.992973Z",
"url": "https://files.pythonhosted.org/packages/cf/76/bfcf49d2df49ec91cb7174c41f00d03b73de8f818ae280ad523b36eb4cb5/pylhe-0.9.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-05 06:59:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "scikit-hep",
"github_project": "pylhe",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "pylhe"
}
