Documentation

BattINFO is the implementation layer for the EMMO domain-battery ontology, JSON Schemas, a Python library, a CLI, and curated mapping tables for authoring, validating, and publishing battery metadata as Linked Data.

Building with BattINFO? Open the developer reference →

Full Python API, CLI commands, JSON Schemas, the validation contract, and executable notebook tutorials.

Developer reference

Quickstart

Install and publish a record

install

python -m venv .venv
# until the 0.8 release lands on PyPI, install from source:
.venv/bin/pip install git+https://github.com/BIG-MAP/BattINFO.git

python

from battinfo import CellSpec, publish

result = publish(
    CellSpec(
        manufacturer="A123",
        model="ANR26650M1-B",
        format="cylindrical",
        chemistry="Li-ion",
        nominal_capacity={"value": 2.5, "unit": "Ah"},
    ),
    destination="local",
)
print(result.canonical_iri)
# https://w3id.org/battinfo/spec/7d9k-2m4p-8t3x-6nq5

Full notebook walkthroughs are rendered in the documentation guides.

Tutorials

Learn the model step by step

Concepts

The record model, IRIs, and the semantic layer.

Describing a cell

Author and publish a cell spec, with a taste of material-level depth.

Linked records

Cells, test specs, tests, and datasets with the workspace.

Semantic layer

JSON-LD anatomy, EMMO type stacking, RDF and SPARQL.

Cell descriptors

Research-grade composition: materials, BOMs, electrodes, electrolyte.

Publish your first dataset

Raw cycler export → validated records → DOI, in five stages.

Reference

Schemas, ontology, and policy

JSON Schemas

Draft 2020-12 schemas for every record type, the canonical contract.

Ontology (battinfo.ttl)

OWL application ontology importing pinned EMMO domain-battery + domain-electrochemistry.

Identifier policy

How w3id.org/battinfo IRIs are minted, governed, and kept stable.

Property & unit mappings

Curated property→EMMO-IRI and unit→EMMO/QUDT-IRI tables driving the JSON-LD transform.

Tools

Validate and convert in the browser

Validate a record

An instant structural pre-check, mirroring the package’s issue model, with a one-line command to reproduce the canonical verdict.

Convert to JSON-LD

What ws.convert() supports for every cycler format, and how the converted tables become linked records.

Standards

What BattINFO builds on

EMMONormative semantics JSON-LDLinked Data serialization JSON SchemaStructural contract PydanticTyped authoring models schema.orgWeb-native vocabulary bridge

Scope

BattINFO and the ontology

The normative semantics live in EMMO domain-battery. BattINFO is the non-normative, operational layer: schemas, mappings, and tooling. It does not host or modify the upstream ontology.

Identifiers minted by BattINFO resolve through the community PURL service at w3id.org/battinfo, this website is documentation, not the resolver.

See a worked example →