pybop-team · BradyPlanden · Oct 21, 2024 · Oct 2, 2024 · Oct 10, 2024 · Oct 10, 2024
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 ## Features
 
+- [#531](https://github.com/pybop-team/PyBOP/pull/531) - Adds Voronoi optimiser surface plot (`pybop.plot.surface`) for fast optimiser aligned cost visualisation.
 - [#532](https://github.com/pybop-team/PyBOP/issues/532) - Adds `linked_parameters` example script which shows how to update linked parameters during design optimisation.
 - [#529](https://github.com/pybop-team/PyBOP/issues/529) - Adds `GravimetricPowerDensity` and `VolumetricPowerDensity` costs, along with the mathjax extension for Sphinx.
 
@@ -15,6 +16,7 @@
 
 ## Breaking Changes
 
+- [#531](https://github.com/pybop-team/PyBOP/pull/531) - Plot methods moved to `pybop.plot` with mostly minimal renaming. For example, `pybop.plot_parameters` is now `pybop.plot.parameters`. Other breaking changes include: `pybop.plot2d` to `pybop.plot.contour`.
 - [#526](https://github.com/pybop-team/PyBOP/pull/526) - Refactor `OptimisationResults` classes, with `optim.run()` now return the full object. Adds finite cost value check for optimised parameters.
 
 # [v24.9.1](https://github.com/pybop-team/PyBOP/tree/v24.9.0) - 2024-09-16

diff --git a/conftest.py b/conftest.py
@@ -20,7 +20,7 @@ def pytest_addoption(parser):
         "--examples", action="store_true", default=False, help="run examples tests"
     )
     parser.addoption(
-        "--plots", action="store_true", default=False, help="run plotting tests"
+        "--plots", action="store_true", default=False, help="run plot tests"
     )
     parser.addoption(
         "--notebooks", action="store_true", default=False, help="run notebook tests"

diff --git a/examples/notebooks/adamw_identification.ipynb b/examples/notebooks/adamw_identification.ipynb
diff --git a/examples/notebooks/comparing_cost_functions.ipynb b/examples/notebooks/comparing_cost_functions.ipynb
diff --git a/examples/notebooks/cost_compute_methods.ipynb b/examples/notebooks/cost_compute_methods.ipynb
@@ -19,6 +19,27 @@
    "id": "1",
    "metadata": {},
    "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "/Users/engs2510/Documents/Git/Second_PyBOP/.nox/notebooks-overwrite/bin/python3: No module named pip\r\n"
+     ]
+    },
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Note: you may need to restart the kernel to use updated packages.\n"
+     ]
+    },
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "/Users/engs2510/Documents/Git/Second_PyBOP/.nox/notebooks-overwrite/bin/python3: No module named pip\r\n"
+     ]
+    },
     {
      "name": "stdout",
      "output_type": "stream",
@@ -53,7 +74,7 @@
     "\n",
     "import pybop\n",
     "\n",
-    "pybop.PlotlyManager().pio.renderers.default = \"notebook_connected\""
+    "pybop.plot.PlotlyManager().pio.renderers.default = \"notebook_connected\""
    ]
   },
   {
@@ -364,7 +385,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.4"
+   "version": "3.12.2"
   }
  },
  "nbformat": 4,

