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.2410.05379). 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.2410.05379) can be found in the studies subfolder.

Installation

From PyPI

In your Python environment run

python -m pip install specterpy

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.1.0: 13 May 2025. Added support for cylindrical metrics. Added support for unbalanced OT. Resolved bugs relating to zero-padding.
  • 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-1.1.0.tar.gz (903.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

specterpy-1.1.0-py3-none-any.whl (909.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: specterpy-1.1.0.tar.gz
  • Upload date:
  • Size: 903.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.16

File hashes

Hashes for specterpy-1.1.0.tar.gz
Algorithm Hash digest
SHA256 81e6c04b731dcadaf4562223f551e22962c7768244b87ddc7b664fc8ef09eb1e
MD5 614ee04254030786741ea22a7e44f12c
BLAKE2b-256 7d0c25370ef8f851d56f7ce176ddd6d6fe3627e635cd27516141af2282b13e2c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: specterpy-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 909.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.16

File hashes

Hashes for specterpy-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f48a78cd92d1bf94a9ff67f874aab3af4eb166d4e9555a42dbdc09303fc3bc7d
MD5 7da8ec8cd53fc7eecab4c059b1988499
BLAKE2b-256 29502fe0ede4e671261d01d8f384c95e600ffdd5da45600b402c3c5cd4219b66

See more details on using hashes here.

Supported by

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