Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pybamm.Simulation.save, filename arg is not documented #3602

Merged
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
Loading