v2.1.0

CHANGELOG

v2.1.0 (2025-02-28)

Bug Fixes

• Differentiation deprecation warnings
  (6784590)

Chores

• Add ERA ruff rules for commented out code
  (0493b64)

• Add ipywidgets to readthedocs installation
  (620bdeb)

• Add matplotlib dependency
  (cb176fd)

• Add numpy checks to ruff
  (38d76ce)

• Add pandas dependency
  (2389168)

• Add print definitions rules to ruff
  (81a04c4)

• Add pycodestyle error rules to ruff
  (d53727b)

• Add pycodestyle warnings and implicit string contatenation to ruff
  (d228428)

• Add pyflakes rules to ruff
  (9f206bd)

• Add readthedocs config
  (3881e79)

• Add ruff checks for python builtins, code A
  (f89dfd9)

• Add ruff checks for type annotations
  (d2317cc)

• Add workflow to automatically create release when release candidate is merged
  (6320b23)

• Change numpy version dependency to align with pybamm
  (2cd44d0)

• Correct readthedocs config
  (4ab590b)

• Don't run benchmarks in ci
  (af93863)

• Exclude performance example from tests
  (7b6eba9)

• Fix deprecation warnings
  (6b1bf1f)

• Fix release workflows to checkout main
  (65d2886)

• Install pybamm in readthedocs build
  (33cc8d3)

• Remove sphinx workflow
  (f981b3d)

• Remove tools from pyproject.toml
  (960bc22)

• Run CI tests in parallel
  (aa77c66)

• Run notebooks sequentially instead of in parallel in CI
  (13e34d9)

• Update ci workflow
  (e990613)

• Update uv version in workflows
  (8308045)

• dependencies: Add pytest-xdist as dev dependency
  (41ffbaf)

• pytest: Remove pytest-mypy and disable benchmarks by default
  (e9b5b91)

Code Style

• Add flake8-commas ruff check
  (ebe8ee8)

• Add pyupgrade rules to ruff
  (0d559aa)

• Add ruff enforcement of PEP8 naming conventions
  (b1d4b95)

• Fix mypy errors for wrapped plotting functions
  (213aeb0)

Documentation

• Reorganise cell method order and deprecation labels
  (1bfb3a1)

• Switch from sphinx-apidoc to sphinx-autosummary
  (a764c02)

• Update examples with import api updates
  (b645868)

Don't build performance example in docs

• contributing: Add ruff and mypy guidance
  (367e41d)

• examples/working-with-pybamm-models: Remove dynamic plot from pybamm example
  (9af2209)

• README: Update documentation links
  (288778e)

• User Guide/Importing Data: Update to new function names
  (5f1bb20)

Features

• New unified import_from_cycler method for importing data straight into procedure
  (e99bb82)

• Unified cycler processing
  (f28a7ed)

• New preprocess module to contain cycler processing method - Replaced deprecated import with custom
  decorator - Created a decorator for catching and re-raising pydantic validation errors

• result: Add cache_columns and data_with_columns method to result
  (dc7e73d)

• cache_columns allows the user to specify columns to put in the cache - data_with_columns returns a
  dataframe filtered only to the specified columns This commit also adds ruff private member access
  checks

Performance Improvements

• Only load data into basecycler if required
  (0f8f444)

Refactoring

• Add a polars expression namespace for unit conversions
  (925c16c)

• Add flake8-simplify checks to ruff
  (59d4fb3)

• Add ruff check for flake8-comprehensions
  (7dc6316)

• Move all file handling into cycler base class
  (efb6a96)

• Replace Units class with polars units namespace
  (360f505)

• basecycler: New class-based structure for importing columns
  (c89f273)

• cell: Refactor cell to work with new basecycler class
  (55c35a9)

• cyclers: Update arbin, basytec and biologic modules
  (a1a7129)

• cyclers.neware: Update neware for new basecycler class
  (2a78538)

• maccor: Update maccor for new basecycler structure
  (f9e31af)

• tests.cell: Replace process cycler file test with checks on class calls
  (5c3b09e)

v2.0.1 (2025-02-10)

Bug Fixes

• cyclers.biologic: Add "Ewe/*" as a column alias for "Voltage [V]"
  (e662e46)

Chores

