Merge pull request #2600 from pybamm-team/i2599-bench-idaklu

I2599 bench idaklu

Author: martinjrobins

.github/workflows/benchmark_on_push.yml

@@ -11,8 +11,15 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: 3.8
-      - name: Install asv
-        run: pip install -U pip virtualenv asv
+      - name: Install Linux system dependencies
+        run: |
+          sudo apt-get update
+          sudo apt install gfortran gcc libopenblas-dev
+      - name: Install python dependencies
+        run: |
+          python -m pip install --upgrade pip wheel setuptools virtualenv asv wget cmake casadi numpy
+      - name: Install SuiteSparse and Sundials
+        run: python scripts/install_KLU_Sundials.py
       - name: Fetch base branch
         run: |
           # This workflow also runs for merge commits
@@ -22,6 +29,7 @@ jobs:
           if [ $current_branch != "develop" ]; then
               git fetch origin develop:develop
           fi
+
       - name: Run benchmarks
         run: |
           asv machine --machine "GitHubRunner"
@@ -30,7 +38,7 @@ jobs:
           HEAD_COMMIT=$(git rev-parse HEAD)
           echo $BASE_COMMIT | tee commits_to_compare.txt
           echo $HEAD_COMMIT | tee -a commits_to_compare.txt
-          asv run HASHFILE:commits_to_compare.txt --m "GitHubRunner" --show-stderr
+          asv run HASHFILE:commits_to_compare.txt --m "GitHubRunner" --show-stderr -v
       - name: Compare commits' benchmark results
         run: |
           BASE_COMMIT=$(head -1 commits_to_compare.txt)

asv.conf.json

@@ -23,10 +23,11 @@
   //
   // "install_command": ["in-dir={env_dir} python -mpip install {wheel_file}"],
   // "uninstall_command": ["return-code=any python -mpip uninstall -y {project}"],
-  // "build_command": [
-  //     "python setup.py build",
-  //     "PIP_NO_BUILD_ISOLATION=false python -mpip wheel --no-deps --no-index -w {build_cache_dir} {build_dir}"
-  // ],
+  "build_command": [
+    "/usr/bin/git clone --depth 1 --branch v2.6.2 https://github.com/pybind/pybind11.git",
+    "python setup.py build",
+    "PIP_NO_BUILD_ISOLATION=false python -mpip wheel --no-deps --no-index -w {build_cache_dir} {build_dir}"
+  ],
 
   // List of branches to benchmark. If not provided, defaults to "master"
   // (for git) or "default" (for mercurial).
@@ -44,7 +45,7 @@
   // If missing or the empty string, the tool will be automatically
   // determined by looking for tools on the PATH environment
   // variable.
-  "environment_type": "virtualenv"
+  "environment_type": "virtualenv",
 
   // timeout in seconds for installing any dependencies in environment
   // defaults to 10 min
@@ -71,11 +72,17 @@
   // pip (with all the conda available packages installed first,
   // followed by the pip installed packages).
   //
-  // "matrix": {
-  //     "numpy": ["1.6", "1.7"],
-  //     "six": ["", null],        // test with and without six installed
-  //     "pip+emcee": [""],   // emcee is only available for install with pip.
-  // },
+  "matrix": {
+    "req": {
+      "numpy": [],
+      "casadi": [],
+      "wget": [],
+      "cmake": []
+    },
+    "env": {
+      "LD_LIBRARY_PATH": "/home/runner/.local/lib"
+    }
+  }
 
   // Combinations of libraries/python versions can be excluded/included
   // from the set to test. Each entry is a dictionary containing additional

benchmarks/different_model_options.py

@@ -30,9 +30,19 @@ def build_model(parameter, model_, option, value):
 
 
 class SolveModel:
