Skip to content

Latest commit

 

History

History
26 lines (17 loc) · 2.57 KB

CHANGELOG.md

File metadata and controls

26 lines (17 loc) · 2.57 KB
  • Added five parametrisation examples (two DFN parametrisation examples from About:Energy open-source release, blended electrode definition, user-defined 0th-order hysteresis, and SPM parametrisation). (#45)
  • Allow user-defined parameters to be added using the field ["Parameterisation"]["User-defined"] (#44)
  • Added basic API documentation (#43)
  • Added validation based on models: SPM, SPMe, DFN (#34). A warning will be produced if the user-defined model type does not match the parameter set (e.g., if the model is SPM, but the full DFN model parameters are provided).
  • Added support for well-mixed, blended electrodes that contain more than one active material (#33)
  • Added validation of the STO limits subbed into the OCPs vs the upper/lower cut-off voltage limits for non-blended electrodes with the OCPs defined as functions (#32). The user can provide a tolerance by updating the settings variable BPX.settings.tolerances["Voltage [V]"] or by passing extra option v_tol to parse_bpx_file(), parse_bpx_obj() or parse_bpx_str() functions. Default value of the tolerance is 1 mV. The tolerance cannot be negative.
  • Added the target SOC check in get_electrode_concentrations() function. Raise a warning if the SOC is outside of [0,1] interval.
  • Temporarily pin Pydantic version (#35)
  • Added a missing factor of 2 in the definition of the interfacial current, see the Butler-Volmer equation (2a) in the associated BPX standard document. The interfacial current is now given by $j=2j_0\sinh(F\eta/2/R/T)$ instead of $j=j_0\sinh(F\eta/2/R/T)$.
  • Parsing a BPX json file with additional (unexpected) fields now raises a ValidationError (#16)
  • Fixed a bug in the experiment schema (#13)

Initial release of the Battery Parameter eXchange (BPX) format.