Command Line Interface

A command line interface is provided is provided with the source code for running the analysis pipeline. An outline of the command line arguments and their default values is provided below.

usage: snat-sim [-h] [-v] -c CADENCE [-s SIM_POOL_SIZE] [-f FIT_POOL_SIZE]
                [-w WRITE_POOL_SIZE] [-i ITER_LIM] -o OUT_PATH
                [--write_lc_sims] [--sim_source SIM_SOURCE] --sim_variability
                SIM_VARIABILITY [--ref_stars REF_STARS [REF_STARS ...]]
                [--fit_source FIT_SOURCE] --fit_variability FIT_VARIABILITY
                [--vparams VPARAMS [VPARAMS ...]] [--bound_z BOUND_Z BOUND_Z]
                [--bound_t0 BOUND_T0 BOUND_T0] [--bound_x0 BOUND_X0 BOUND_X0]
                [--bound_x1 BOUND_X1 BOUND_X1] [--bound_c BOUND_C BOUND_C]
                [--receiver_id RECEIVER_ID]
                [--pwv_model_years PWV_MODEL_YEARS [PWV_MODEL_YEARS ...]]
                [--cut_PWV CUT_PWV CUT_PWV]
                [--cut_SrfcPress CUT_SRFCPRESS CUT_SRFCPRESS]
                [--cut_SrfcTemp CUT_SRFCTEMP CUT_SRFCTEMP]
                [--cut_SrfcRH CUT_SRFCRH CUT_SRFCRH]
                [--cut_ZenithDelay CUT_ZENITHDELAY CUT_ZENITHDELAY]
                [--no-scatter] [--fixed-snr FIXED_SNR] [--visualize]
                [--host HOST] [--port PORT] [--proxy PROXY]

Named Arguments

-v, --version

show program’s version number and exit

-c, --cadence

Observational cadence to assume for the LSST.

-s, --sim_pool_size

Total number of workers to spawn for simulating supernova light-curves.

Default: 1

-f, --fit_pool_size

Total number of workers to spawn for fitting light-curves.

Default: 1

-w, --write_pool_size

Total number of workers to spawn for writing data to disk.

Default: 1

-i, --iter_lim

Exit pipeline after processing the given number of light-curves (Useful for profiling).

Default: inf

-o, --out_path

Output file path (a .h5 extension is enforced).

--write_lc_sims

Flag to include simulated light curves in the pipeline output file. Note the added IO may noticeably increase the pipeline runtime.

Default: False

Light-Curve Simulation

Options for simulating supernova light-curves.

--sim_source

The name of the sncosmo spectral template to use when simulating supernova light-curves.

Default: “salt2-extended”

--sim_variability

Rate at which to vary PWV when simulating light-curves. Specify a numerical value for a fixed PWV concentration. Specify “epoch” to vary the PWV per observation.

--ref_stars

Reference star(s) to calibrate simulated SNe against.

Default: (‘G2’, ‘M5’, ‘K2’)

Light-Curve Fitting

Options for configuring supernova light-curve fits.

--fit_source

The name of the sncosmo spectral template to use when fitting supernova light-curves.

Default: “salt2-extended”

--fit_variability

Rate at which to vary the assumed PWV when fitting light-curves. Specify a numerical value for a fixed PWV concentration. Specify “epoch” to vary the PWV per observation.

--vparams

Parameters to vary when fitting light-curves.

Default: (‘x0’, ‘x1’, ‘c’)

--bound_z

Upper and lower bounds for z parameter when fitting light-curves (Optional).

--bound_t0

Upper and lower bounds for t0 parameter when fitting light-curves (Optional).

--bound_x0

Upper and lower bounds for x0 parameter when fitting light-curves (Optional).

--bound_x1

Upper and lower bounds for x1 parameter when fitting light-curves (Optional).

--bound_c

Upper and lower bounds for c parameter when fitting light-curves (Optional).

PWV Modeling

Options used when building the PWV variability model from SuomiNet GPS data.

--receiver_id

Default: “ctio”

--pwv_model_years

Default: [2016, 2017]

--cut_PWV

Only use measured data points with a PWV value within the given bounds (units of millimeters)

Default: [0, 30]

--cut_SrfcPress

Only use measured data points with a surface pressure value within the given bounds (units of Millibars)

--cut_SrfcTemp

Only use measured data points with a temperature value within the given bounds (units of Centigrade)

--cut_SrfcRH

Only use measured data points with a relative humidity value within the given bounds (units of Percentage)

--cut_ZenithDelay

Only use measured data points with a zenith delay value within the given bounds (units of Millimeters)

Debugging / Validation

Options used when debugging pipeline behavior.

--no-scatter

Flag used to turn off added scatter when simulating light-curves.

Default: False

--fixed-snr

Simulate light-curves with a fixed signal to noise ratio.

Pipeline Visualization

Optionally launch a server instance for monitoring the pipeline in real time.

--visualize

Flag used to launch a web server for visualizing the current pipeline status.

Default: False

--host

Optionally define the host IP used to serve the application from.

--port

Optionally define the port used to serve the application.

--proxy

Optionally use a proxy to serve the application to a different URL “{input}::{output}”.