Skip to main content

Spinal Tap


CI codecov Documentation Status PyPI version Python

Spinal Tap is a Dash application that provides simple visualization tools for the Scalable Particle Imaging With Neural Embeddings (SPINE) package.

The standard installation and container remain lean and read SPINE HDF5 files. An optional LArCV container adds ROOT, LArCV2, and maintained spine-prod detector conversion bundles so raw LArCV ROOT files can be visualized directly.

Installation

You can install Spinal Tap and all dependencies (including Dash, Flask, Plotly, and spine) using pip:

pip install .

Or, for editable development mode:

pip install -e .

Usage

Launch the application and open http://localhost:8888 in a browser:

spinal-tap

Check the installed version with:

spinal-tap --version

Spinal Tap provides fast WebGL and Plotly renderers, reconstruction/truth comparison, object filtering and inspection, configurable appearance, and portable exports. The complete user guide covers:

See the Spinal Tap documentation for the full installation, usage, deployment, and development guides.

Deployment

Kubernetes

Spinal Tap is deployed on SLAC's S3DF Kubernetes infrastructure and is accessible at:

https://spinal-tap.slac.stanford.edu

S3DF input paths may use either the host form /sdf/data/neutrino/... or the container form /data/...; Spinal Tap resolves both forms automatically.

Readers and built events are cached per application process. The bounds can be configured with SPINAL_TAP_READER_CACHE_SIZE (default 8) and SPINAL_TAP_EVENT_CACHE_SIZE (default 2); set either to 0 to disable that cache. Compact binary scenes are held in an eight-entry process-local LRU while the browser fetches them; configure this bound with SPINAL_TAP_SCENE_CACHE_SIZE (minimum 1).

The Kubernetes configuration files are located in the k8s/ directory. For deployment instructions and SLAC-specific configuration details, see:

Docker

Docker images are automatically built and published to GitHub Container Registry when version tags are pushed:

docker pull ghcr.io/deeplearnphysics/spinal-tap:latest

Use the separate LArCV flavor only when direct ROOT input is needed:

docker pull ghcr.io/deeplearnphysics/spinal-tap:larcv

To run locally with Docker:

docker run -p 8888:8888 ghcr.io/deeplearnphysics/spinal-tap:latest

For LArCV input, run the LArCV image, mount the source data, and select the matching dated detector converter in the Data panel:

docker run --rm -p 8888:8888 -v /host/data:/data:ro \
  ghcr.io/deeplearnphysics/spinal-tap:larcv

Development & CI/CD

  • Code style is enforced with black, isort, and flake8 (pre-commit and CI).
  • The GitHub Actions workflow builds and tests on every commit, PR, tag, and release.
  • The complete test suite enforces 100% statement coverage and publishes its report to Codecov.
  • Docker images are built automatically on version tag pushes (e.g., v0.1.2).
  • Publishing:
    • On tag push: publishes to Test PyPI (requires TEST_PYPI_API_TOKEN secret).
    • On GitHub Release: publishes to PyPI (requires PYPI_API_TOKEN secret).

Metadata

Release files for spinal-tap 1.2.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for spinal-tap 1.2.2
File Size Uploaded Provenance Actions
spinal_tap-1.2.2.tar.gz 832.1 kB Without provenance Details for spinal_tap-1.2.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for spinal-tap 1.2.2
File Interpreter ABI Platform Actions
spinal_tap-1.2.2-py3-none-any.whl Python 3 none any Details for spinal_tap-1.2.2-py3-none-any.whl

Total release size: 1.6 MB

Release files / spinal_tap-1.2.2.tar.gz

Download URL spinal_tap-1.2.2.tar.gz
Size 832.1 kB
Tags Source
SHA-256 checksum
How to use checksums
9a2cedeba3f7cd5f3f4a6995cba5b0386524694f0b568f75b7843b2d3395adb7
BLAKE2b-256 checksum
How to use checksums
d462a5579d2ea6b72f39fcb5aa12fa122e0cea844538714da632f67d5ffd8652
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.17

Release files / spinal_tap-1.2.2-py3-none-any.whl

Download URL spinal_tap-1.2.2-py3-none-any.whl
Size 794.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
099965865f8c6cd71251fc275aa95fe68d195faa40220df5dbddbc71cab4e6ef
BLAKE2b-256 checksum
How to use checksums
d99248b953c103e211e06c31437d90e11a3b178bcdbcaa4bcdf84395acb7cb0e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.17

Security for spinal-tap 1.2.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page