-    solver = pybamm.CasadiSolver()
-
-    def solve_setup(self, parameter, model_, option, value):
+    def solve_setup(self, parameter, model_, option, value, solver_class):
+        import importlib
+
+        idaklu_spec = importlib.util.find_spec("pybamm.solvers.idaklu")
+        if idaklu_spec is not None:
+            try:
+                idaklu = importlib.util.module_from_spec(idaklu_spec)
+                idaklu_spec.loader.exec_module(idaklu)
+            except ImportError as e:  # pragma: no cover
+                print("XXXXX cannot find klu", e)
+                idaklu_spec = None
+
+        self.solver = solver_class()
         self.model = model_({option: value})
         c_rate = 1
         tmax = 4000 / c_rate
@@ -62,7 +72,7 @@ def solve_setup(self, parameter, model_, option, value):
         disc.process_model(self.model)
 
     def solve_model(self, model, params):
-        SolveModel.solver.solve(self.model, t_eval=self.t_eval)
+        self.solver.solve(self.model, t_eval=self.t_eval)
 
 
 class TimeBuildModelLossActiveMaterial:
@@ -78,17 +88,20 @@ def time_setup_model(self, model, params):
 
 
 class TimeSolveLossActiveMaterial:
-    param_names = ["model", "model option"]
+    param_names = ["model", "model option", "solver class"]
     params = (
         [pybamm.lithium_ion.SPM, pybamm.lithium_ion.DFN],
         ["none", "stress-driven", "reaction-driven", "stress and reaction-driven"],
+        [pybamm.CasadiSolver, pybamm.IDAKLUSolver],
     )
 
-    def setup(self, model, params):
-        SolveModel.solve_setup(self, "Ai2020", model, "loss of active material", params)
+    def setup(self, model, params, solver_class):
+        SolveModel.solve_setup(
+            self, "Ai2020", model, "loss of active material", params, solver_class
+        )
 
-    def time_solve_model(self, model, params):
-        SolveModel.solver.solve(self.model, t_eval=self.t_eval)
+    def time_solve_model(self, model, params, solver_class):
+        self.solver.solve(self.model, t_eval=self.t_eval)
 
 
 class TimeBuildModelLithiumPlating:
@@ -103,17 +116,20 @@ def time_setup_model(self, model, params):
 
 
 class TimeSolveLithiumPlating:
-    param_names = ["model", "model option"]
+    param_names = ["model", "model option", "solver class"]
     params = (
         [pybamm.lithium_ion.SPM, pybamm.lithium_ion.DFN],
         ["none", "irreversible", "reversible", "partially reversible"],
+        [pybamm.CasadiSolver, pybamm.IDAKLUSolver],
     )
 
-    def setup(self, model, params):
-        SolveModel.solve_setup(self, "OKane2020", model, "lithium plating", params)
+    def setup(self, model, params, solver_class):
+        SolveModel.solve_setup(
+            self, "OKane2020", model, "lithium plating", params, solver_class
+        )
 
-    def time_solve_model(self, model, params):
-        SolveModel.solver.solve(self.model, t_eval=self.t_eval)
+    def time_solve_model(self, model, params, solver_class):
+        self.solver.solve(self.model, t_eval=self.t_eval)
 
 
 class TimeBuildModelSEI:
@@ -138,7 +154,7 @@ def time_setup_model(self, model, params):
 
 
 class TimeSolveSEI:
-    param_names = ["model", "model option"]
+    param_names = ["model", "model option", "solver class"]
     params = (
         [pybamm.lithium_ion.SPM, pybamm.lithium_ion.DFN],
         [
@@ -152,13 +168,14 @@ class TimeSolveSEI:
             "ec reaction limited",
             "ec reaction limited (asymmetric)",
         ],
+        [pybamm.CasadiSolver, pybamm.IDAKLUSolver],
     )
 
-    def setup(self, model, params):
-        SolveModel.solve_setup(self, "Marquis2019", model, "SEI", params)
+    def setup(self, model, params, solver_class):
+        SolveModel.solve_setup(self, "Marquis2019", model, "SEI", params, solver_class)
 
