v24.3.1

What's Changed

• Release v24.3.1 by @BradyPlanden in #369

Full Changelog: v24.3...v24.3.1

v24.3

What's Changed

• chore: update pre-commit hooks by @pre-commit-ci in #154
• Docs site version switcher update. by @BradyPlanden in #159
• chore: update pre-commit hooks by @pre-commit-ci in #161
• Add design optimisation example by @NicolaCourtier in #149
• chore: update pre-commit hooks by @pre-commit-ci in #163
• chore: update pre-commit hooks by @pre-commit-ci in #168
• Revert np.inf return for non-physical optimisation locations by @BradyPlanden in #166
• chore: update pre-commit hooks by @pre-commit-ci in #171
• Add StandaloneProblem by @NicolaCourtier in #153
• Adding notebook examples by @BradyPlanden in #135
• Removes NLOpt Methods by @BradyPlanden in #172
• chore: update pre-commit hooks by @pre-commit-ci in #181
• I12b unscented kalman edits by @NicolaCourtier in #180
• initial sketch of observers with UKF as method by @martinjrobins in #152
• docs: add martinjrobins as a contributor for code, and test by @allcontributors in #184
• Add intermediate model classes by @NicolaCourtier in #183
• Design Optimisation Refactor and Additions by @BradyPlanden in #167
• Add VolumetricEnergyDensity example by @NicolaCourtier in #191
• chore: update pre-commit hooks by @pre-commit-ci in #194
• Fixes failing observer tests by @BradyPlanden in #197
• Add M1 GitHub runner and update scheduled tests by @BradyPlanden in #188
• Create dynamic GitHub Actions matrix to test against PyBaMM by @agriyakhetarpal in #193
• docs: add agriyakhetarpal as a contributor for code, and infra by @allcontributors in #199
• Patch for #193 - Add matrix to M-series runner by @BradyPlanden in #205
• Allow square-brackets access to dataset objects by @MarkBlyth in #182
• Add PEP517/518 pyproject.toml support by @agriyakhetarpal in #203
• chore: update pre-commit hooks by @pre-commit-ci in #208
• Add fitting functionality for geometric parameters by @BradyPlanden in #169
• Add Python 3.12 by @BradyPlanden in #209
• 139b Add unit tests for plotting and Thevenin model by @NicolaCourtier in #212
• Splits integration / examples / unit tests by @BradyPlanden in #204
• Update release workflow by @BradyPlanden in #215
• Remove stale assets, update architecture fig by @BradyPlanden in #221
• Update to allow no bounds by @NicolaCourtier in #213
• Adds PR Template by @BradyPlanden in #214
• Make likelihoods a type of cost by @NicolaCourtier in #230
• Adds Base Likelihoods, Maximum Likelihood Example by @BradyPlanden in #218
• chore: update pre-commit hooks by @pre-commit-ci in #234
• Datatype restructure for optimisation objects by @BradyPlanden in #224
• [WIP]: Add asv benchmarking by @BradyPlanden in #207
• Fix workflow for changing experiment by @NicolaCourtier in #240
• chore: update pre-commit hooks by @pre-commit-ci in #242
• Patch: benchmark solution tracking by @BradyPlanden in #243
• Additions to #177 by @BradyPlanden in #198
• Update plotting capabilities and dataset restructure by @NicolaCourtier in #178
• Adds import linting with ruff by @BradyPlanden in #245
• Fix gradient calculation from model.simulateS1 by @BradyPlanden in #260
• Make v24.3 by @BradyPlanden in #220

New Contributors

• @martinjrobins made their first contribution in #152
• @MarkBlyth made their first contribution in #182

Full Changelog: https://github.com/pybop-team/PyBOP/blob/develop/CHANGELOG.md

v23.12

Features

• #141 - Adds documentation with Sphinx and PyData Sphinx Theme. Updates docstrings across package, relocates costs and dataset to top-level of package. Adds noxfile session and deployment workflow for docs.
• #131 - Adds SciPyDifferentialEvolution optimiser, adds functionality for user-selectable maximum iteration limit to SciPyMinimize, NLoptOptimize, and BaseOptimiser classes.
• #107 - Adds Equivalent Circuit Model (ECM) with examples, Import/Export parameter methods ParameterSet.import_parameter and ParameterSet.export_parameters, updates default FittingProblem.signal definition to "Voltage [V]", and testing infrastructure
• #127 - Adds Windows and macOS runners to the test_on_push action
• #114 - Adds standard plotting class pybop.StandardPlot() via plotly backend
• #114 - Adds quick_plot(), plot_convergence(), and plot_cost2d() methods
• #114 - Adds a SciPy minimize example and logging for non-Pints optimisers
• #116 - Adds PSO, SNES, XNES, ADAM, and IPropMin optimisers to PintsOptimisers() class
• #38 - Restructures the Problem classes ahead of adding a design optimisation example
• #120 - Updates the parameterisation test settings including the number of iterations
• #145 - Reformats Dataset to contain a dictionary and signal into a list of strings

Breaking Changes

• #38 - Restructures the Problem classes into FittingProblem and DesignProblem. FittingProblem replaces previous Problem class
• #145 - Reformats Dataset class to contain a dictionary and signal into a list of strings.

v23.12rc0

CHANGELOG

• #141 - Adds documentation with Sphinx and PyData Sphinx Theme. Updates docstrings across package, relocates costs and dataset to top-level of package. Adds noxfile session and deployment workflow for docs.
• #131 - Adds SciPyDifferentialEvolution optimiser, adds functionality for user-selectable maximum iteration limit to SciPyMinimize, NLoptOptimize, and BaseOptimiser classes.
• #107 - Adds Equivalent Circuit Model (ECM) with examples, Import/Export parameter methods ParameterSet.import_parameter and ParameterSet.export_parameters, updates default FittingProblem.signal definition to "Voltage [V]", and testing infrastructure
• #127 - Adds Windows and macOS runners to the test_on_push action
• #114 - Adds standard plotting class pybop.StandardPlot() via plotly backend
• #114 - Adds quick_plot(), plot_convergence(), and plot_cost2d() methods
• #114 - Adds a SciPy minimize example and logging for non-Pints optimisers
• #116 - Adds PSO, SNES, XNES, ADAM, and IPropMin optimisers to PintsOptimisers() class
• #38 - Restructures the Problem classes ahead of adding a design optimisation example
• #120 - Updates the parameterisation test settings including the number of iterations
• #145 - Reformats Dataset to contain a dictionary and signal into a list of strings

v23.11

Initial release v23.11

• Pints, NLOpt, and SciPy optimisers available
• SumofSquareError and RootMeanSquareError cost functions available
• Parameter and dataset classes available
• Examples here