Skip to content

Commit

Permalink
Merge pull request pybamm-team#3602 from AbhishekChaudharii/issue_339…
Browse files Browse the repository at this point in the history
…2_improve_API_documentation

pybamm.Simulation.save, filename arg is not documented
  • Loading branch information
valentinsulzer authored Dec 8, 2023
2 parents 22d1229 + f87ba02 commit fe3eb65
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion pybamm/simulation.py
Original file line number Diff line number Diff line change
Expand Up @@ -1166,7 +1166,13 @@ def solution(self):
return self._solution

def save(self, filename):
"""Save simulation using pickle"""
"""Save simulation using pickle module.
Parameters
----------
filename : str
The file extension can be arbitrary, but it is common to use ".pkl" or ".pickle"
"""
if self._model.convert_to_format == "python":
# We currently cannot save models in the 'python' format
raise NotImplementedError(
Expand Down

0 comments on commit fe3eb65

Please sign in to comment.