Skip to content

Releases: asajeevan/electrochem-toolkit

Cyclara 0.9.1

Choose a tag to compare

@asajeevan asajeevan released this 21 Oct 08:33
Immutable release. Only release title and notes can be modified.
991e3f7

Free software (GPL-3.0-or-later) that turns battery cycling data into checked numbers and journal-ready figures. It reads BioLogic EC-Lab .mpr and .mpt files, LANHE (LAND) .cex files, and the text or Excel exports of Arbin, Maccor, Neware, BaSyTec, Novonix, PEC and Landt cyclers, and learns any other cycler's export from one file.

New in 0.9.1

  • LANHE .cex files with pauses and restarts open. 0.9.0 refused the second .cex layout seen (05 00 04 00) and any test that had been paused or stopped. 0.9.1 reads both. A pause is read as it is, and the check of the record time against the tester's clock allows for it. When the tester stopped and then resumed from a state it had saved shortly before, it records those seconds twice and its own capacity counter drops their charge: Cyclara keeps every record and that charge, warns at each restart, and treats the interrupted branch as partial, so its cycle has no efficiency or retention (and no cycle has a retention when that cycle is the reference, until another reference cycle is chosen); the branch has no dQ/dE unless the restart falls in a constant-voltage hold at the start or end of the branch. Events in an order not seen before, a restart unlike the ones seen, and a place where the records break are refused with the reason. Verified on a second real file; a comparison with LANHE's own Excel export is still to come.
  • No dQ/dE across an interruption. A branch in which the time goes back, the current is missing or the instrument flagged an error has no dQ/dE: the potential after the break need not continue the curve before it, and at the restarts of the second real file such curves showed false peaks. As a precaution, a branch a LANHE tester paused partway, however briefly, has none either (at the pauses seen, the cell relaxed by a few millivolts and the curves did not change visibly). A pause leaves the capacities, efficiency and retention as they are. Only an interruption or pause between the first and last point of the curve counts, so one inside a constant-voltage hold at the start or end of a branch does not (the cycle still has no efficiency when it was a restart), and rows that only share a time stamp are not a break. The dQ/dE figures, views and peak tables leave such a branch out; the cycle notes, the dQ/dE view and the peak tables say which branch has no curve, a peak whose partner branch has none says so, and a figure with no curve at all says why.
  • The summary names the cycles it leaves out, not only an unfinished last one, and says when the reference cycle is not complete, so that no cycle has a retention; the methods paragraph says so too, and names the actual cause of each interruption.
  • Fixed: an export in which no branch of the cycles had a dQ/dE curve stopped with an error at the 3D figure (since 0.8.0). Each dQ/dE figure, and the dQ/dE view, now says why it is empty.
  • Peak tables: "first cycle only" and "appears from cycle k" are judged, for each direction, over the cycles in which that direction has a dQ/dE curve, and a new last column of dqde_peaks.csv, no_curve_cycles, lists the cycles whose branch has none. So a file that opens with an unpaired discharge no longer reports every charge peak as appearing from cycle 2, a direction with a curve in one cycle only is reported as "one cycle analysed", and a first-cycle-only peak names its cycle in summary.json. The cycles a peak is seen in are written as ranges over every cycle of the file, so a range breaks at any cycle without a curve in its direction, now also one in which no branch has a curve (0.9.0 ran through it).
  • The record time of a .cex is checked against the tester's clock interval by interval, so one change of the tester's clock (a summer-time change, for example) is reported with its place instead of refusing the file.
  • Known, and unchanged from earlier versions: the Landt Excel export checked prints the time to 0.01 h, so most consecutive rows share a time, and no cycle of it gets an efficiency or a retention (capacities and dQ/dE are given). Each cycle's note now says how many intervals were not integrated.

Install

Windows 10 (version 1903 or later) or 11, 64-bit: run Cyclara-0.9.1-Setup.exe, then Next, Install, Finish. No administrator password is needed, and it installs over 0.9.0. The first time, SmartScreen may say "Windows protected your PC", because the installer is not signed with a paid certificate: click More info, then Run anyway.

