microcalorimetry.measurements

The measurements submodule contains functions for interacting with specific measurements.

Each submodule within contains, at minimum, three functions for a particular measurment.

  • run: Takes in a configuration file and performs a measurement

  • view: Takes in the output of an ongoing or complete measurement and generates plots to explore the measurement

  • parse: Takes in raw data and outputs data to a well defined intermediary data-set with uncertainties for further processing.

Additional methods may be provided depending on the measurement.

Submodules

Functions

view(→ tuple[matplotlib.pyplot.Figure])

Generic plot columns in a data record.

Package Contents

microcalorimetry.measurements.view(metadata: pathlib.Path, include_columns: list[str] = ['*'], exclude_columns: list[str] = [], time_units: str = 'seconds', relative_time: bool = True) tuple[matplotlib.pyplot.Figure][source]

Generic plot columns in a data record.

Parameters:
metadataPath

Path to the metadata file of an active experiment

include_columnslist[str]

Columns to include with glob patters. Leave as [‘*’] to include all. The default is [‘*’]

exclude_columnslist[str]

Columns to exclude with glob patterns. Leave as [] to not exclude any. The default is []

time_unitsstr, optional

{ seconds

plot in seconds

hours

plot in hours

datetime

plot in datetime

}

relative_timebool, optional

Use time since start of record instead of absolute time as the x axis.

Returns:
figurestuple[Figure]

Tuple of output figures.