microcalorimetry.measurements.dcsweep

Created on Tue Oct 17 10:26:25 2023

@author: dcg2

Functions

run(→ str)	DCSweep experiment for microcalorimeter.
parse_v0(...)	Load and analyze the initial draft of a DC sweep run.
parse_v1(...)	Parse version 1 of a DC sweep calibration measurement.

Package Contents

microcalorimetry.measurements.dcsweep.run(config_files: list[pathlib.Path], runlist: pathlib.Path, output_dir: str = '.', meas_name: str = 'dcsweep', dry_run: bool = False, validate: bool = True, initial_wait: float = 0) → str

DCSweep experiment for microcalorimeter.

Source a series of voltages while monitoring the thermopile.

Parameters:

config_fileslist[Path]

Settings files for experiment.

runlistPath

Voltage measurment list for experiment.

output_dirstr

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

meas_namestr, optional

Name of measurement. Default is ‘dcsweep’.

dry_runbool, optional

If True, attempts to validate the measurement.

validatebool, optional

Validate settings against a schema.

initial_waitfloat, optional

Wait this long before starting a measurement. Will measure about zero source for this duration.

Returns:

str.

path to metadata location of output file.

microcalorimetry.measurements.dcsweep.parse_v0(metadata: pathlib.Path, settings: pathlib.Path = None, measlist: pathlib.Path = None, on_time_window: float = 300, off_time_window: float = 300, heater_instr_name: str = 'SMU', sensor_instr_name: str = 'NVM', thermometer_instr_name: str = 'Thermometer', zero_threshhold: float = 1e-06, transition_threshhold_watts: float = 1e-05, make_plots: bool = True) → tuple[microcalorimetry.configs.ParsedDCSweep, list[matplotlib.pyplot.Figure]]

Load and analyze the initial draft of a DC sweep run.

Takes in a sensitivity 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. The default is None.

measlistPath, optional

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

on_time_windowfloat, optional

Time window for selecting on samples up to the end of the run. The default is 300.

off_time_windowfloat, optional

Time window for selecting off samples up to the end of the run. The default is 300.

heater_instr_namestr, optional

Name of heater instrument. The default is ‘SMU’.

sensor_instr_namestr, optional

Name of sensor instrument. The default is ‘NVM’.

thermometer_instr_namestr, optional

Name of the thermometer instrument. The default is ‘Thermometer’

zero_threshholdfloat, optional

Threshhold (in Watts) of samples below this where the heater is believed to be turned off. The default is 1e-6.

transition_threshhold_wattsfloat, optional

Thresh hold (in Watts) where changes in the applied power to the heater constitutes a new step in the sweep. The default is 0.1e-4.

make_plotsbool, optional

If true,make plots

Returns:

parsed_dcconfigs.ParsedDCSweep

ParsedCalibration object and any figures generated

sensitivityconfigs.ThermolectricFitCoefficients

Thermoelectric fit coefficients

figureslist[plt.Figure]

Generated figures.

microcalorimetry.measurements.dcsweep.parse_v1(metadata: list[pathlib.Path], thermopile_monitor: str, heater: str, on_min_wait_time: float = 0.0, on_max_wait_time: float = 1e+99, off_min_wait_time: float = 0.0, off_max_wait_time: float = 1e+99, min_pwr_setting: float = 0.0, throw_away_min_time: float = 0.0, thermometer_monitor: str = None, make_plots: bool = True) → tuple[microcalorimetry.configs.ParsedDCSweep, list[matplotlib.pyplot.Figure]]

Parse version 1 of a DC sweep calibration measurement.

Parameters:

metadatalist[Path]

List of paths to metadata files (or folders) containing dcsweep measurements.

thermopile_monitorstr

Name of thermopile monitor instrument.

heaterstr, optional

Name of heater instrument.

on_min_wait_timefloat, optional

Minimum time to wait before an on measurement should be included as part of the fit.

on_max_wait_timefloat, optional

Maximum time to wait before an on measurement should be included as part of the fit.

off_min_wait_timefloat, optional

Minimum time to wait before an off measurement should be included as part of the fit.

off_max_wait_timefloat, optional

Maximum time to wait before an off measurement should be included as part of the fit.

min_pwr_settingfloat, optional

Exclude and power levels below this value.

throw_away_min_timefloat, optional

Throw away samples taken before this time since source adjustment.

thermometer_monitorstr, optional, optional

Name of instrument in the thermometer_monitor role. The default is None.

make_plotsbool, optional, optional

Generates plots if asked. Default is True.

Returns:

parsed_dcconfigs.ParsedDCSweep

Parsed DC measurements.

figslist[plt.Figure]

Analysis Figures