macOS 14 or later: unzip Cyclara-0.9.1-macOS-AppleSilicon.zip (M1 to M4) or Cyclara-0.9.1-macOS-Intel.zip, drag Cyclara.app to Applications and open it. The first time, macOS says it cannot verify the app: click Done, then System Settings > Privacy & Security > Open Anyway, and open it again. On macOS 14, right-click the app and choose Open.

The handout (Cyclara_handout_v0.9.1.pdf) shows every step with pictures.

Check your download

Download only from this page. If someone sends you the file another way, compare its SHA-256 with this list (also attached as SHA256SUMS.txt):

0cebaaa303d6789fa7554d96eb5b7947ed6f7a9a09f43a8d339b42d82a994e60  Cyclara-0.9.1-Setup.exe
a7aba4e5c990a179a6464ddf475637446c480f32bf248c7f5019534c24f4d082  Cyclara-0.9.1-macOS-AppleSilicon.zip
f17ee24df544d08ffca4955f773bc30ec9640a0a76e5843f9e21dcca6970ea30  Cyclara-0.9.1-macOS-Intel.zip
b22bd6fc9480d370865ecf1edf0e17924189538acaf2a85325ff16ccd0f23fc1  Cyclara_handout_v0.9.1.pdf
  • Windows, PowerShell: Get-FileHash .\Cyclara-0.9.1-Setup.exe
  • Windows, Command Prompt: certutil -hashfile Cyclara-0.9.1-Setup.exe SHA256
  • macOS, Terminal: shasum -a 256 ~/Downloads/Cyclara-0.9.1-macOS-AppleSilicon.zip
  • With the GitHub CLI, against GitHub's signed record of this release: gh release verify-asset v0.9.1 Cyclara-0.9.1-Setup.exe -R asajeevan/electrochem-toolkit

Tested

The installers were built from a clean checkout of commit 668b3ad, the source of this release; the commit after it adds only these checksums, the build evidence and documentation under docs/, none of which is inside the installers. On that checkout all 1067 tests pass on Linux. The Windows program, run with its bundled Python under Wine, opens every view of the demonstration file and passes its own suite (1046 tests); this installer, run under Wine over 0.9.0, installed a tree identical file for file to the one tested, and uninstalled cleanly. Before the build, five reviewers who had not written the code compared, in turn and each after the fixes of the one before, the statements about the new work in these notes, the handout and the documentation with the code; what they found is fixed (docs/handoffs/Project_Status_Addendum_2026-10-21b.md). The new code was also checked with 94 deliberate faults: 93 made a test fail, and the other one turned out not to change what the program does. On the 23 public measurement files in the repository that Cyclara analyses directly, every value of every cycle and of the summary, and every dQ/dE curve and peak, is the same as in 0.9.0; the differences are in notes and wording. Not yet run on a physical Windows PC or Mac: reports are welcome through Help > Report a problem.

Cite

Shyma Sajeevan, A. (2026). Cyclara: traceable analysis of battery cycling data (Version 0.9.1) [Computer software]. https://github.com/asajeevan/electrochem-toolkit

Cyclara 0.9.0

Choose a tag to compare

@asajeevan asajeevan released this 20 Oct 23:30
Immutable release. Only release title and notes can be modified.

Free software (GPL-3.0-or-later) that turns battery cycling data into checked numbers and journal-ready figures. It reads BioLogic EC-Lab .mpr and .mpt files, LANHE (LAND) .cex files, and the text or Excel exports of Arbin, Maccor, Neware, BaSyTec, Novonix, PEC and Landt cyclers, and learns any other cycler's export from one file.

