Error Checking (battdat.consistency)#

Tools for checking whether data contained in a dataset is self-consistent

Base (b.consistency.base)#

Base class for consistency checkers

class battdat.consistency.base.ConsistencyChecker#

Bases: object

Interface for classes which assess whether data in a BatteryDataset are self-consistent

check(dataset: BatteryDataset) → List[str]#

Report possible inconsistencies within a dataset

Parameters:

dataset – Dataset to be evaluated

Returns:

List of observed inconsistencies

Current (b.consistency.current)#

Checks related to the current in time series data

class battdat.consistency.current.SignConventionChecker(subsets_to_check: Collection[str] = ('raw_data',), window_length: float = 360.0, minimum_current: float = 1e-06)#

Bases: ConsistencyChecker

Estimate whether the sign convention of a dataset is likely to be correct

The concept underpinning this class is that the voltage of a cell should increase as it is charged. The algorithm looks for a period where the current is the most consistent the measures whether the change in measured voltage during that period.

check(dataset: BatteryDataset) → List[str]#

Report possible inconsistencies within a dataset

Parameters:

dataset – Dataset to be evaluated

Returns:

List of observed inconsistencies

check_subset(time_series: DataFrame) → str | None#
minimum_current: float = 1e-06#

Minimum current used when determining periods of charge or discharge

subsets_to_check: Collection[str] = ('raw_data',)#

Which subsets within a dataset to evaluate

window_length: float = 360.0#
Type:

Length of time period over which to assess voltage change (units