• Add CITATION.cff file
  (06d1b9a)

• Release candidate 2.0.1
  (5f6d2a3)

• workflows:...

v2.0.1

What's Changed

• Paper corrections by @tomjholland in #230
• chore: add CITATION.cff file by @tomjholland in #231
• docs: add citation guidelines to readme by @tomjholland in #232
• fix(cyclers.biologic): add "Ewe/*" as a column alias for "Voltage [V]" by @tomjholland in #235
• Release Candidate 2.0.1 by @github-actions in #236

Full Changelog: v2.0.0...v2.0.1

v2.0.0

What's Changed

• Improve codecov by @tomjholland in #225
• Release Candidate 2.0.0 by @github-actions in #226
• tests: allow different column orders in dashboard tests by @tomjholland in #227
• Release Candidate 2.0.0 by @github-actions in #228

Full Changelog: v1.4.0...v2.0.0

v1.4.0

What's Changed

• feat: add capability to export any Result object to a .mat file by @tomjholland in #217
• Add readme badges by @tomjholland in #219
• chore: add pre-commit.ci badge by @tomjholland in #220
• Release Candidate 1.4.0 by @github-actions in #218
• chore: add a .zenodo.json file by @tomjholland in #221
• Release Candidate 1.4.0 by @github-actions in #222
• chore: add isort setting to ruff by @tomjholland in #223
• Release Candidate 1.4.0 by @github-actions in #224

Full Changelog: v1.3.2...v1.4.0

v1.3.2

What's Changed

• chore: fix uv version in pre-commit and workflows by @tomjholland in #214
• Release Candidate 1.3.2 by @github-actions in #215

Full Changelog: v1.3.1...v1.3.2

v1.3.1

What's Changed

• fix: paper figure typo by @tomjholland in #210
• Fix biologic mb import errors by @tomjholland in #212
• chore: unfreeze uv sync for release candidate workflow by @tomjholland in #213
• Release Candidate 1.3.1 by @github-actions in #211

Full Changelog: v1.3.0...v1.3.1

v1.3.0

What's Changed

• Minor documentation fixes by @tomjholland in #195
• Review dev and optional dependencies by @tomjholland in #196
• docs: update readme and user manual to reflect plotting integrations by @tomjholland in #197
• Remove unneccessary dashboard dependencies by @tomjholland in #198
• Switch to ruff for linting and formatting by @tomjholland in #200
• chore: update workflow to v7 of create-pull-request gh action [skip ci] by @tomjholland in #201
• Add pybamm integration example by @tomjholland in #202
• chore: add codecov coverage upload by @tomjholland in #203
• Fix example output by @tomjholland in #204
• chore: run ci on push to main, exclude notebook tests on push by @tomjholland in #205
• docs: add matplotlib inline to pybamm example by @tomjholland in #206
• Minor update to figure 5 description of analysis methods in paper by @tomjholland in #179
• Release Candidate 1.3.0 by @github-actions in #199
• chore: remove lean differentiation example by @tomjholland in #207
• Fix parquet read speed example by @tomjholland in #209
• Release Candidate 1.3.0 by @github-actions in #208

Full Changelog: v1.2.0...v1.3.0

v1.2.0

What's Changed

• Test commit by @tomjholland in #184

Full Changelog: v1.1.4...v1.1.4-rc.6

What's Changed

• Add semantic versioning by @tomjholland in #185
• Replace auto publishing with workflow to create an rc PR by @tomjholland in #189
• Refactor polars handling and add external plotting tools by @tomjholland in #190
• fix: disallow minor prerelease from main branch by @tomjholland in #192
• Release Candidate 1.2.0 by @github-actions in #193

New Contributors

• @github-actions made their first contribution in #193

Full Changelog: v1.1.4...v1.2.0

v1.1.4

What's Changed

• Fix the sheet name to 'record' when importing Neware excel files by @tomjholland in #178
• Add logger by @tomjholland in #180
• Remove pybamm required dependency and incorporate uv as a package manager by @tomjholland in #181

Full Changelog: v1.1.3...v1.1.4

v1.1.3

What's Changed

• Rename typing module to avoid clash with built-in python module by @tomjholland in #175

Full Changelog: v1.1.2...v1.1.3