New in 0.9.0

  • LANHE (LAND) .cex files open directly. Drop the tester's own file on the window. Cyclara checks its reading of each file against the tester's own records wherever the file holds enough of them: the current against its capacity counter, the voltage against its energy counter, the record time against its clock; a note says when a file is too short for a check. A .cex of a kind not seen before (another layout, step type, status event or unit kind, or a range code its own counters cannot confirm) is refused with the reason instead of being guessed. The tester's step table comes with the export as instrument_steps.csv. Verified on one real file; a comparison with LANHE's own Excel export of that file is still to come.
  • A step that ended at once no longer gives an efficiency. A step that stops at its first check (a charge to a voltage limit started on a cell already beyond that limit, for example) carries almost no charge, and paired with the full branch after it gave an efficiency of millions of per cent. A pair in which one branch has at most two rows and under 0.1 % of the other's charge keeps its capacities, energies and potentials, has no efficiency, energy efficiency or hysteresis, and its note says why; when that branch is the discharge, the cycle has no retention either and is left out of the cycle reaching 80 % and the fade line. When a file opens this way, the app asks whether each cycle starts with a charge or a discharge.
  • Fixed: the dQ/dE map left one panel empty when charge and discharge curves began in different cycles; a single cycle was labelled 1.50, 1.75 and so on; the bin width in the summary figure could sit over a curve; a withheld hysteresis was still drawn; a cycle cut short by the end of the file was described as having no partner branch; text exports whose rows end in a lone carriage return, and UTF-16 exports, could not be read; a binary file from another maker gave a raw error message instead of an instruction.

Install

Windows 10 (version 1903 or later) or 11, 64-bit: run Cyclara-0.9.0-Setup.exe, then Next, Install, Finish. No administrator password is needed, and it installs over 0.8.0. The first time, SmartScreen may say "Windows protected your PC", because the installer is not signed with a paid certificate: click More info, then Run anyway.

macOS 14 or later: unzip Cyclara-0.9.0-macOS-AppleSilicon.zip (M1 to M4) or Cyclara-0.9.0-macOS-Intel.zip, drag Cyclara.app to Applications and open it. The first time, macOS says it cannot verify the app: click Done, then System Settings > Privacy & Security > Open Anyway, and open it again. On macOS 14, right-click the app and choose Open.

The handout (Cyclara_handout_v0.9.0.pdf) shows every step with pictures.

Check your download

Download only from this page. If someone sends you the file another way, compare its SHA-256 with this list (also attached as SHA256SUMS.txt):

d7dfbb78a4cc6ccfe2926a55ef167986a0a83ba5054b67e0e1644d62244f8eb1  Cyclara-0.9.0-Setup.exe
96364ec97722dabafbdc80aa7a6729af087a20dce8ba04af0f27d56bd08b274b  Cyclara-0.9.0-macOS-AppleSilicon.zip
c4a31f3025822b23fd5cba37a5e336bc4a97e84013ff2023888be54bf32fb2e0  Cyclara-0.9.0-macOS-Intel.zip
3edcf3b823791b6613f9275f85a62caf150f4bcfe6c2e341f215fd405ac37a68  Cyclara_handout_v0.9.0.pdf
  • Windows, PowerShell: Get-FileHash .\Cyclara-0.9.0-Setup.exe
  • Windows, Command Prompt: certutil -hashfile Cyclara-0.9.0-Setup.exe SHA256
  • macOS, Terminal: shasum -a 256 ~/Downloads/Cyclara-0.9.0-macOS-AppleSilicon.zip
  • With the GitHub CLI, against GitHub's signed record of this release: gh release verify-asset v0.9.0 Cyclara-0.9.0-Setup.exe -R asajeevan/electrochem-toolkit

Tested

The installers were built from a clean checkout of commit 36be5dd, the source of this release; the commit after it adds only these checksums, the build evidence and documentation under docs/, none of which is inside the installers. On that checkout all 1002 tests pass on Linux. The Windows program, run with its bundled Python under Wine, opens every view of the demonstration file and passes its own suite (981 tests); this installer, run under Wine over 0.8.0, installed a tree identical file for file to the one tested, and uninstalled cleanly. Before the build, a reviewer who had not written the new code compared every statement about it in these notes, the handout and the documentation with the code; what it found is fixed (docs/handoffs/Project_Status_Addendum_2026-10-21.md). Not yet run on a physical Windows PC or Mac: reports are welcome through Help > Report a problem.

Cite

Shyma Sajeevan, A. (2026). Cyclara: traceable analysis of battery cycling data (Version 0.9.0) [Computer software]. https://github.com/asajeevan/electrochem-toolkit

Cyclara 0.8.0

Choose a tag to compare

@asajeevan asajeevan released this 20 Oct 18:30
Immutable release. Only release title and notes can be modified.

