pybop.applications.gitt_methods#

Classes#

GITTFit

Fit the diffusion timescale of each pulse from a galvanostatic intermittent

GITTPulseFit

Fit the diffusion timescale of one pulse from a galvanostatic intermittent

Module Contents#

class pybop.applications.gitt_methods.GITTFit(gitt_dataset: pybop.Dataset, pulse_index: list[numpy.ndarray], parameter_set: pybop.ParameterSet, electrode: str | None = 'negative', cost: pybop.BaseCost | None = pybop.RootMeanSquaredError, optimiser: pybop.BaseOptimiser | None = pybop.SciPyMinimize, verbose: bool = False)[source]#

Bases: pybop.BaseApplication

Fit the diffusion timescale of each pulse from a galvanostatic intermittent titration technique (GITT) measurement.

Parameters:

  • gitt_dataset (pybop.Dataset) – A dataset containing the “Time [s]”, “Current function [A]” and “Voltage [V]” for a GITT measurement.

  • pulse_index (list[np.ndarray]) – A nested list of integers representing the indices of each pulse in the dataset.

  • parameter_set (pybop.ParameterSet) – A parameter set containing values for the parameters of the SPDiffusion model.

  • electrode (str, optional) – Either “positive” or “negative” depending on the type of electrode.

  • cost (pybop.BaseCost, optional) – The cost function to quantify the error (default: pybop.RootMeanSquaredError).

  • optimiser (pybop.BaseOptimiser, optional) – The optimisation algorithm to use (default: pybop.SciPyMinimize).

  • verbose (bool, optional) – If True, progress messages are printed (default: False).

__call__() → pybop.Dataset[source]#
cost[source]#
electrode = 'negative'[source]#
gitt_dataset[source]#
gitt_pulse[source]#
optimiser[source]#
parameter_set[source]#
pulse_index[source]#
verbose = False[source]#
class pybop.applications.gitt_methods.GITTPulseFit(parameter_set: pybop.ParameterSet, electrode: str | None = 'negative', cost: pybop.BaseCost | None = pybop.RootMeanSquaredError, optimiser: pybop.BaseOptimiser | None = pybop.SciPyMinimize, verbose: bool = True)[source]#

Bases: pybop.BaseApplication

Fit the diffusion timescale of one pulse from a galvanostatic intermittent titration technique (GITT) measurement using the diffusion model for a single, spherical particle representing one electrode.

The cost function requires a “domain”-based weighting to fit (possibly non-uniform) data consistently across the observed time period.

Parameters:

  • gitt_pulse (pybop.Dataset) – A dataset containing the “Time [s]”, “Current function [A]” and “Voltage [V]” for one pulse obtained from a GITT measurement.

  • parameter_set (pybop.ParameterSet) – A parameter set containing values for the parameters of the SPDiffusion model.

  • electrode (str, optional) – Either “positive” or “negative” depending on the type of electrode.

  • cost (pybop.BaseCost, optional) – The cost function to quantify the error (default: pybop.RootMeanSquaredError).

  • optimiser (pybop.BaseOptimiser, optional) – The optimisation algorithm to use (default: pybop.SciPyMinimize).

  • verbose (bool, optional) – If True, progress messages are printed (default: True).

__call__(gitt_pulse: pybop.Dataset) → pybop.OptimisationResult[source]#
cost[source]#
electrode = 'negative'[source]#
model[source]#
optim = None[source]#
optimiser[source]#
parameter_set[source]#
parameters[source]#
problem = None[source]#
results = None[source]#
verbose = True[source]#