Skip to main content

soxspipe

Required tests

The data-reduction pipeline for the SOXS instrument (a python package with command-line tools).

Documentation for soxspipe is hosted by Read the Docs (development version and main version). The code lives on github. Please report any issues you find here.

Installation

The best way to install or upgrade soxspipe is to use conda to install the package in its own isolated environment, as shown here:

conda create -n soxspipe python=3.12 soxspipe -c conda-forge
conda activate soxspipe

If you have previously installed soxspipe, a warning will be issued stating that a conda environment already exists; select 'y' when asked to remove the existing environment.

To check installation was successful run soxspipe -v. This should return the version number of the install.

Testing

Install the test dependencies and run the required offline suite with Python 3.12:

python -m pip install -e ".[tests]"
python -m pytest tests/unit tests/integration -m "not slow"

The real-data acceptance test is opt-in. The Real-data tests GitHub Actions workflow runs on pull requests into main and on manual dispatch. It is not a required check, so read its result on the release pull request before you merge. It downloads the immutable archive named by tests/real_data/manifest.json, verifies it, creates a disposable workspace, and runs the NIR offset reduction and the VIS and NIR stare reductions. To run the acceptance assertions locally after preparing that workspace, set SOXSPIPE_REAL_DATA_DIR to its absolute path:

SOXSPIPE_REAL_DATA_DIR=/absolute/path/to/workspace python -m pytest tests/real_data

Changed-line gates

Two gates run on every pull request into develop, and both judge only the lines the pull request changed. Neither one asks the whole package to be clean, so existing debt never blocks an unrelated change:

  • Coverage. diff-cover reports/coverage.xml --compare-branch=origin/develop --fail-under=80 requires 80% coverage of changed lines.
  • Lint. python tools/lint_ratchet.py --compare-branch origin/develop fails when a ruff finding lands on a changed line. Ruff has no baseline feature, so the tool intersects ruff check --output-format json with the diff hunks itself. Pre-existing findings in the files you touched are counted and printed as context, never gated; the package carries roughly 1,380 of them in total, and ruff check soxspipe reports that whole-package figure.

A finding is matched on the line ruff anchors it to. A finding that covers many lines, such as PLR0915 for an over-long function, is anchored at the def line: writing a new over-long function fails the gate, while adding a statement to one that is already over-long does not.

Run the lint gate locally against your staged changes before committing:

python tools/lint_ratchet.py --staged

To run it automatically on every commit, install the hook. It is a convenience, not the gate — git commit --no-verify skips it, and the CI step does not:

python -m pip install -e ".[dev]"
pre-commit install

Format gate

Unlike the changed-line gates, the format gate checks the whole repository. CI runs ruff format --check . on every pull request and fails if any file would be reformatted.

The gate uses the ruff version pinned in the tests extra of pyproject.toml. Another ruff version can format some lines differently, so format with the pinned one:

python -m pip install -e ".[tests]"
ruff format .

The pre-commit hook described above also runs ruff format at the same pinned version.

To hide the one-off formatting commit from git blame, run this once in your clone:

git config blame.ignoreRevsFile .git-blame-ignore-revs

How to cite soxspipe

If you use soxspipe in your work, please cite using the following BibTeX entry:

@software{Young_soxspipe,
    author = {Young, David R. & Landoni, Marco},
    doi = {10.5281/zenodo.8038264},
    license = {GPL-3.0-only},
    title = {{soxspipe. The SOXS data-reduction pipeline}},
    url = {https://zenodo.org/doi/10.5281/zenodo.8038264}
}

Metadata

Release files for soxspipe 0.19.0

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

Source distribution (sdist)

Source distribution for soxspipe 0.19.0
File Size Uploaded Provenance Actions
soxspipe-0.19.0.tar.gz 11.1 MB With provenance Details for soxspipe-0.19.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for soxspipe 0.19.0
File Interpreter ABI Platform Actions
soxspipe-0.19.0-py3-none-any.whl Python 3 none any Details for soxspipe-0.19.0-py3-none-any.whl

Total release size: 22.2 MB

Release files / soxspipe-0.19.0.tar.gz

Download URL soxspipe-0.19.0.tar.gz
Size 11.1 MB
Tags Source
SHA-256 checksum
How to use checksums
5ad7c6a251935dd42f666b1ece8a23bdaebea13b137fb076e6df4e35357725b4
BLAKE2b-256 checksum
How to use checksums
d8194ed1dd3fabbdd4f15f6a0abaa582bda7d86f5b803682e3c112c86914c41c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.

Transparency log

Release files / soxspipe-0.19.0-py3-none-any.whl

Download URL soxspipe-0.19.0-py3-none-any.whl
Size 11.2 MB
Tags Python 3
SHA-256 checksum
How to use checksums
d84ff9e028fe5c5926c5e97a4508ae093e99d548db10dd2caff9640280640a70
BLAKE2b-256 checksum
How to use checksums
2768bca0c1f29b2bb7c39562067f1bf5e33c801e2a440110d3c32510dc522929
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.

Transparency log

Security for soxspipe 0.19.0

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for soxspipe-0.19.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.

Transparency log

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

This release

0.19.0 This release

2 release files Full provenance

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