Skip to content

Commit 7e4d250

Browse files
Rename plot.quick to plot.problem (#684)
* Rename plot.quick to plot.problem * Update CHANGELOG.md * Update missed examples * Align new examples
1 parent 789f815 commit 7e4d250

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+58
-57
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919

2020
## Breaking Changes
2121

22+
- [#684](https://github.com/pybop-team/PyBOP/pull/684) - Updates `plot.quick` to `plot.problem` for clarity.
2223
- [#661](https://github.com/pybop-team/PyBOP/pull/661) - Adds `pybop.CostInterface` which aligns the optimisers and samplers with a unified `call_cost` in which transformations and sign inversions are applied. Also includes bug fixes for transformations and gradient calculations.
2324

2425

examples/notebooks/battery_parameterisation/ecm_trust-constr.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -415,7 +415,7 @@
415415
"pybop.plot.dataset(dataset)\n",
416416
"\n",
417417
"# Plot the timeseries output\n",
418-
"pybop.plot.quick(problem, problem_inputs=results.x, title=\"Optimised Comparison\")\n",
418+
"pybop.plot.problem(problem, problem_inputs=results.x, title=\"Optimised Comparison\")\n",
419419
"\n",
420420
"# Plot convergence\n",
421421
"pybop.plot.convergence(optim)\n",

examples/notebooks/battery_parameterisation/electrode_balancing.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,7 @@
313313
}
314314
],
315315
"source": [
316-
"pybop.plot.quick(problem, problem_inputs=results.x, title=\"Optimised Comparison\");"
316+
"pybop.plot.problem(problem, problem_inputs=results.x, title=\"Optimised Comparison\");"
317317
]
318318
},
319319
{

examples/notebooks/battery_parameterisation/equivalent_circuit_identification.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -425,7 +425,7 @@
425425
}
426426
],
427427
"source": [
428-
"pybop.plot.quick(problem, problem_inputs=results.x, title=\"Optimised Comparison\");"
428+
"pybop.plot.problem(problem, problem_inputs=results.x, title=\"Optimised Comparison\");"
429429
]
430430
},
431431
{

examples/notebooks/battery_parameterisation/equivalent_circuit_identification_hppc.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -342,7 +342,7 @@
342342
}
343343
],
344344
"source": [
345-
"pybop.plot.quick(problem, problem_inputs=results.x, title=\"Optimised Comparison\");"
345+
"pybop.plot.problem(problem, problem_inputs=results.x, title=\"Optimised Comparison\");"
346346
]
347347
},
348348
{

examples/notebooks/battery_parameterisation/equivalent_circuit_identification_multipulse.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -469,7 +469,7 @@
469469
}
470470
],
471471
"source": [
472-
"pybop.plot.quick(problem, problem_inputs=results.x, title=\"Optimised Comparison\");"
472+
"pybop.plot.problem(problem, problem_inputs=results.x, title=\"Optimised Comparison\");"
473473
]
474474
},
475475
{

examples/notebooks/battery_parameterisation/monte_carlo_ecm_identification.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -548,7 +548,7 @@
548548
}
549549
],
550550
"source": [
551-
"pybop.plot.quick(problem, results_optim.x)\n",
551+
"pybop.plot.problem(problem, results_optim.x)\n",
552552
"pybop.plot.convergence(optim)\n",
553553
"pybop.plot.parameters(optim);"
554554
]
@@ -921,7 +921,7 @@
921921
}
922922
],
923923
"source": [
924-
"pybop.plot.quick(problem, posterior_summary.mean);"
924+
"pybop.plot.problem(problem, posterior_summary.mean);"
925925
]
926926
},
927927
{

examples/notebooks/battery_parameterisation/multi_model_identification.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -546,7 +546,7 @@
546546
],
547547
"source": [
548548
"for optim, x in zip(optims, xs):\n",
549-
" pybop.plot.quick(\n",
549+
" pybop.plot.problem(\n",
550550
" optim.cost.problem, problem_inputs=x, title=optim.cost.problem.model.name\n",
551551
" )"
552552
]

examples/notebooks/battery_parameterisation/pouch_cell_identification.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -469,7 +469,7 @@
469469
}
470470
],
471471
"source": [
472-
"pybop.plot.quick(problem, problem_inputs=results.x, title=\"Optimised Comparison\");"
472+
"pybop.plot.problem(problem, problem_inputs=results.x, title=\"Optimised Comparison\");"
473473
]
474474
},
475475
{

examples/notebooks/battery_parameterisation/single_pulse_circuit_model.ipynb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -494,7 +494,7 @@
494494
"source": [
495495
"## Plotting and Visualisation\n",
496496
"\n",
497-
"PyBOP provides various plotting utilities to visualise the results of the optimisation. The `pybop.plot.quick` method provides a fast scatter of two variables. For this example, we plot the identified parameter set to the target dataset. The default plot is voltage vs time as shown below."
497+
"PyBOP provides various plotting utilities to visualise the results of the optimisation. The `pybop.plot.problem` method provides a fast scatter of two variables. For this example, we plot the identified parameter set to the target dataset. The default plot is voltage vs time as shown below."
498498
]
499499
},
500500
{
@@ -538,7 +538,7 @@
538538
}
539539
],
540540
"source": [
541-
"pybop.plot.quick(problem, problem_inputs=results.x, title=\"Optimised Comparison\");"
541+
"pybop.plot.problem(problem, problem_inputs=results.x, title=\"Optimised Comparison\");"
542542
]
543543
},
544544
{
@@ -747,7 +747,7 @@
747747
}
748748
],
749749
"source": [
750-
"pybop.plot.quick(problem, problem_inputs=results.x, title=\"Parameter Extrapolation\");"
750+
"pybop.plot.problem(problem, problem_inputs=results.x, title=\"Parameter Extrapolation\");"
751751
]
752752
},
753753
{

0 commit comments

Comments
 (0)