# BattINFO Converter
![BattINFO Converter](https://raw.githubusercontent.com/EmpaEconversion/BattInfoConverter/refs/heads/main/battinfoconverter.png)

## Overview

**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](https://github.com/BIG-MAP/BattINFO), 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 schema (visit BattINFO converter to learn more), and the converter automates the transformation process, enhancing data interoperability, reproducibility, and [FAIRness](https://www.go-fair.org/fair-principles/). By adopting **BattINFO Converter**, research groups can ensure that their battery metadata is structured, shareable, and reusable, facilitating better collaboration and advancing battery research.

🔗 Vist **[BattINFO converter](https://battinfoconverter.streamlit.app/)** to learn more.

## Python package

The backend utilities that power the web application are available as a standalone
package so they can be reused in other projects. Install it from a local clone or
directly from GitHub with:

```bash
pip install battinfoconverter-backend
```

After installation you can access the converter helpers with:

```python
from battinfoconverter_backend import json_convert

result = json_convert.convert_excel_to_jsonld("example.xlsx")
```

## License
BattINFO converter is released under MIT license.

## Citation 
If you find BattINFO converter useful and would like to cite our work in an academic jounral. Please consider citing our publication:  
[1] 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](https://doi.org/10.1002/batt.202500151)


## Acknowledgement

The BattINFO converter web application was developed by Dr. Nukorn Plainpan and Prof. Dr. Corsin Battaglia at [Empa](https://www.empa.ch/), the Swiss Federal Laboratories for Materials Science and Technology in the Laboratory [Materials for Energy Conversion](https://www.empa.ch/web/s501). We acknowledge stimulating discussions and support from Dr. Simon Clark, SINTEF as well as the help of Dr. Graham Kimbell, Empa in designing the BattINFO converter app logo and provding sanity check for the code quality, especially in the area of parameter type hinting. The development of BattINFO converter was supported by funding for the [Battery2030+](https://battery2030.eu/) 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](https://ord-premise.org/) project from the open research data program of the ETH Board

![Sponsors](https://raw.githubusercontent.com/EmpaEconversion/BattInfoConverter/refs/heads/main/sponsor.png)
