[Bug]: pybamm.Simulation.set_parameters, pybamm.Simulation.set_up_and_parameterise_experiment and pybamm.Simulation.set_up_and_parameterise_model_for_experiment made private in simulation.py

CHANGELOG.md

@@ -37,6 +37,7 @@
 
 ## Breaking changes
 
+- Added a deprecated warning for `pybamm.Simulation.set_parameters`, `pybamm.Simulation.set_up_and_parameterise_experiment` and `pybamm.Simulation.set_up_and_parameterise_model_for_experiment` functions in `pybamm.simulation.py`. ([#3752](https://github.com/pybamm-team/PyBaMM/pull/3752))
 - The parameters `GeometricParameters.A_cooling` and `GeometricParameters.V_cell` are now automatically computed from the electrode heights, widths and thicknesses if the "cell geometry" option is "pouch" and from the parameters "Cell cooling surface area [m2]" and "Cell volume [m3]", respectively, otherwise. When using the lumped thermal model we recommend using the "arbitrary" cell geometry and specifying the parameters "Cell cooling surface area [m2]", "Cell volume [m3]" and "Total heat transfer coefficient [W.m-2.K-1]" directly. ([#3707](https://github.com/pybamm-team/PyBaMM/pull/3707))
 - Dropped support for the `[jax]` extra, i.e., the Jax solver when running on Python 3.8. The Jax solver is now available on Python 3.9 and above ([#3550](https://github.com/pybamm-team/PyBaMM/pull/3550))
 

pybamm/simulation.py

@@ -11,6 +11,7 @@
 from datetime import timedelta
 from pybamm.util import have_optional_dependency
 from typing import Optional
+from warnings import warn
 
 from pybamm.expression_tree.operations.serialise import Serialise
 
@@ -177,6 +178,7 @@ def _set_random_seed(self):
 
     def set_up_and_parameterise_experiment(self):
         """
+        This is a helper function.
         Set up a simulation to run with an experiment. This creates a dictionary of
         inputs (current/voltage/power, running time, stopping condition) for each
         operating condition in the experiment. The model will then be solved by
@@ -185,6 +187,8 @@ def set_up_and_parameterise_experiment(self):
         This needs to be done here and not in the Experiment class because the nominal
         cell capacity (from the parameters) is used to convert C-rate to current.
         """
+        msg = "pybamm.simulation.set_up_and_parameterise_experiment is not meant to be accessed directly."
+        warn(msg, DeprecationWarning)
         # Update experiment using capacity
         capacity = self._parameter_values["Nominal cell capacity [A.h]"]
         for op_conds in self.experiment.operating_conditions_steps:
@@ -209,12 +213,15 @@ def set_up_and_parameterise_experiment(self):
 
     def set_up_and_parameterise_model_for_experiment(self):
         """
+        This is a helper function.
         Set up self._model to be able to run the experiment (new version).
         In this version, a new model is created for each step.
 
         This increases set-up time since several models to be processed, but
         reduces simulation time since the model formulation is efficient.
         """
+        msg = "pybamm.simulation.set_up_and_parameterise_model_for_experiment is not meant to be accessed directly."
+        warn(msg, DeprecationWarning)
         self.experiment_unique_steps_to_model = {}
         for op_number, op in enumerate(self.experiment.unique_steps):
             new_model = self._model.new_copy()
@@ -325,7 +332,8 @@ def set_parameters(self):
         """
         A method to set the parameters in the model and the associated geometry.
         """
-
+        msg = "pybamm.set_paramters is meant to be accessed directly."
+        warn(msg, DeprecationWarning)
         if self.model_with_set_params:
             return