Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Added documentation for filename argrument in simulation.py
  • Loading branch information
AbhishekChaudharii committed Dec 8, 2023
commit d5106c77299c03853d84dde65268cf8f9e9df20a
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