Command Line Interface¶
Documentation for using the command line interface, which provides CLI tools to run, view, parse, and analyze data sets.
ucal¶
ucal [OPTIONS] COMMAND [ARGS]...
anl¶
Commands for performing analysis.
ucal anl [OPTIONS] COMMAND [ARGS]...
make-sensitivity-coeffs¶
Load and analyze a sensitivity run. Takes in a sensitivity experiment and generate sensitivity coefficients and other relevant data.
ucal anl make-sensitivity-coeffs [OPTIONS] PARSED_DCSWEEP
Options
- --constrain-zero¶
Constrains the fit to zero. The default is False.
- --p-of-e¶
Fit power as a function of thermopile voltage.
- --deg <deg>¶
Fit degrees of polynomial, the default is 2.
- -o, --output-file <output_file>¶
If provided, outputs any saveable objects to an HDF5 file, by default None.
- --show-plots¶
If true, shows the plots in a gui and freezes the terminal, by default False.
- --save-plots <save_plots>¶
If provided, save plots in this directory
- --plot-ext <plot_ext>¶
Save extension for the output plots.
Arguments
- PARSED_DCSWEEP¶
Required argument
dcsweep¶
Commands for interacting with DCSweep measurements.
ucal dcsweep [OPTIONS] COMMAND [ARGS]...
parse¶
Load and analyze a sensitivity run. Takes in a sensitivty experiment and generate sensitivity coefficients and other relevant data.
ucal dcsweep parse [OPTIONS] METADATA
Options
- -o, --output-file <output_file>¶
If provided, outputs any saveable objects to an HDF5 file, by default None.
- --settings <settings>¶
Path to experiment settings. Assumed to be a file called settings.csv in metadata directory if not provided.
- --measlist <measlist>¶
Path to experiment meas list. Assumed to be a file called measlist.csv in metadata directory if not provided.
- --zero-limit <zero_limit>¶
Treats anything below this as a zero for threshholding.
- --source-threshhold <source_threshhold>¶
Value to look for in difference in source to detect steps.
- --avg-window-size-secs <avg_window_size_secs>¶
Time window to average samples over in seconds.
- --avg-window-shiftback_secs <avg_window_shiftback_secs>¶
Shift back the averaging window start time by this amount.
- --imm-step <imm_step>¶
If true, fits immediately after the step instead of relative to the
- --show-plots¶
If true, shows the plots in a gui and freezes the terminal, by default False.
- --save-plots <save_plots>¶
If provided, saves plots to this directory. The default is None.
- --plot-ext <plot_ext>¶
File extension to save plots as. The default is ‘.png.’.
- --repeatability-id <repeatability_id>¶
If provided, used as id for uncertainty origin in calculation.
Arguments
- METADATA¶
Required argument
run¶
DCSweep experiment for microcalorimeter. Source a series of voltages while monitoring the thermopile.
ucal dcsweep run [OPTIONS] SETTINGS MEASLIST OUTPUT_DIR
Options
- --dry-run¶
If True, attempts to validate the measurement.
Arguments
- SETTINGS¶
Required argument
- MEASLIST¶
Required argument
- OUTPUT_DIR¶
Required argument
gui¶
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.
ucal rfsweep [OPTIONS] COMMAND [ARGS]...
run¶
Run a microcalorimetry RF Sweep experiment.
ucal rfsweep run [OPTIONS] OUTPUT_DIR
Options
- --repeats <repeats>¶
Number of repeats to perform on all settings files. The default is None.
- -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