Interface (moirae.interface)#

Interfaces for running common workflows with Moirae, with a particular emphasis on data built with battery-data-toolkit

moirae.interface.row_to_inputs(row: Series, default_temperature: float = 25) Tuple[InputQuantities, OutputQuantities]#

Convert a row from the time series data to a distribution object

Parameters:
  • row – Row from the dataset.raw_data dataframe

  • default_temperature – Default temperature for the cells (units: C)

Returns:

  • Distribution describing the inputs

  • Distribution describing the measurements (model outputs)

moirae.interface.run_online_estimate(dataset: BatteryDataset, estimator: OnlineEstimator, pbar: bool = False) Tuple[DataFrame, OnlineEstimator]#

Run an online estimation of battery parameters given a fixed dataset for the

Parameters:
  • dataset – Dataset containing the time series of a battery’s performance

  • estimator – Technique used to estimate the state of health, which is built using a physics model which describes the cell and initial guesses for the battery transient and health states.

  • pbar – Whether to display a progress bar

Returns:

  • Estimates of the parameters at all timesteps from the input dataset

  • Estimator after updating with the data in dataset