Skip to main content

Backend conversion module for BattInfoConverter

Project description

BattINFO Converter

PyPI version License Python Versions Checks Coverage

BattINFO Converter is a Python-based web application that simplifies the semantic annotation of battery metadata. It converts coin cell battery metadata from an Excel-based schema into a JSON-LD format using the BattINFO ontology, ensuring standardized and machine-readable metadata. This tool is designed for non-technical users, eliminating the need for manual JSON-LD creation. Researchers only need to fill in an Excel template, and the converter automates the transformation process, enhancing data interoperability, reproducibility, and FAIRness. By adopting BattINFO Converter, research groups can ensure that their battery metadata is structured, shareable, and reusable, facilitating better collaboration and advancing battery research.

🔗 Visit BattINFO converter to use the app.

Python package

The backend that powers the web application is available as a Python package, which can be used for batch/automation tasks or reused in other projects. Install with:

pip install battinfoconverter-backend

Use the XLSX → JSON-LD conversion with:

from battinfoconverter_backend import convert_excel_to_jsonld

result = convert_excel_to_jsonld("example.xlsx")

If you want to run the streamlit app locally, clone the repo and use streamlit run. For example, with uv:

git clone https://github.com/empaeconversion/battinfoconverter  # Clone the repo
cd battinfoconverter  # Go into the cloned folder
uv sync --extras=app # Install battinfoconverter with app dependencies
uv run streamlit run ./battinfo_app/BattInfo_converter.py  # Run the app

Citation

Nukorn Plainpan, Simon Clark, and Corsin Battaglia. "BattINFO Converter: An Automated Tool for Semantic Annotation of Battery Cell Metadata." Batteries & Supercaps (2025): 2500151. doi.org/10.1002/batt.202500151

Acknowledgements

The BattINFO converter web application was developed by Dr. Nukorn Plainpan, Dr. Graham Kimbell, and Prof. Dr. Corsin Battaglia at Empa, the Swiss Federal Laboratories for Materials Science and Technology in the Laboratory Materials for Energy Conversion. We acknowledge stimulating discussions and support from Dr. Simon Clark, SINTEF.

The development of BattINFO converter was supported by funding for the Battery2030+ initiative from the European Union’s research and innovation program under grant agreement No. 957213 and No. 101104022 and from the Swiss State Secretariat for Education, Research, and Innovation (SERI) under contract No. 2300313 as well as funding for the PREMISE project from the open research data program of the ETH Board.

Sponsors

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

battinfoconverter_backend-3.2.0.tar.gz (140.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

battinfoconverter_backend-3.2.0-py3-none-any.whl (140.3 kB view details)

Uploaded Python 3

File details

Details for the file battinfoconverter_backend-3.2.0.tar.gz.

File metadata

File hashes

Hashes for battinfoconverter_backend-3.2.0.tar.gz
Algorithm Hash digest
SHA256 b0eeb97e0a08ef0be2a0765e2fed34361f62c53f0ad1286c131f44e33edf92c0
MD5 ebff4caba6d0becbb53b08ab844efc74
BLAKE2b-256 85dd601a577178b03559c831bd169d9ae93367505be6d65e2149b2ea2ec3169b

See more details on using hashes here.

Provenance

The following attestation bundles were made for battinfoconverter_backend-3.2.0.tar.gz:

Publisher: pypi-publish.yml on EmpaEconversion/BattInfoConverter

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file battinfoconverter_backend-3.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for battinfoconverter_backend-3.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8277e9d44b04d318643c1349f94dfcdbbb9a9da62f25a962987dbfac6640cbb8
MD5 9b25cdeafe3b3c9f8fe90662ba323936
BLAKE2b-256 d5a63eccdabdcf4056d389dce7e8822792f96d9a863d8cd8d2f569aa898a078a

See more details on using hashes here.

Provenance

The following attestation bundles were made for battinfoconverter_backend-3.2.0-py3-none-any.whl:

Publisher: pypi-publish.yml on EmpaEconversion/BattInfoConverter

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page