Skip to content

Latest commit

 

History

History
728 lines (451 loc) · 31.8 KB

CHANGELOG.md

File metadata and controls

728 lines (451 loc) · 31.8 KB

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: Fix path filters to search recursively into folders (5eaa122)

Documentation

  • Add citation guidelines to readme (82a173d)

  • Change affiliation location from UK to United Kingdom (01e2d30)

  • Correct missing word typo in paper (3c04e46)

v2.0.0 (2025-02-03)

Bug Fixes

  • Allow units module to deal with percentage symbols (14f6176)

  • Move critical plot functionality for dashboard into dashboard script (ff88c3d)

  • Remove blank title from plot (df3ff12)

Chores

  • Add pybamm installation to ci workflow (f8f21cc)

  • Release candidate 2.0.0 (42d0f98)

  • Release candidate 2.0.0 (0918db3)

  • Run pytest with uv (db65402)

  • ci: Update ci workflow to install pybamm before running tests (eaf42e1)

Refactoring

  • Remove deprecated analysis classes (600c04a)

BREAKING CHANGE: class-based structure for the analysis module has been replaced with single functions within the same module

  • Remove deprecated Plot class (b03ab52)

BREAKING CHANGE: removal of deprecated class due to maintenance overhead. Use Result.plot(), Result.hvplot() or seaborn wrapper instead

  • Reorganise dashboard into class and add tests for full coverage (a06ec46)

  • Reorganise data processing methods (63a5bd7)

  • Split dashboard into functions and add tests (bf38f5f)

v1.4.0 (2025-01-31)

Chores

  • Add a .zenodo.json file (29be1c1)

  • Add isort setting to ruff (24408a1)

  • Add JOSS status badge (43a94a9)

  • Add path filters for sphinx workflow (480dcca)

  • Add pre-commit.ci badge (247e5bc)

  • Add status badges to readme (87de879)

  • Release candidate 1.4.0 (a1e1a22)

  • Release candidate 1.4.0 (0d3181d)

  • Release candidate 1.4.0 (e62a02d)

  • Replace pre-commit action with pre-commit.ci (d360ec4)

  • Specify paths for ci workflow (24f7119)

Features

  • Add capability to export any Result object to a .mat file (d5b94a6)

v1.3.2 (2025-01-22)

Bug Fixes

  • Fix uv version in pre-commit and workflows (246d7b1)

Chores

  • Release candidate 1.3.2 (7e77220)

v1.3.1 (2025-01-22)

Bug Fixes

  • Concat biologic MB files diagonally to prevent schema conflict errors (95e97fc)

  • Paper figure typo (8cfe8c1)

Chores

  • Add --frozen flag to uv sync commands in workflows (b158397)

  • Release candidate 1.3.1 [skip ci] (7764404)

  • Replace warnings with logger for missing columns in data (dbd16c9)

  • Unfreeze uv sync for release candidate workflow (3692bc5)

v1.3.0 (2025-01-12)

Bug Fixes

  • cell: Correct incompatible data/lazyframes in pybamm_experiment property (3a2ca00)

Chores

  • Add --seed creation of uv venv during workflows (45a5fbe)

  • Add codecov coverage upload (8c7a8ce)

  • Add condition to release candidate workflow (80cf916)

Prevents running the workflow when a merge is made from a branch created by the release candidate workflow itself

  • Add readme info to pyproject.toml (0e4a25f)

  • Add two step coverage upload using artifacts (b17ad0c)

  • Add urls and classifiers to pyproject.toml (ef08ea5)

  • Fix coverage workflow (3ff3028)

  • Fix ruff linting errors (e32a067)

  • Ignore D103 (docstring in public function) in examples (f2a79c2)

  • Ignore performance example from pytest on notebook examples (62adee0)

  • Make ruff a dev dependency (2ffc0a2)

  • Move dev dependencies into optional dependency group (2202c22)

Dependency groups are currently not supported for backwards compatibility with pip. Wait for resolution of PEP 735

  • Recategorise xlsxwriter as dev dependency (699a850)

  • Release candidate 1.3.0 [skip ci] (f0384a3)

  • Release candidate 1.3.0 [skip ci] (d14ffce)

  • Remove lean differentiation example (1a07ae9)

  • Remove ordered-set and distinctipy dependencies (314f0e9)

  • Run ci on push to main, exclude notebook tests on push (43e30f8)

  • Update nbstripout precommit hook to remove kernelspec (ea8e10b)

  • Update workflow to v7 of create-pull-request gh action [skip ci] (8b3e2d3)

  • Update workflows for dependency reorganisation (a1a76d2)

  • Use % magic to install pybamm and matplotlib in example notebooks (62154c3)

Code Style

  • Run ruff format on examples and docs config files (adb57cc)

  • Run ruff format on pyprobe/ and tests/ (e8a267c)

