soxspipe
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 the 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
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.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| soxspipe-0.19.1.tar.gz | 11.2 MB | With provenance | Details for soxspipe-0.19.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| soxspipe-0.19.1-py3-none-any.whl | Python 3 | none | any | Details for soxspipe-0.19.1-py3-none-any.whl |
Total release size: 22.5 MB
Release files / soxspipe-0.19.1.tar.gz
| Download URL | soxspipe-0.19.1.tar.gz |
|---|---|
| Size | 11.2 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
40dfaeb9ea92c3e1f12cddac35ae66e08051c6eb633b336e0b3a3d1e4e452e3e
|
|
BLAKE2b-256 checksum How to use checksums |
ec08b612f3efe5bbf2ef0746f4f48d8d225d3f979ba3822e985ba3f9e90ecfe8
|
| 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 Nov 6, 2026.
Transparency logRelease files / soxspipe-0.19.1-py3-none-any.whl
| Download URL | soxspipe-0.19.1-py3-none-any.whl |
|---|---|
| Size | 11.3 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
89d8e2b7cdbcd2bb5abab64b2e66bc6addfb551001e79694a6fb8b124720f7ac
|
|
BLAKE2b-256 checksum How to use checksums |
84d9ab0494f75c22852b6c88116a2bfaa03a821e9c70f4f4b8ff7eb9f77df4b0
|
| 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 Nov 6, 2026.
Transparency logSecurity for soxspipe 0.19.1
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.
Attestation for soxspipe-0.19.1.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 Nov 6, 2026.
Transparency logA 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.