cideMOD.simulation_interface.utils

Functions

run_case(options_dict, cell_data[, ...])

Configure and run a battery cell simulation using cideMOD.
cideMOD.simulation_interface.utils.run_case(options_dict: dict, cell_data: dict | str, data_path: str | None = None, test_plan: str | dict | None = None, i_app: float | None = None, C_rate: float | None = None, v_app: float | None = None, min_step: float = 10, max_step: float = 60, t_f: float | None = None, adaptive: bool = False, time_adaptive_tol: float = 0.01, triggers: List[Trigger] = [], v_min: float | None = None, v_max: float | None = None, store_delay: int = 10, SoC: float = 1.0, T_ini: float = 298.15, T_ext: float = 298.15, plot_globals: bool = False)[source]

Configure and run a battery cell simulation using cideMOD.

Parameters:

  • options_dict (dict) – Dictionary containing the simulation options. For more details type print(cideMOD.get_model_options().__doc__)

  • cell_data (Union[dict,str]) – Dictionary of the cell parameters or path to a JSON file containing them.

  • data_path (str, optional) – Path to the folder where cell_data is together with extra data like materials OCVs. Required if cell_data is a dictionary.

  • 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.

  • i_app (float, optional) – Applied current. If CV use None. Defaults to None.

  • C_rate (float, optional) – Discharge C-rate. Used if CC and i_app is not given. Defaults to None.

  • v_app (Union[float,str], optional) – Applied voltage in Volts. If CC use None. Default to None.

  • min_step (float, optional) – Minimum timestep length for adaptive solver in seconds. Defaults to 10.

  • max_step (int, optional) – Maximum timestep length for adaptive solver in seconds. Defaults to 60.

  • t_f (float, optional) – The maximum duration of the simulation in seconds. Defaults to None.

  • adaptive (bool, optional) – Whether to use adaptive timestepping or not. Defaults to False.

  • time_adaptive_tol (Union[float,int]) – Tolerance of the time-adaptive scheme. Defaults to 1e-2.

  • triggers (List[Trigger], optional) – List of Triggers to check during runtime. Default to [].

  • v_min (float, optional) – Minimum voltage of the simulation in Volts.

  • v_max (float, optional) – Maximum voltage of the simulation in Volts.

  • store_delay (int, optional) – The delay to apply between consecutive saves of the internal variables, in number of timesteps. Defaults to 10.

  • SoC (float, optional) – Current State of Charge of the battery cell. Defaults to 1.

  • T_ini (float, optional) – Uniform value of the internal temperature. Defaults to 298.15 K.

  • T_ext (float, optional) – External temperature. Defaults to 298.15 K.

  • plot_globals (bool, optional) – Whether or not to plot the global variables. Defaults to False.