Documentation

  • Add citations to pybamm example (0af6632)

  • Add detail for creating a jupyter kernel from uv .venv (35b33bd)

  • Add inline matplotlib magic to show plots in examples (47ee154)

  • Add matplotlib inline to pybamm example (b43a809)

  • Add mention of pybamm integration to paper (e8549d9)

  • Add optional dependency detail for hvplot and seaborn (0045fd4)

  • Add plotting example to examples toc (f8e2026)

  • Add pybamm example to docs index (a5c08f6)

  • Add some missing citations and describe plotting integrations (cd4b853)

  • Capture output for installing packages in notebook (7f870c3)

  • Create pybamm integration example (7ad73e3)

  • Fix errors and typos in documentation (458e4c6)

  • Fix mistake with comparing parquet read times not overwriting exiting files (28c0526)

  • Fix performance example for different parquet settings (7ba7053)

  • Fix syntax highlighting in examples (9a724c7)

  • Minor typo fix to paper (5017aec)

  • Remove kernelspec from example notebooks (6e278f6)

  • Remove mention of the requirement to specify a "Name" for a cell (cc1313f)

  • Update dev install instructions (f3740bf)

  • Update readme and user manual to reflect plotting integrations (553350f)

Features

  • Add a selectbox for a cell identifier to replace the "Name" field (5657285)

  • Allow any dict values in info dictionary (c610126)

Refactoring

  • Move cell identifier to below plot (6a5e1c4)

  • Remove colour generation in make_cell_list method (d7704cc)

  • Remove OrderedSet use in dashboard (26b38e1)

  • Remove search for color entry in info dict (9894e58)

This changes the default behaviour to cycle through the colours built-in to plotly

  • Remove setting of a default name and colour assignment in cell (9219eaf)

  • Replace black, flake8 and isort config with ruff (8b7c508)

Testing

  • Don't check column order in add_procedure test (5e0ce2d)

  • Fix Plot class tests (f9df697)

  • Move pybamm out of dev dependencies (fc720d1)

Use pytest.importorskip for skipping pybamm tests if it is not installed

  • Skip seaborn tests if it is not installed (ed8b04b)

v1.2.0 (2025-01-02)

Bug Fixes

  • Disallow minor prerelease from main branch (6b595f6)

  • Error from rebase (62a0e5f)

  • Issue with missing experiment tuple on dashboard (21d22c8)

  • Pass label argument to plot through as string (c8fdcc5)

Prevents collection of columns if label argument happens to match a column name

  • result: Bug in combine_results method (f1c40a0)

Chores

  • Add hvplot and seaborn as optional dependencies (217598c)

  • Add ipykernel dependency (ae27260)

  • Add nbmake as developer requirement (82d6867)

  • Add python-semantic-release as dependency (9458f82)

  • Add setup for semantic release (0523185)

  • Release candidate 1.2.0 [skip ci] (c29dddb)

  • Remove pip-tools requirements files (5924f31)

  • Remove show_image method and associated dependencies (b3011d5)

kaleido and ipython removed as required dependencies. This is not a breaking change as the .show() method remains.

  • Replace auto publishing with workflow to create an rc PR (57b9de6)

  • Set up workflow for pre-release (be4aa88)

  • Use _version.py for version numbering (b621de0)

Documentation

  • Add explanations for quick_add_procedure (0617e37)

  • Add matplotlib/pandas and hvplot to plotting example (6bc9649)

  • Remove show_image() from LEAN differentiation example (1867836)

  • Simplify developer installation instructions (860b663)

Remove requirement to specify all groups independently

  • Update contributing guidelines (fe47fc0)

  • Update examples to use .plot() method (dd2cbf9)

Features

  • Add a method for adding a procedure without a README file (4b9e80d)

  • Add buffer to charge and discharge filters to exclude noise around zero current (2b1c62d)

  • Add capability to read biologic mpt files that have no header (0a3f82d)

  • Add full-word Seconds unit (70743b7)

  • Add method to combine multiple result objects (744f496)

This will integrate their info dicts into the dataframe

  • Add user control of the header row index and date format when importing a generic file (2866a91)

  • Add utility methods for plot and hvplot to result objects (f0c1f10)

  • Allow specification of header rows in experiment log file (28b7a48)

  • Create seaborn wrapper (5b9eb18)

Refactoring

  • Add cache for collected columns of the base dataframe (1d7ae55)

  • Remove unit information from column definitions (cf5f627)

v1.1.4 (2024-12-31)

v1.1.3 (2024-12-07)

v1.1.2 (2024-12-07)

v1.1.1 (2024-12-03)

v1.1.0 (2024-11-29)

Documentation

  • contributor: Contrib-readme-action has updated readme (70da06d)

v1.0.3 (2024-10-04)

v1.0.2 (2024-09-16)

v1.0.1 (2024-09-16)

v1.0.0 (2024-09-16)

v0.1.4 (2024-06-18)

v0.1.3 (2024-06-17)

v0.1.2 (2024-06-11)

v0.1.1 (2024-06-05)

v0.1.0 (2024-06-02)

Documentation

  • contributor: Contrib-readme-action has updated readme (ba1a272)