soxspipe

https://img.shields.io/pypi/pyversions/soxspipe https://img.shields.io/pypi/v/soxspipe https://img.shields.io/github/license/thespacedoctor/soxspipe https://img.shields.io/pypi/dm/soxspipe

http://167.99.90.204:8080/buildStatus/icon?job=soxspipe%2Fmaster&subject=build%20master http://167.99.90.204:8080/buildStatus/icon?job=soxspipe%2Fdevelop&subject=build%20dev https://cdn.jsdelivr.net/gh/thespacedoctor/soxspipe@master/coverage.svg https://readthedocs.org/projects/soxspipe/badge/ 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 (last stable version and latest version). The code lives on github. Please report any issues you find here.

API Reference

Modules

soxspipe.commonutils

common tools used throughout package

soxspipe.recipes

The pipeline recipes

soxspipe.docstring_test

Testing the rendering of docstings - feel free to remove this module

soxspipe.utKit

Unit testing tools

Classes

soxspipe.commonutils.keyword_lookup

The worker class for the keyword_lookup module

soxspipe.commonutils.set_of_files

The worker class for the sof module used to homogenise various frame input formats (sof file, directory of fits fits, list of fits file paths) into a CCDProc ImageFileCollection

soxspipe.recipes.soxs_mbias

The soxs_mbias recipe

soxspipe.recipes.soxs_mdark

The soxs_mdark recipe

Functions

soxspipe.docstring_test.docsting_test

the database object for sherlock, setting up ssh tunnels and various database connections

Release Notes

  • inject a ‘SOXSPIPE PRE’ keyword with timestamp value into prepared frames

  • check frames for ‘SOXSPIPE PRE’ keyword before preparing - raises exception if found

  • moved basic input frame verifications to the _base_recipe - so not to repeat code

  • added mixing of readout speeds to input frame verification checks

  • added a cleanup method to remove intermediate file once receipe completes

  • removed python 2.7 support - not feasible with CCDProc

v0.2.0 - February 27, 2020

  • added keyword lookups - abstracting exact keyword names from code