cideMOD.simulation_interface.battery_system

Classes

CSI(cell_data[, simulation_options, ...])

Interface class to deal with the Problem class at high level.
class cideMOD.simulation_interface.battery_system.CSI(cell_data: CellParser | dict | str, simulation_options: dict | BaseModelOptions | None = None, test_plan: str | dict | None = None, data_path: str | None = None)[source]

Bases: object

Interface class to deal with the Problem class at high level.

Parameters:

  • cell_data (Union[dict,str]) – dictionary or path to the json file with the cell parameters

  • simulation_options (Union[dict, BaseModelOptions], optional) – dicionary with simulation options, normally provided from the get_model_options method.

  • test_plan (Union[dict,str], optional) – The dictionary with the test plan or a path to a JSON file with the test plan. Defaults to None.

  • data_path (str, optional) – path to the folder with the additional data specified in cell_data. Defaults to None.

plot_global_results(results_path=None)[source]

Generates an interactive plot with all the global variables.

Parameters:

results_path (StrPath, optional) – Path to the results folder, if None, the save_path of the problem object will be used. Defaults to None.

print_test_plan()[source]
reset(new_parameters: dict | None = None, save_path: str | None = None, save_config=True)[source]

This method resets CSI in order to be ready for running another simulation with the same initial conditions, and maybe using different parameters.

Parameters:

  • new_parameters (Dict[str, float], optional) – Dictionary containing the cell parameters to be updated.

  • save_path (str, optional) – Path to the new results folder.

  • save_config – Whether to save the parameter and simulation options to the results folder. Defaults to True.

Notes

This method is used to avoid the generation of multiple Problem objects when running multiple simulations, for example when performing optimizations.

run_test_plan()[source]

Do the simulation specified in the test plan with the loaded cell

Returns:

Status of the simulation, 0 means no problem, otherwise an Exception with information on the issues is returned.

Return type:

int or Exception

setup()[source]

Initialize the initial state and set up the cideMOD.Problem object. For further information type help(Problem.setup)

update_test_plan(new_test_plan=None)[source]

This method updates the test plan.

Parameters:

new_test_plan (dict, optional) – New test plan to be simulated. Default to None.

Notes

If no new test plan is provided, this method checks if the reference capacity has changed and if so, updates the current steps and triggers based on C-rate input.