diff --git a/examples/notebooks/creating_a_model.ipynb b/examples/notebooks/creating_a_model.ipynb
diff --git a/examples/notebooks/ecm_trust-constr.ipynb b/examples/notebooks/ecm_trust-constr.ipynb
diff --git a/examples/notebooks/electrode_balancing.ipynb b/examples/notebooks/electrode_balancing.ipynb
diff --git a/examples/notebooks/energy_based_electrode_design.ipynb b/examples/notebooks/energy_based_electrode_design.ipynb
diff --git a/examples/notebooks/equivalent_circuit_identification.ipynb b/examples/notebooks/equivalent_circuit_identification.ipynb
diff --git a/examples/notebooks/equivalent_circuit_identification_hppc.ipynb b/examples/notebooks/equivalent_circuit_identification_hppc.ipynb
diff --git a/examples/notebooks/equivalent_circuit_identification_multipulse.ipynb b/examples/notebooks/equivalent_circuit_identification_multipulse.ipynb
diff --git a/examples/notebooks/maximum_a_posteriori.ipynb b/examples/notebooks/maximum_a_posteriori.ipynb
diff --git a/examples/notebooks/multi_model_identification.ipynb b/examples/notebooks/multi_model_identification.ipynb
diff --git a/examples/notebooks/multi_optimiser_identification.ipynb b/examples/notebooks/multi_optimiser_identification.ipynb
diff --git a/examples/notebooks/optimiser_calibration.ipynb b/examples/notebooks/optimiser_calibration.ipynb
diff --git a/examples/notebooks/optimiser_interface.ipynb b/examples/notebooks/optimiser_interface.ipynb
@@ -22,7 +22,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "/Users/engs2510/Documents/Git/PyBOP/.nox/notebooks-overwrite/bin/python3: No module named pip\r\n"
+      "/Users/engs2510/Documents/Git/Second_PyBOP/.nox/notebooks-overwrite/bin/python3: No module named pip\r\n"
      ]
     },
     {
@@ -36,7 +36,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "/Users/engs2510/Documents/Git/PyBOP/.nox/notebooks-overwrite/bin/python3: No module named pip\r\n"
+      "/Users/engs2510/Documents/Git/Second_PyBOP/.nox/notebooks-overwrite/bin/python3: No module named pip\r\n"
      ]
     },
     {
@@ -56,7 +56,7 @@
     "\n",
     "import pybop\n",
     "\n",
-    "pybop.PlotlyManager().pio.renderers.default = \"notebook_connected\""
+    "pybop.plot.PlotlyManager().pio.renderers.default = \"notebook_connected\""
    ]
   },
   {
@@ -281,7 +281,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.4"
+   "version": "3.12.2"
   }
  },
  "nbformat": 4,

diff --git a/examples/notebooks/pouch_cell_identification.ipynb b/examples/notebooks/pouch_cell_identification.ipynb
diff --git a/examples/notebooks/single_pulse_circuit_model.ipynb b/examples/notebooks/single_pulse_circuit_model.ipynb
diff --git a/examples/notebooks/solver_selection.ipynb b/examples/notebooks/solver_selection.ipynb
@@ -32,15 +32,21 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "/Users/engs2510/Documents/Git/PyBOP/.nox/notebooks-overwrite/bin/python3: No module named pip\r\n"
+      "/Users/engs2510/Documents/Git/Second_PyBOP/.nox/notebooks-overwrite/bin/python3: No module named pip\r\n"
      ]
     },
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "Note: you may need to restart the kernel to use updated packages.\n",
-      "/Users/engs2510/Documents/Git/PyBOP/.nox/notebooks-overwrite/bin/python3: No module named pip\r\n"
+      "Note: you may need to restart the kernel to use updated packages.\n"
+     ]
+    },
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "/Users/engs2510/Documents/Git/Second_PyBOP/.nox/notebooks-overwrite/bin/python3: No module named pip\r\n"
      ]
     },
     {
@@ -62,7 +68,7 @@
     "\n",
     "import pybop\n",
     "\n",
-    "pybop.PlotlyManager().pio.renderers.default = \"notebook_connected\""
+    "pybop.plot.PlotlyManager().pio.renderers.default = \"notebook_connected\""
    ]
   },
   {
@@ -188,28 +194,28 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "Time Evaluate IDA KLU solver: 0.303\n"
+      "Time Evaluate IDA KLU solver: 0.306\n"
      ]
     },
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "Time Evaluate CasADi solver with 'safe' mode: 1.076\n"
+      "Time Evaluate CasADi solver with 'safe' mode: 1.097\n"
      ]
     },
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "Time Evaluate CasADi solver with 'fast' mode: 1.003\n"
+      "Time Evaluate CasADi solver with 'fast' mode: 1.090\n"
      ]
     },
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "Time Evaluate CasADi solver with 'fast with events' mode: 1.008\n"
+      "Time Evaluate CasADi solver with 'fast with events' mode: 0.915\n"
      ]
     }
    ],
@@ -242,28 +248,28 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "Time EvaluateS1 IDA KLU solver: 0.671\n"
+      "Time EvaluateS1 IDA KLU solver: 0.622\n"
      ]
     },
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "Time EvaluateS1 CasADi solver with 'safe' mode: 4.479\n"
+      "Time EvaluateS1 CasADi solver with 'safe' mode: 3.886\n"
      ]
     },
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "Time EvaluateS1 CasADi solver with 'fast' mode: 3.440\n"
+      "Time EvaluateS1 CasADi solver with 'fast' mode: 3.498\n"
      ]
     },
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "Time EvaluateS1 CasADi solver with 'fast with events' mode: 3.287\n"
+      "Time EvaluateS1 CasADi solver with 'fast with events' mode: 3.475\n"
      ]
     }
    ],
@@ -305,7 +311,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.4"
+   "version": "3.12.2"
   }
  },
  "nbformat": 4,