Command Line Interface

Documentation for using the command line interface, which provides CLI tools to run, view, parse, and analyze data sets.

ucal

Usage

ucal [OPTIONS] COMMAND [ARGS]...

dcsweep

Commands for interacting with DCSweep measurements.

Usage

ucal dcsweep [OPTIONS] COMMAND [ARGS]...

run

DCSweep experiment for microcalorimeter. Source a series of voltages while monitoring the thermopile.

Usage

ucal dcsweep run [OPTIONS] OUTPUT_DIR

Options

--initial-wait <initial_wait>

Wait this long before starting a measurement. Will measure about

-c, --config-files <config_files>

Required Settings files for experiment.

-s, --runlist <runlist>

Voltage measurment list for experiment.

--meas-name <meas_name>

Name of measurement. Default is ‘dcsweep’.

--dry-run

If True, attempts to validate the measurement.

Arguments

OUTPUT_DIR

Required argument

gui

Usage

ucal gui [OPTIONS]

Options

--no-console-stdout

Sets the stdout to the GUIs internal console (buggy, a terminal console is nicer).

rfsweep

Commands for interacting with RFSweep measurements.

Usage

ucal rfsweep [OPTIONS] COMMAND [ARGS]...

run

Run a microcalorimetry RF Sweep experiment.

Usage

ucal rfsweep run [OPTIONS] OUTPUT_DIR

Options

-c, --configs <configs>

Required Config files for experiment settings / instruments. The default is None.

-s, --settings <settings>

Required Run settings files, looped over for experiment. The default is None. Each

-m, --sensor-master-list <sensor_master_list>

Required Master list of sensors and resitance/sensitivity values to use for

-n, --name <name>

Name of measurement. The default is None.

--no-confirm

If True, skips any confirmations that may be asked when starting

--dry-run

If true, will try to load the configurations without actually running

Arguments

OUTPUT_DIR

Required argument