# SPECTER (v1.0.0)
[](https://github.com/rikab/SPECTER)
[](https://pypi.org/project/pyspecter/)
[](https://pypi.org/project/pyspecter/)
`SPECTER` is an implementation of the Spectral EMD (SEMD) and Spectral Shape Observables as outlined in ["SPECTER: fficient Evaluation of the Spectral EMD" (arxiv:2410.XXXXX)](https://arxiv.org/abs/2410.XXXXX). This package can be used for evaluating an extremely large class of IRC-safe observables, with modules in place to define custom observables and jet algorithms using an intuitive geometric language. Compared to ordinary EMD methods, this package is extremely fast, precise, and accurate. The SEMD is first defined in (arxiv:2305.03751)[https://arxiv.org/abs/2305.03751].
## Example Usage
Several end-to-end examples of how to use `SPECTER` can be found in the `examples` subfolder of this repository. This examples include computing pairwise SEMDs, computing spectral shape observables, and some basic image manipulation.
The code used to perform all of the studies in ["SPECTER: fficient Evaluation of the Spectral EMD" (arxiv:2410.XXXXX)](https://arxiv.org/abs/2410.XXXXX) can be found in the `studies` subfolder.
## Installation
### From PyPI
In your Python environment run
```
python -m pip install pyshaper
# python -m pip install --upgrade 'pyshaper[all]' # for all extras
```
### From this repository locally
In your Python environment from the top level of this repository run:
```bash
pip install -.
```
## Dependencies
The primary dependencies are `jax` and `jaxlib`.
To install jax and jaxlib, run the following commands:
```bash
pip install --upgrade pip
pip install --upgrade jax jaxlib==0.1.69+cuda111 -f https://storage.googleapis.com/jax-releases/jax_releases.html
```
Many of the examples and studies depend on the [ParticleLoader](https://github.com/rikab/ParticleLoader) package for downloading particle physics datasets. However, this package is not necessary for general usage of `SPECTER`
## Changelog
- v1.0.0: 8 October 2024. Official public release.
Based on the work in ["SPECTER: fficient Evaluation of the Spectral EMD" (arxiv:2410.XXXXX)](https://arxiv.org/abs/2410.XXXXX)
Bugs, Fixes, Ideas, or Questions? Contact me at rikab@mit.edu
Raw data
{
"_id": null,
"home_page": "https://github.com/rikab/SPECTER",
"name": "specterpy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "shape observables, jet physics",
"author": "Rikab Gambhir",
"author_email": "Rikab Gambhir <rikab@mit.edu>",
"download_url": "https://files.pythonhosted.org/packages/50/7d/9fa5852d40b7865e38460ecb81d978022da942f88e946d05fae5bcbee162/specterpy-0.0.1.tar.gz",
"platform": null,
"description": "# SPECTER (v1.0.0)\n\n[](https://github.com/rikab/SPECTER)\n\n[](https://pypi.org/project/pyspecter/)\n[](https://pypi.org/project/pyspecter/)\n\n\n`SPECTER` is an implementation of the Spectral EMD (SEMD) and Spectral Shape Observables as outlined in [\"SPECTER: fficient Evaluation of the Spectral EMD\" (arxiv:2410.XXXXX)](https://arxiv.org/abs/2410.XXXXX). This package can be used for evaluating an extremely large class of IRC-safe observables, with modules in place to define custom observables and jet algorithms using an intuitive geometric language. Compared to ordinary EMD methods, this package is extremely fast, precise, and accurate. The SEMD is first defined in (arxiv:2305.03751)[https://arxiv.org/abs/2305.03751].\n\n\n\n\n\n## Example Usage\n\nSeveral end-to-end examples of how to use `SPECTER` can be found in the `examples` subfolder of this repository. This examples include computing pairwise SEMDs, computing spectral shape observables, and some basic image manipulation. \n\nThe code used to perform all of the studies in [\"SPECTER: fficient Evaluation of the Spectral EMD\" (arxiv:2410.XXXXX)](https://arxiv.org/abs/2410.XXXXX) can be found in the `studies` subfolder.\n\n\n## Installation\n\n### From PyPI\n\nIn your Python environment run\n\n```\npython -m pip install pyshaper\n# python -m pip install --upgrade 'pyshaper[all]' # for all extras\n```\n\n### From this repository locally\n\nIn your Python environment from the top level of this repository run:\n\n\n```bash\npip install -.\n```\n\n\n## Dependencies\n\nThe primary dependencies are `jax` and `jaxlib`. \n\nTo install jax and jaxlib, run the following commands:\n\n```bash\npip install --upgrade pip\npip install --upgrade jax jaxlib==0.1.69+cuda111 -f https://storage.googleapis.com/jax-releases/jax_releases.html\n```\n\nMany of the examples and studies depend on the [ParticleLoader](https://github.com/rikab/ParticleLoader) package for downloading particle physics datasets. However, this package is not necessary for general usage of `SPECTER`\n\n## Changelog\n\n- v1.0.0: 8 October 2024. Official public release.\n\nBased on the work in [\"SPECTER: fficient Evaluation of the Spectral EMD\" (arxiv:2410.XXXXX)](https://arxiv.org/abs/2410.XXXXX)\n\nBugs, Fixes, Ideas, or Questions? Contact me at rikab@mit.edu\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "framework for defining, building, and evaluating generalized shape observables for collider physics",
"version": "0.0.1",
"project_urls": {
"Documentation": "https://github.com/rikab/SPECTER",
"Homepage": "https://github.com/rikab/SPECTER",
"Issue Tracker": "https://github.com/rikab/SPECTER/issues",
"Releases": "https://github.com/rikab/SPECTER/releases",
"Source Code": "https://github.com/rikab/SPECTER"
},
"split_keywords": [
"shape observables",
" jet physics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4c00603a144cdd37710af309ac7a4ce67fd99d3c59d87a91edc928c13d472075",
"md5": "55bbb0c064d73df4d010e2d1d1d97ba0",
"sha256": "45459b0c417bf3ddd1d7b2fa930ec66d5fc6cd3df3902514863c392def7fe704"
},
"downloads": -1,
"filename": "specterpy-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "55bbb0c064d73df4d010e2d1d1d97ba0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 23947,
"upload_time": "2024-10-08T23:59:20",
"upload_time_iso_8601": "2024-10-08T23:59:20.765223Z",
"url": "https://files.pythonhosted.org/packages/4c/00/603a144cdd37710af309ac7a4ce67fd99d3c59d87a91edc928c13d472075/specterpy-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "507d9fa5852d40b7865e38460ecb81d978022da942f88e946d05fae5bcbee162",
"md5": "64d664493f85a673d3fbeaddd349ab57",
"sha256": "48d7bff2a0ccad6fdbc568c2d474fde935b04d74a655c974de9e7b221d7772b4"
},
"downloads": -1,
"filename": "specterpy-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "64d664493f85a673d3fbeaddd349ab57",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 20774,
"upload_time": "2024-10-08T23:59:22",
"upload_time_iso_8601": "2024-10-08T23:59:22.533784Z",
"url": "https://files.pythonhosted.org/packages/50/7d/9fa5852d40b7865e38460ecb81d978022da942f88e946d05fae5bcbee162/specterpy-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-08 23:59:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rikab",
"github_project": "SPECTER",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "specterpy"
}
JSON
