pybop.simulators.base_simulator

Classes

BaseSimulator

Base simulator.

Module Contents

class pybop.simulators.base_simulator.BaseSimulator(parameters: pybop.parameters.parameter.Parameters | dict | None = None)

Base simulator.

copy()

Return a copy of the simulator.

get_parameters_from_dict(parameter_values: dict)

Extract any pybop.Parameter objects and replace with the “[input]” string.

set_output_variables(target: list[str])

solve(inputs: Inputs | list[Inputs] | None = None, calculate_sensitivities: bool = False) → pybop.simulators.solution.Solution | list[pybop.simulators.solution.Solution]

Returns the output of a simulation for one or more sets of inputs as a dictionary, along with the sensitivities of the output with respect to the input parameters if calculate_sensitivities=True.

solve_batch(inputs: list[Inputs], calculate_sensitivities: bool = False) → list[pybop.simulators.solution.Solution | pybop.simulators.failed_solution.FailedSolution]

Run the simulation for each set of inputs and return dict-like simulation results and (optionally) the sensitivities with respect to each input parameter.

Parameters:

• inputs (list[Inputs]) – A list of input parameters.

• calculate_sensitivities (bool) – Whether to also return the sensitivities (default: False).

Returns:

A list of len(inputs) containing the simulation result(s) and (optionally) the sensitivities with respect to each input parameter.

Return type:

list[Solution]

property has_sensitivities

parameters = None