microcalorimetry.measurements.dcsweep

Created on Tue Oct 17 10:26:25 2023

@author: dcg2

Functions

run(→ str)	DCSweep experiment for microcalorimeter.
parse(→ tuple[microcalorimetry.configs.ParsedDCSweep, ...)	Load and analyze a sensitivity run.

Package Contents

microcalorimetry.measurements.dcsweep.run(settings: str, measlist: str, output_dir: str = '.', dry_run: bool = False) → str

DCSweep experiment for microcalorimeter.

Source a series of voltages while monitoring the thermopile.

Parameters:

staircase_settingsstr

Settings files for experiment.

staircase_measliststr

Voltage measurment list for experiment.

output_dirstr

Directory to output to, creats a new folder inside of to store csv files.

dry_runbool, optional

If True, attempts to validate the measurement.

Returns:

str.

path to metadata location of output file.

microcalorimetry.measurements.dcsweep.parse(metadata: pathlib.Path, settings: pathlib.Path = None, measlist: pathlib.Path = None, zero_limit: float = 0, source_threshhold: float = 0.01, avg_window_size_secs: float = 3000, avg_window_shiftback_secs: float = 0, imm_step: bool = False, make_plots: bool = False, repeatability_id: str = 'dc_sweep') → tuple[microcalorimetry.configs.ParsedDCSweep, list[matplotlib.pyplot.Figure]]

Load and analyze a sensitivity run.

Takes in a sensitivty experiment and generate sensitivity coefficients and other relevant data.

Parameters:

metadataPath

Path to datarecord metadata

settingsPath, optional

Path to experiment settings. Assumed to be a file called settings.csv in metadata directory if not provided.

measlistPath, optional

Path to experiment meas list. Assumed to be a file called measlist.csv in metadata directory if not provided.

zero_limitfloat, optional

Treats anything below this as a zero for threshholding. Somtimes the SMU is noisy when it tries to source zero, and that throws off the threshholding. The default is 0.1.

source_threshholdfloat, optional

Value to look for in difference in source to detect steps. The default is 0.1.

avg_window_size_secsfloat, optional

Time window to average samples over in seconds. The default is 3000.

avg_window_shiftback_secsfloat, optional

Shift back the averaging window start time by this amount. Averaging start time is end of step - avg_window_size_secs - avg_window_shiftback_secs. The default is 0.

imm_stepbool, optional

If true, fits immediately after the step instead of relative to the end of a step. The default is False.

make_plotsbool, optional

If true, generates plots. The default is True.

repeatability_idstr, optional

If provided, used as id for uncertainty origin in calculation. The default is ‘dc_sweep’.

Returns:

parsed_dcconfigs.ParsedDCSweep

ParsedCalibration object and any figures generated

figureslist[plt.Figure]

Generated figures.