-    def time_solve_model(self, model, params):
-        SolveModel.solver.solve(self.model, t_eval=self.t_eval)
+    def time_solve_model(self, model, params, solver_class):
+        self.solver.solve(self.model, t_eval=self.t_eval)
 
 
 class TimeBuildModelParticle:
@@ -178,7 +195,7 @@ def time_setup_model(self, model, params):
 
 
 class TimeSolveParticle:
-    param_names = ["model", "model option"]
+    param_names = ["model", "model option", "solver class"]
     params = (
         [pybamm.lithium_ion.SPM, pybamm.lithium_ion.DFN],
         [
@@ -187,13 +204,16 @@ class TimeSolveParticle:
             "quadratic profile",
             "quartic profile",
         ],
+        [pybamm.CasadiSolver, pybamm.IDAKLUSolver],
     )
 
-    def setup(self, model, params):
-        SolveModel.solve_setup(self, "Marquis2019", model, "particle", params)
+    def setup(self, model, params, solver_class):
+        SolveModel.solve_setup(
+            self, "Marquis2019", model, "particle", params, solver_class
+        )
 
-    def time_solve_model(self, model, params):
-        SolveModel.solver.solve(self.model, t_eval=self.t_eval)
+    def time_solve_model(self, model, params, solver_class):
+        self.solver.solve(self.model, t_eval=self.t_eval)
 
 
 class TimeBuildModelThermal:
@@ -208,17 +228,20 @@ def time_setup_model(self, model, params):
 
 
 class TimeSolveThermal:
-    param_names = ["model", "model option"]
+    param_names = ["model", "model option", "solver class"]
     params = (
         [pybamm.lithium_ion.SPM, pybamm.lithium_ion.DFN],
         ["isothermal", "lumped", "x-lumped", "x-full"],
+        [pybamm.CasadiSolver, pybamm.IDAKLUSolver],
     )
 
-    def setup(self, model, params):
-        SolveModel.solve_setup(self, "Marquis2019", model, "thermal", params)
+    def setup(self, model, params, solver_class):
+        SolveModel.solve_setup(
+            self, "Marquis2019", model, "thermal", params, solver_class
+        )
 
-    def time_solve_model(self, model, params):
-        SolveModel.solver.solve(self.model, t_eval=self.t_eval)
+    def time_solve_model(self, model, params, solver_class):
+        self.solver.solve(self.model, t_eval=self.t_eval)
 
 
 class TimeBuildModelSurfaceForm:
@@ -233,14 +256,17 @@ def time_setup_model(self, model, params):
 
 
 class TimeSolveSurfaceForm:
-    param_names = ["model", "model option"]
+    param_names = ["model", "model option", "solver class"]
     params = (
         [pybamm.lithium_ion.SPM, pybamm.lithium_ion.DFN],
         ["false", "differential", "algebraic"],
+        [pybamm.CasadiSolver, pybamm.IDAKLUSolver],
     )
 
-    def setup(self, model, params):
-        SolveModel.solve_setup(self, "Marquis2019", model, "surface form", params)
+    def setup(self, model, params, solver_class):
+        SolveModel.solve_setup(
+            self, "Marquis2019", model, "surface form", params, solver_class
+        )
 
-    def time_solve_model(self, model, params):
-        SolveModel.solver.solve(self.model, t_eval=self.t_eval)
+    def time_solve_model(self, model, params, solver_class):
+        self.solver.solve(self.model, t_eval=self.t_eval)

benchmarks/time_sims_experiments.py

@@ -1,67 +1,43 @@
 import pybamm
 
-parameters = ["Marquis2019", "Chen2020"]
 
