soxspipe

https://zenodo.org/badge/186854638.svg

https://img.shields.io/pypi/pyversions/soxspipe https://img.shields.io/pypi/v/soxspipe https://img.shields.io/conda/vn/conda-forge/soxspipe https://static.pepy.tech/badge/soxspipe/month https://img.shields.io/github/license/thespacedoctor/soxspipe

https://soxs-eso-data.org/ci/buildStatus/icon?job=soxspipe%2Fmaster&subject=build%20master https://soxs-eso-data.org/ci/buildStatus/icon?job=soxspipe%2Fdevelop&subject=build%20dev https://cdn.jsdelivr.net/gh/thespacedoctor/soxspipe@master/coverage.svg https://readthedocs.org/projects/soxspipe/badge/?version=master https://img.shields.io/github/issues/thespacedoctor/soxspipe/type:%20bug?label=bug%20issues

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 master 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.9 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.

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.8038265},
    license = {GPL-3.0-only},
    title = ,
    url = {https://github.com/thespacedoctor/soxspipe}
}

Acknowledgements