Fixed issue pybamm-team#3724 (pybamm-team#3726)

* Fixed issue pybamm-team#3724 Documentation added for pybamm.Experiment.read_termination * Issue pybamm-team#3724 Updated the documentation based on the discussion so that the argument passed to read_termination is of type str or list[str] --------- Co-authored-by: Ferran Brosa Planella <[email protected]> Co-authored-by: Agriya Khetarpal <[email protected]> Co-authored-by: Robert Timms <[email protected]>
js1tr3 · Aug 12, 2024 · b5a3f9e · b5a3f9e
1 parent 3bf9fd5
commit b5a3f9e
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/pybamm/experiment/experiment.py b/pybamm/experiment/experiment.py
@@ -133,6 +133,21 @@ def __repr__(self):
     def read_termination(termination):
         """
         Read the termination reason. If this condition is hit, the experiment will stop.
+
+        Parameters
+        ----------
+        termination : str or list[str], optional
+           A single string, or a list of strings, representing the conditions to terminate the experiment.
+           Only capacity or voltage can be provided as a termination reason.
+           e.g. '4 Ah capacity' or ['80% capacity', '2.5 V']
+
+        Returns
+        -------
+        dict
+           A dictionary of the termination conditions.
+           e.g. {'capacity': (4.0, 'Ah')} or
+           {'capacity': (80.0, '%'), 'voltage': (2.5, 'V')}
+
         """
         if termination is None:
             return {}