-
-class TimeSPMSimulationCCCV:
-    param_names = ["parameter"]
-    params = parameters
-
-    def time_setup_SPM_simulation(self, parameters):
-        self.param = pybamm.ParameterValues(parameters)
-        self.model = pybamm.lithium_ion.SPM()
-        exp = pybamm.Experiment(
-            [
-                "Discharge at C/5 for 10 hours or until 3.3 V",
-                "Rest for 1 hour",
-                "Charge at 1 A until 4.1 V",
-                "Hold at 4.1 V until 10 mA",
-                "Rest for 1 hour",
-            ]
-        )
-        pybamm.Simulation(self.model, parameter_values=self.param, experiment=exp)
-
-
-class TimeDFNSimulationCCCV:
-    param_names = ["parameter"]
-    params = parameters
-
-    def time_setup_SPM_simulation(self, parameters):
+class TimeSimulation:
+    param_names = ["experiment", "parameter", "model_class", "solver_class"]
+    params = [
+        ["CCCV", "GITT"],
+        ["Marquis2019", "Chen2020"],
+        [pybamm.lithium_ion.SPM, pybamm.lithium_ion.DFN],
+        [pybamm.CasadiSolver, pybamm.IDAKLUSolver],
+    ]
+    experiment_descriptions = {
+        "CCCV": [
+            "Discharge at C/5 for 10 hours or until 3.3 V",
+            "Rest for 1 hour",
+            "Charge at 1 A until 4.1 V",
+            "Hold at 4.1 V until 10 mA",
+            "Rest for 1 hour",
+        ],
+        "GITT": [("Discharge at C/20 for 1 hour", "Rest for 1 hour")] * 20,
+    }
+
+    def setup(self, experiment, parameters, model_class, solver_class):
         self.param = pybamm.ParameterValues(parameters)
-        self.model = pybamm.lithium_ion.DFN()
-        exp = pybamm.Experiment(
-            [
-                "Discharge at C/5 for 10 hours or until 3.3 V",
-                "Rest for 1 hour",
-                "Charge at 1 A until 4.1 V",
-                "Hold at 4.1 V until 10 mA",
-                "Rest for 1 hour",
-            ]
+        self.model = model_class()
+        self.solver = solver_class()
+        self.exp = pybamm.Experiment(self.experiment_descriptions[experiment])
+        self.sim = pybamm.Simulation(
+            self.model,
+            parameter_values=self.param,
+            experiment=self.exp,
+            solver=self.solver,
         )
-        pybamm.Simulation(self.model, parameter_values=self.param, experiment=exp)
-
 
-class TimeSPMSimulationGITT:
-    param_names = ["parameter"]
-    params = parameters
+    def time_setup(self, experiment, parameters, model_class, solver_class):
+        param = pybamm.ParameterValues(parameters)
+        model = model_class()
+        solver = solver_class()
+        exp = pybamm.Experiment(self.experiment_descriptions[experiment])
+        pybamm.Simulation(model, parameter_values=param, experiment=exp, solver=solver)
 
-    def time_setup_SPM_simulation(self, parameters):
-        self.param = pybamm.ParameterValues(parameters)
-        self.model = pybamm.lithium_ion.SPM()
-        exp = pybamm.Experiment(
-            [("Discharge at C/20 for 1 hour", "Rest for 1 hour")] * 20
-        )
-        pybamm.Simulation(self.model, parameter_values=self.param, experiment=exp)
-
-
-class TimeDFNSimulationGITT:
-    param_names = ["parameter"]
-    params = parameters
-
-    def time_setup_SPM_simulation(self, parameters):
-        self.param = pybamm.ParameterValues(parameters)
-        self.model = pybamm.lithium_ion.DFN()
-        exp = pybamm.Experiment(
-            [("Discharge at C/20 for 1 hour", "Rest for 1 hour")] * 20
-        )
-        pybamm.Simulation(self.model, parameter_values=self.param, experiment=exp)
+    def time_solve(self, experiment, parameters, model_class, solver_class):
+        self.sim.solve()