Skip to main content

framework for defining, building, and evaluating generalized shape observables for collider physics

Project description

SPECTER (v1.0.0)

GitHub Project

PyPI version Supported Python versions

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). 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) 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:

pip install -.

Dependencies

The primary dependencies are jax and jaxlib.

To install jax and jaxlib, run the following commands:

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 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)

Bugs, Fixes, Ideas, or Questions? Contact me at rikab@mit.edu

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

specterpy-0.0.1.tar.gz (20.8 kB view details)

Uploaded Source

Built Distribution

specterpy-0.0.1-py3-none-any.whl (23.9 kB view details)

Uploaded Python 3

File details

Details for the file specterpy-0.0.1.tar.gz.

File metadata

  • Download URL: specterpy-0.0.1.tar.gz
  • Upload date:
  • Size: 20.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for specterpy-0.0.1.tar.gz
Algorithm Hash digest
SHA256 48d7bff2a0ccad6fdbc568c2d474fde935b04d74a655c974de9e7b221d7772b4
MD5 64d664493f85a673d3fbeaddd349ab57
BLAKE2b-256 507d9fa5852d40b7865e38460ecb81d978022da942f88e946d05fae5bcbee162

See more details on using hashes here.

File details

Details for the file specterpy-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: specterpy-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 23.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for specterpy-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 45459b0c417bf3ddd1d7b2fa930ec66d5fc6cd3df3902514863c392def7fe704
MD5 55bbb0c064d73df4d010e2d1d1d97ba0
BLAKE2b-256 4c00603a144cdd37710af309ac7a4ce67fd99d3c59d87a91edc928c13d472075

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page