Backend conversion module for BattInfoConverter
Project description
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.
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file battinfoconverter_backend-3.2.0.tar.gz.
File metadata
- Download URL: battinfoconverter_backend-3.2.0.tar.gz
- Upload date:
- Size: 140.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b0eeb97e0a08ef0be2a0765e2fed34361f62c53f0ad1286c131f44e33edf92c0
|
|
| MD5 |
ebff4caba6d0becbb53b08ab844efc74
|
|
| BLAKE2b-256 |
85dd601a577178b03559c831bd169d9ae93367505be6d65e2149b2ea2ec3169b
|
Provenance
The following attestation bundles were made for battinfoconverter_backend-3.2.0.tar.gz:
Publisher:
pypi-publish.yml on EmpaEconversion/BattInfoConverter
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
battinfoconverter_backend-3.2.0.tar.gz -
Subject digest:
b0eeb97e0a08ef0be2a0765e2fed34361f62c53f0ad1286c131f44e33edf92c0 - Sigstore transparency entry: 1669150352
- Sigstore integration time:
-
Permalink:
EmpaEconversion/BattInfoConverter@fbc1f090905157a2c80a895c8a4a03d570db1b5d -
Branch / Tag:
refs/tags/v3.2.0 - Owner: https://github.com/EmpaEconversion
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypi-publish.yml@fbc1f090905157a2c80a895c8a4a03d570db1b5d -
Trigger Event:
release
-
Statement type:
File details
Details for the file battinfoconverter_backend-3.2.0-py3-none-any.whl.
File metadata
- Download URL: battinfoconverter_backend-3.2.0-py3-none-any.whl
- Upload date:
- Size: 140.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8277e9d44b04d318643c1349f94dfcdbbb9a9da62f25a962987dbfac6640cbb8
|
|
| MD5 |
9b25cdeafe3b3c9f8fe90662ba323936
|
|
| BLAKE2b-256 |
d5a63eccdabdcf4056d389dce7e8822792f96d9a863d8cd8d2f569aa898a078a
|
Provenance
The following attestation bundles were made for battinfoconverter_backend-3.2.0-py3-none-any.whl:
Publisher:
pypi-publish.yml on EmpaEconversion/BattInfoConverter
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
battinfoconverter_backend-3.2.0-py3-none-any.whl -
Subject digest:
8277e9d44b04d318643c1349f94dfcdbbb9a9da62f25a962987dbfac6640cbb8 - Sigstore transparency entry: 1669150526
- Sigstore integration time:
-
Permalink:
EmpaEconversion/BattInfoConverter@fbc1f090905157a2c80a895c8a4a03d570db1b5d -
Branch / Tag:
refs/tags/v3.2.0 - Owner: https://github.com/EmpaEconversion
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypi-publish.yml@fbc1f090905157a2c80a895c8a4a03d570db1b5d -
Trigger Event:
release
-
Statement type: