Skip to content

CHANGELOG.md

Latest commit

 

History

History
396 lines (275 loc) · 8 KB

CHANGELOG.md

File metadata and controls

396 lines (275 loc) · 8 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[1.3.0] - 2026-08-06

Added

  • Support for all known .ndax (10 new file versions)
  • Support for all known .nda (25 new file versions)
  • Improved .nda metadata reading
  • batch-convert-metadata CLI command
  • --version CLI flag
  • Support for more step types
  • Support for more current ranges

Changed

  • Performance improvements

[1.2.0] - 2026-06-12

Added

  • "bdf-pref" for bdf preferred columns

Changed

  • columns="bdf" changes
    • step_capacity_ah -> step_net_capacity_ah
    • step_energy_wh -> step_net_energy_wh
    • step_index -> step_id
  • Performance improvements

Fixed

  • step_count in .ndax ndc 17 filetype 18

[1.1.1] - 2026-03-17

Added

  • Initial nda 23 support
  • Python 3.14 support

Changed

  • Performance improvements

[1.1.0] - 2026-02-09

Added

  • Option to output with 'Battery Data Format' columns, use columns="bdf" or --columns=bdf
  • Initial nda 22 and 26 support

Changed

Fixed

  • Improved BTS9.1 compatibility
  • Typos in nda aux columns

[1.0.1] - 2026-01-19

Added

  • step_type_map for converting step integer codes

Fixed

  • Bump pyarrow version, fixing pandas reading of arrow files

[1.0.0] - 2025-12-18

Added

  • raw_categories option in read() and CLI, returns step_type as integer
  • NDA8 support
  • Improved NDA 130 BTS 9.0 support

Changed

  • step_type column is now categorical type instead of enum

[0.3.0] - 2025-12-10

Added

  • Command-line interface
  • total_time_s column

Changed

  • Column status becomes step_type
  • software_cycle_number merged into cycle_mode option

Removed

  • datetime column, use unix_time_s instead

[0.2.5] - 2025-12-01

Changed

  • More detailed metadata reading

[0.2.4] - 2025-11-19

Changed

  • Filter data using bitmask

[0.2.3] - 2025-11-11

Added

  • NDA 130 BTS9.1 returns both step time and total time

Fixed

  • NDC17 step count
  • Consistent duplicate index handling
  • Typos

[0.2.2] - 2025-10-03

Added

  • More testing

Fixed

  • Improved compatibility for NDC2 and NDC5
  • Consistent step type naming

[0.2.1] - 2025-09-25

Added

  • Tests for auxiliary data
  • NDC16 support
  • NDC17 with aux support

Changed

  • Empty aux columns are dropped

[0.2.0] - 2025-08-13

Changed

  • Vectorized file parsing
  • Switched from pandas to polars
  • ruff formatting

Fixed

  • Time interpolation
  • Duplicate indices

[0.1.0] - 2025-08-08

Changed

[v2025.06.02]

Fixed

  • Higher-precision Timestamp interpolation.
  • Compatibility with PEP 639.

[v2025.05.15]

Added

  • Support for ndc file version 17

[v2025.04.02]

Added

  • Support for current range -40000

Changed

[v2025.02.13]

Added

  • Millisecond timestamp accuracy for ndc 11 and 14
  • Support for OCV step type
  • Additional current range

Fixed

  • Timestamp interpolation bug that occasionally resulted in negative dt

[v2025.01.02]

Added

  • Additional current range settings

Fixed

  • Addressed a PerformanceWarning related to the Timestamp field

[v2024.12.02]

Added

  • Support for ndax aux temperature (ndc version 14, filetype 5)

[v2024.10.01]

Added

  • Added regression tests for NewareNDAcli

Changed

  • Changed the NewareNDAcli flag from --software_cycle_number to --no_software_cycle_number

[v2024.09.03]

Added

  • dtype specifications for auxiliary data.
  • Addtional current range multipliers.
  • Regression tests for software_cycle_number and cycle_mode keywords.

Fixed

  • Millisecond timing now read from BTS 9.1 files.

Changed

  • Refactored NewareNDAx.py to explicitly treat ndc files based on version and filetype.

[v2024.08.01]

Added

  • Read aux temperature data from BTS 9.1 files.

Fixed

  • Bug fixes for BTS 9.1.

Changed

  • setup.py converted to pyproject.toml
  • Reworked logging functionality with new log_level keyword.

[v2024.07.01]

Added

  • Initial support for BTS 9.1 files.
  • Additional auxiliary fields read for ndc version 11.

Fixed

  • Incorrect range multiplier

[v2024.06.03]

Added

  • Active mass and comments are read and returned as a logging messages.
  • More regression tests.
  • Additional hardware ranges.
  • Aux voltage is now read from nda files.

Fixed

  • Correct voltage, current, capacity scalings for ndax files with ndc version 14 data.
  • Handling of timestamps now matches Neware. Dates are read as UTC and then converted to local time zone.

Changed

  • Warning now use logging.warning() instead of warnings.warn().

[v2024.05.01]

Added

  • Unsupported nda versions now raise exceptions.

Fixed

  • More robust support for nda version 130

[v2024.04.01]

Added

  • Github workflow with regression testing and code coverage.
  • Hardware range settings.

Fixed

  • Issue #50 related to missing Aux data.

[v2024.03.01]

Added

  • Additional range setting added.

Fixed

  • Resolved FutureWarnings for pandas 3.0

[v2024.02.01]

Added

  • Expanded ndax aux channel support (ndc version 11).
  • 'extras_require' added to setup.py for testing.

[v2024.01.02]

Added

  • Support for nda files from BTS9.
  • New 'cycle_mode' keyword argument to specify how cycle number should be generated.
  • Additional current ranges.

Fixed

  • Bug fixes for ndax support.

[v2023.12.01]

Added

  • Support for ndax from BTS Server 8.
  • Additional ndax verison information now returned as logging.

Changed

  • 'software_cycle_number=True' is now the default for ndax.

[v2023.11.01]

Added

  • Ability to read auxiliary data from ndax files.
  • pytest regression tests for code development.

Fixed

  • Support for constant power charge and discharge.
  • Additional current ranges.

Changed

  • 'software_cycle_number=True' is one again the default behavior for nda.

[v2023.10.02]

Added

  • Support for constant power charge and discharge.
  • Additional current ranges.

[v2023.07.03]

Added

  • Support for reading ndax.

[v2023.06.01]

Added

  • Missing current range.
  • Performance improvements

Changed

  • The cycle number is now read directly from the nda file for compatibility with the newest version of BTSDA. Previous numbering can be restored with the new 'software_cycle_number' flag.

[v2023.05.01]

Fixed

  • Issue #20, files failing to load.
  • Updates to README.

[v2023.04.14]

Added

  • Significant performance improvement.
  • PEP8 code formatting consistency.

Fixed

  • Issue #22 that occasionally resulted in incorrect temperature values.

[v2023.02.01]

Added

  • Support for additional current ranges and states

Fixed

  • Maintenance updates and code cleanup

Changed

  • Conditions used for locating first data record

[v2022.10.03]

Added

  • Additional current ranges

Fixed

  • Improved performance and reduced memory usage.

[v2022.09.06]

Added

  • Commandline nda file conversion tool
  • Performance improvements

Fixed

  • Added missing status and current ranges

Changed

  • 'Jump' field removed
  • Default index is used for the DataFrame and set_index() is no longer called

[v2022.08.01]

Added

  • Performance improvements

Fixed

  • Added missing status and current range

[v2022.07.01]

Added

  • Ability to read temperature fields

Fixed

  • Step field now matches Neware output
  • Correct handling of 'SIM' steps

Changed

  • Charge/discharge capacity/energy are now separate fields

[2022.06.01]

Added

  • More robust error handling
  • Additional hardware ranges implemented

Fixed

  • Cycle and Step now match Neware

[v0.1.0] - 2022-05-10

Added

  • Initial release tested on nda versions 7.6 and 8.0.