soxspipe.cl_utils

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

Usage: soxspipe –version soxspipe prep [ –vlt –refresh] soxspipe [-qwpVm] reduce all [ -b -s ] soxspipe [-qxV] reduce sof [ -s ] soxspipe session ((ls|new|)|new ) soxspipe list (ob|sof) [ -s ] soxspipe raw sof [ -s ] soxspipe [-Vxd] mdark [-o -s ] soxspipe [-Vxd] mbias [-o -s ] soxspipe [-Vxd] disp_solution [-o -s –poly=] soxspipe [-Vxd] order_centres [-o -s –poly=] soxspipe [-Vxd] mflat [-o -s ] soxspipe [-Vxd] spat_solution [-o -s –poly=] soxspipe [-Vxd] stare [-o -s ] soxspipe [-Vxd] nod [-o -s ] soxspipe [-Vxd] offset [-o -s ] soxspipe watch (start|stop|status) [-s ]

Options: list ob list all observations within the workspace list sof list all science object SOF files within the workspace prep prepare a folder of raw data (workspace) for data reduction session ls list all available data-reduction sessions in the workspace session new [] start a new data-reduction session, optionally give a name up to 16 characters A-Z, a-z, 0-9 and/or _- session use an existing data-reduction session (use session ls to see all IDs) reduce all reduce all of the data in a workspace. reduce sof reduce a single science object SOF file. raw sof export all the raw frames needed to reduce a science object SOF file to a directory called exported in the current working directory.

mbias                                  the master bias recipe
mdark                                  the master dark recipe
mflat                                  the master flat recipe
disp_solution                          the disp solution recipe
order_centres                          the order centres recipe
spat_solution                          the spatial solution recipe
stare                                  reduce stare mode science frames
nod                                    reduce nodding mode science frames
offset                                 reduce offset mode science frames

start                                   start the watch daemon
stop                                    stop the watch daemon
status                                  print the status of the watch daemon

inputFrames                            path to a directory of frames or a set-of-files file

-b, --batch                            reduce data in batches of <batchSize> recipes (only when reducing all data)
-d, --debug                            show debugging plots
-h, --help                             show this help message
-m, --multiprocess                     run reductions of recipe in parallel (experimental, use with caution and check your results carefully if using this flag)
-p, --prep                             prepare a workspace before reducing data
-q, --quitOnFail                       stop the pipeline if a recipe fails
-r, --refresh                          trigger a complete refresh the workspace during preparation (delete database and do a complete prepare)
-s, --settings <pathToSettingsFile>    the settings file
-v, --version                          show version
-V, --verbose                          more verbose output
-w, --watch                            watch the workspace and reduce new raw data as it is added (similar to 'watch' mode but runs in the foreground)
-x, --overwrite                        more verbose output
--poly=<ORDERS>                        polynomial degrees (overrides parameters found in setting file). oowwss = order_x,order_y,wavelength_x,wavelength_y,slit_x,slit_y e.g. 345435. od = order,dispersion-axis
--vlt                                  only use this flag if setting up a workspace on a VLT environment workstation

Module Contents

Functions

main	The main function used when cl_utils.py is run as a single script from the cl, or when installed as a cl command
tab_complete

API

soxspipe.cl_utils.main(arguments=None)

The main function used when cl_utils.py is run as a single script from the cl, or when installed as a cl command

soxspipe.cl_utils.tab_complete(text, state)