Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 1.85 KB

CHANGELOG.md

File metadata and controls

46 lines (30 loc) · 1.85 KB

thevenin Changelog

New Features

Optimizations

Bug Fixes

Breaking Changes

New Features

  • Added Coulombic efficiency (ce) as a parameter option (#4)

Optimizations

  • Bounded exponential input to avoid overflow warnings inside the sigmoid function of loadfns.Ramp2Constant (#6)

Bug Fixes

  • *Solution.plot() now has a show_plot option to register plt.show() and block at the end of a program (#5). This keeps figures from auto-closing at the end of scripts run in non-interactive environments. Interactive environments (IPython, Jupyter Notebook) are not affected. When set to False, users running in non-interactive environments must manually call plt.show(). The default is True.

Breaking Changes

  • New Coulombic efficiency option means users will need to update old params inputs to also include ce

Bug Fixes

  • Corrected some docstrings

This is the first official release of thevenin. Main features/capabilities are listed below.

Features

  • Support for any number of RC pairs
  • Run constant or dynamic loads with current, voltage, or power control
  • Parameters have temperature and state of charge dependence
  • Experiment limits to trigger switching between steps
  • Multi-limit support (end at voltage, time, etc. - whichever occurs first)

Notes

  • Implemented pytest with full package coverage
  • Source/binary distributions available on PyPI
  • Documentation available on Read the Docs