dandeliion.client.solve

dandeliion.client.solve(simulator: Simulator, params: str | Path | dict | BPX, experiment: Experiment = None, extra_params: dict = None, is_blocking: bool = True) → Solution[source]

Method for submitting/running a DandeLiion simulation.

Parameters:

  • simulator (Simulator) – instance of simulator class providing information to connect to simulation server

  • params (str|Path|dict|BPX) – path to BPX parameter file or already read-in valid BPX as dict or BPX object

  • experiment (Experiment, optional) – instance of pybamm Experiment defining steps

  • extra_params (dict, optional) – extra parameters e.g. simulation mesh, choice of discretisation method and initial conditions specified in the dictionary (if none or only subset is provided, either user-defined values stored in the bpx or, if not present, default values will be used instead)

  • is_blocking (bool, optional) – determines whether command is blocking until computation has finished or returns right away. In the latter case, the Solution may still point to an unfinished run (its status can be checked with the property of the same name). Default: True

Returns:

solution for this simulation run

Return type:

Solution