Skip to main content

A python package and command-line tools to The data-reduction pipeline for the SOXS instrument

Project description

soxspipe

Documentation Status

Coverage Status

The data-reduction pipeline for the SOXS instrument.

Command-Line Usage

Documentation for soxspipe can be found here: http://soxspipe.readthedocs.org/en/stable

Usage:
    soxspipe init
    soxspipe [-s <pathToSettingsFile>]

Options:
    init                                   setup the soxspipe settings file for the first time
    -h, --help                             show this help message
    -v, --version                          show version
    -s, --settings <pathToSettingsFile>    the settings file

Documentation

Documentation for soxspipe is hosted by Read the Docs (last stable version and latest version).

Installation

The easiest way to install soxspipe is to use pip:

pip install soxspipe

Or you can clone the github repo and install from a local version of the code:

git clone git@github.com:thespacedoctor/soxspipe.git
cd soxspipe
python setup.py install

To upgrade to the latest version of soxspipe use the command:

pip install soxspipe --upgrade

Development

If you want to tinker with the code, then install in development mode. This means you can modify the code from your cloned repo:

git clone git@github.com:thespacedoctor/soxspipe.git
cd soxspipe
python setup.py develop

Pull requests are welcomed!

Issues

Please report any issues here.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

soxspipe-0.1.tar.gz (14.8 kB view hashes)

Uploaded Source

Built Distribution

soxspipe-0.1-py2-none-any.whl (18.5 kB view hashes)

Uploaded Python 2

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page