# soxspipe
[](https://zenodo.org/doi/10.5281/zenodo.8038264)
<!-- INFO BADGES -->
[](https://pypi.org/project/soxspipe/)
[](https://pypi.org/project/soxspipe/)
[](https://anaconda.org/conda-forge/soxspipe)
[](https://pepy.tech/project/soxspipe)
[](https://github.com/thespacedoctor/soxspipe)
<!-- STATUS BADGES -->
[](https://soxs-eso-data.org/ci/blue/organizations/jenkins/soxspipe/activity?branch=master)
[](https://soxs-eso-data.org/ci/blue/organizations/jenkins/soxspipe/activity?branch=develop)
[](https://raw.githack.com/thespacedoctor/soxspipe/master/htmlcov/index.html)
[](https://soxspipe.readthedocs.io/en/master/)
[](https://github.com/thespacedoctor/soxspipe/issues?q=is%3Aissue+is%3Aopen+label%3A%22type%3A+bug%22+)
*The data-reduction pipeline for the SOXS instrument* (a python package with command-line tools).
Documentation for soxspipe is hosted by [Read the Docs](https://soxspipe.readthedocs.io/en/master/) ([development version](https://soxspipe.readthedocs.io/en/develop/) and [master version](https://soxspipe.readthedocs.io/en/master/)). The code lives on [github](https://github.com/thespacedoctor/soxspipe). Please report any issues you find [here](https://github.com/thespacedoctor/soxspipe/issues).
## 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:
``` bash
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:
```bibtex
@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}
}
```
Raw data
{
"_id": null,
"home_page": "https://github.com/thespacedoctor/soxspipe",
"name": "soxspipe",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "soxs, eso, data, pipeline, spectra",
"author": "David Young",
"author_email": "davidrobertyoung@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/d9/e2/3b862731beae8e299cc2aeb3ef894a4fbcb626d5606e6491c516611c3485/soxspipe-0.11.6.tar.gz",
"platform": null,
"description": "# soxspipe\n\n\n\n[](https://zenodo.org/doi/10.5281/zenodo.8038264) \n\n\n\n\n<!-- INFO BADGES --> \n\n[](https://pypi.org/project/soxspipe/)\n[](https://pypi.org/project/soxspipe/)\n[](https://anaconda.org/conda-forge/soxspipe)\n[](https://pepy.tech/project/soxspipe)\n[](https://github.com/thespacedoctor/soxspipe)\n\n<!-- STATUS BADGES --> \n\n[](https://soxs-eso-data.org/ci/blue/organizations/jenkins/soxspipe/activity?branch=master)\n[](https://soxs-eso-data.org/ci/blue/organizations/jenkins/soxspipe/activity?branch=develop)\n[](https://raw.githack.com/thespacedoctor/soxspipe/master/htmlcov/index.html)\n[](https://soxspipe.readthedocs.io/en/master/)\n[](https://github.com/thespacedoctor/soxspipe/issues?q=is%3Aissue+is%3Aopen+label%3A%22type%3A+bug%22+)\n\n*The data-reduction pipeline for the SOXS instrument* (a python package with command-line tools).\n\nDocumentation for soxspipe is hosted by [Read the Docs](https://soxspipe.readthedocs.io/en/master/) ([development version](https://soxspipe.readthedocs.io/en/develop/) and [master version](https://soxspipe.readthedocs.io/en/master/)). The code lives on [github](https://github.com/thespacedoctor/soxspipe). Please report any issues you find [here](https://github.com/thespacedoctor/soxspipe/issues).\n\n## Installation\n\nThe best way to install or upgrade soxspipe is to use `conda` to install the package in its own isolated environment, as shown here:\n\n``` bash\nconda create -n soxspipe python=3.9 soxspipe -c conda-forge\nconda activate soxspipe\n```\n\nIf 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.\n\nTo check installation was successful run `soxspipe -v`. This should return the version number of the install.\n\n## How to cite soxspipe\n\nIf you use `soxspipe` in your work, please cite using the following BibTeX entry: \n\n```bibtex\n@software{Young_soxspipe,\n author = {Young, David R. & Landoni, Marco},\n doi = {10.5281/zenodo.8038264},\n license = {GPL-3.0-only},\n title = {{soxspipe. The SOXS data-reduction pipeline}},\n url = {https://zenodo.org/doi/10.5281/zenodo.8038264}\n}\n```\n\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "A python package and command-line tools to The data-reduction pipeline for the SOXS instrument",
"version": "0.11.6",
"project_urls": {
"Download": "https://github.com/thespacedoctor/soxspipe/archive/v0.11.6.zip",
"Homepage": "https://github.com/thespacedoctor/soxspipe"
},
"split_keywords": [
"soxs",
" eso",
" data",
" pipeline",
" spectra"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d9e23b862731beae8e299cc2aeb3ef894a4fbcb626d5606e6491c516611c3485",
"md5": "db93f3f9d121f92d6f333968ee49ed05",
"sha256": "02f378fb014b7407a87c703782c4d661263da34ab4bf8bd227b412af96ab003b"
},
"downloads": -1,
"filename": "soxspipe-0.11.6.tar.gz",
"has_sig": false,
"md5_digest": "db93f3f9d121f92d6f333968ee49ed05",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3001892,
"upload_time": "2024-10-15T15:10:16",
"upload_time_iso_8601": "2024-10-15T15:10:16.419488Z",
"url": "https://files.pythonhosted.org/packages/d9/e2/3b862731beae8e299cc2aeb3ef894a4fbcb626d5606e6491c516611c3485/soxspipe-0.11.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-15 15:10:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thespacedoctor",
"github_project": "soxspipe",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "soxspipe"
}
JSON