Free software (GPL-3.0-or-later) that turns battery cycling data into checked numbers and journal-ready figures. It reads BioLogic EC-Lab .mpr and .mpt files and the text or Excel exports of Arbin, Maccor, Neware, BaSyTec, Novonix, PEC and Landt cyclers, and learns any other cycler's export from one file.

New in 0.8.0

  • Several plateaus. Every dQ/dE peak gets the capacity under it, its partner in the opposite branch of the same cycle (within 200 mV) or the status unpaired, and the cycles in which it is seen (first cycle only, appears from cycle k). Nothing is labelled reversible or irreversible: that judgement stays with you. The average potential of a branch is the capacity-weighted mean of its plateau potentials.
  • Evolution view and two new figures: dQ/dE of every cycle as a colour map, and as 3D surfaces (charge and discharge).
  • Large files: a million-row EC-Lab export opens in a few seconds; other cyclers' exports are read in chunks with the progress shown, up to 2 GB.
  • Help > How the numbers are calculated: every quantity in plain words and in full, with the settings of the open file and a methods paragraph to copy.
  • Help > Cite Cyclara: the reference, BibTeX, CITATION.cff or a methods sentence, one click each.
  • Fixed: files over 100 000 rows raised an error in the time plots; the average voltage was described as energy-weighted (it is charge-weighted; the numbers were always right).

Install

Windows 10 (version 1903 or later) or 11, 64-bit: run Cyclara-0.8.0-Setup.exe, then Next, Install, Finish. No administrator password is needed, and it installs over 0.7.0. The first time, SmartScreen may say "Windows protected your PC", because the installer is not signed with a paid certificate: click More info, then Run anyway.

macOS 14 or later: unzip Cyclara-0.8.0-macOS-AppleSilicon.zip (M1 to M4) or Cyclara-0.8.0-macOS-Intel.zip, drag Cyclara.app to Applications and open it. The first time, macOS says it cannot verify the app: click Done, then System Settings > Privacy & Security > Open Anyway, and open it again. On macOS 14, right-click the app and choose Open.

The handout (Cyclara_handout_v0.8.0.pdf) shows every step with pictures.

Check your download

Download only from this page. If someone sends you the file another way, compare its SHA-256 with this list (also attached as SHA256SUMS.txt):

7182922082ba701e517987f18c7a285464a54b4e2a503788d38d8e7ca43d2070  Cyclara-0.8.0-Setup.exe
20ab5b3d96153f5b10118e2e5ffccf3776a85759180b8f97f705f616fc528fb3  Cyclara-0.8.0-macOS-AppleSilicon.zip
fc4ad59cb0ae7da111e5d424677eff7c7cdd8c537837c555c6767b8d74d54dd1  Cyclara-0.8.0-macOS-Intel.zip
12e639bab09db54edfe321e7c6cb5318c9e1c3bd65731bf2e52d3983389d5d18  Cyclara_handout_v0.8.0.pdf
  • Windows, PowerShell: Get-FileHash .\Cyclara-0.8.0-Setup.exe
  • Windows, Command Prompt: certutil -hashfile Cyclara-0.8.0-Setup.exe SHA256
  • macOS, Terminal: shasum -a 256 ~/Downloads/Cyclara-0.8.0-macOS-AppleSilicon.zip
  • With the GitHub CLI, against GitHub's signed record of this release: gh release verify-asset v0.8.0 Cyclara-0.8.0-Setup.exe -R asajeevan/electrochem-toolkit

Tested

The installers were built from a clean checkout of commit c7014cc, on which all 925 tests pass on Linux. The Windows program, run with its bundled Python under Wine, passes its own suite of 920 tests, and this installer was checked under Wine by installing it over 0.7.0, opening every view and uninstalling it. The tag v0.8.0 is on the next commit, 1463d92, which adds only these checksums and the build evidence under docs/, none of which is inside the installers. Not yet run on a physical Windows PC or Mac: reports are welcome through Help > Report a problem.

Cite

Shyma Sajeevan, A. (2026). Cyclara: traceable analysis of battery cycling data (Version 0.8.0) [Computer software]. https://github.com/asajeevan/electrochem-toolkit