Skip to content

CHANGELOG.md

Latest commit

 

History

History
48 lines (39 loc) · 3.24 KB

CHANGELOG.md

File metadata and controls

48 lines (39 loc) · 3.24 KB
Raw

BATMODS-lite Changelog

Unreleased

New Features

  • Add slow NMC811 and GraphiteSiOx with the ability to pass OCV data as an input (#27)
  • Remove linspace option for tspan, add auto timesteps as an option (#26)
  • Adding NMC811 and GraphiteSiOx material for BatFIT calibrations (#22)
  • Check bounds of intercalation fraction before calculating exchange current density (#19)
  • Update materials module with new LFP properties, from ICI (#18)
  • Use CubicSpline interpolations for LFP properties (#15)
  • Add degradation parameters for the electrolyte (applies to P2D only) (#14)
  • Add submodels modules with optional Hysteresis class, and directional Ds / i0 (#13)
  • Exerpiment class interface allows for multi-step and dynamic load profiles
  • Simplified run and run_step methods to work with generalized Experiment class
  • New solver now provides additional statistics, e.g., number of function and Jacobian evaluations
  • Control-specific Solution classes are replaced with generalized StepSolution and CycleSolution

Optimizations

  • Reduce memory usage by delaying post-processing (slicing) steps (#17)
  • Replaced scikits-odes solver with scikit-sundae to improve installation
  • Sped up SPM by flipping cathode pointers so that bandwidth is reduced to +/- 2
  • Use a generic bandwidth function instead of having one per model subpackage

Bug Fixes

None.

Breaking Changes

  • Remove linspace option for tspan, add auto timesteps as an option (#26)
  • Removal of run_CC, run_CV, and run_CP methods
  • Renamed some attributes so they are no longer user-facing (_sv0, _algidx, etc.)

Chores

  • Add Development section/pages to the Read the Docs documentation (#25)
  • Improve development tools (use ruff, add codecov, host docs on RTD) (#24)
  • Make GitHub hyperlinks reference new org name NREL -> NatLabRockies (#21)
  • Rebrand NREL to NLR, and include name change for Alliance as well (#20)

v0.0.1

This is the first release of BATMODS-lite. Main features/capabilities are listed below. The release is only available on GitHub. Future releases, however, will also be distributed on PyPI.

Features

  • Working SPM and P2D models
  • Capability to run with current, voltage, or power demands

Notes

  • Models were verified mathematically by checking conservation equations
  • Validations were completed using COMSOL equivalents