Docs

BATT-MX technical notes.

Short-form documentation for the current public preview surface: BattLang syntax, compiler flow, .battx package structure, CLI usage, and current limitations.

BattLang syntax

Editable source for battery-domain evidence.

BattLang is the human-editable source format. It links cell definitions, datasets, protocols, model instructions, validation ranges, and provenance metadata before sealing.

Reference

cell[LG_M50T][
    chemistry[NMC811]
    nominal_capacity_ah[5.0]
    voltage_window[2.5..4.2]
]

dataset[cycle_test_01][
    source[cycler_export.csv]
    format[arbin_csv]
    hash[sha256:...]
]

Compiler pipeline

Seal, validate, compile, inspect.

.battlang source is sealed into .batt input, validated against package rules, compiled into .battx, then inspected as a portable evidence package.

Reference

battmx seal examples/lg_m50t.battlang examples/lg_m50t.batt
battmx validate examples/lg_m50t.batt
battmx compile examples/lg_m50t.batt
battmx inspect build/LG_M50T_model.battx

.battx package format

Portable evidence package.

A .battx package carries model evidence, normalized data, validation reports, uncertainty notes, and source provenance together.

Reference

.battx/
  metadata.json
  cell.json
  dataset_manifest.json
  protocol.json
  model.json
  degradation_summary.json
  uncertainty.json
  validation_report.md
  normalized_data.csv
  provenance.json
  exports/
    pybamm_model.py
    fmu_stub.txt

Current limitations

Preview scope is intentionally narrow.

Synthetic examples

Public site examples are synthetic until benchmark datasets are published.

Importer coverage

Arbin, Neware, Maccor, and BioLogic importers are planned, not complete.

Compliance claims

BATT-MX does not claim full EU compliance or safety certification.

Exports

PyBaMM and FMU outputs are roadmap items. The FMU path requires a real FMI toolchain.

Signatures

Future .battx packages can be signed, but public preview examples are unsigned.