Update README.md
Browse files
README.md
CHANGED
|
@@ -1,143 +1,58 @@
|
|
| 1 |
-
---
|
| 2 |
-
# For reference on dataset card metadata, see the spec: https://github.com/huggingface/hub-docs/blob/main/datasetcard.md?plain=1
|
| 3 |
-
# Doc / guide: https://huggingface.co/docs/hub/datasets-cards
|
| 4 |
-
{}
|
| 5 |
-
---
|
| 6 |
-
|
| 7 |
-
# Dataset Card for Dataset Name
|
| 8 |
-
|
| 9 |
-
<!-- Provide a quick summary of the dataset. -->
|
| 10 |
-
|
| 11 |
-
This dataset card aims to be a base template for new datasets. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md?plain=1).
|
| 12 |
-
|
| 13 |
-
## Dataset Details
|
| 14 |
-
|
| 15 |
-
### Dataset Description
|
| 16 |
-
|
| 17 |
-
<!-- Provide a longer summary of what this dataset is. -->
|
| 18 |
-
|
| 19 |
-
|
| 20 |
-
|
| 21 |
-
- **Curated by:** [More Information Needed]
|
| 22 |
-
- **Funded by [optional]:** [More Information Needed]
|
| 23 |
-
- **Shared by [optional]:** [More Information Needed]
|
| 24 |
-
- **Language(s) (NLP):** [More Information Needed]
|
| 25 |
-
- **License:** [More Information Needed]
|
| 26 |
-
|
| 27 |
-
### Dataset Sources [optional]
|
| 28 |
-
|
| 29 |
-
<!-- Provide the basic links for the dataset. -->
|
| 30 |
-
|
| 31 |
-
- **Repository:** [More Information Needed]
|
| 32 |
-
- **Paper [optional]:** [More Information Needed]
|
| 33 |
-
- **Demo [optional]:** [More Information Needed]
|
| 34 |
-
|
| 35 |
-
## Uses
|
| 36 |
-
|
| 37 |
-
<!-- Address questions around how the dataset is intended to be used. -->
|
| 38 |
-
|
| 39 |
-
### Direct Use
|
| 40 |
-
|
| 41 |
-
<!-- This section describes suitable use cases for the dataset. -->
|
| 42 |
-
|
| 43 |
-
[More Information Needed]
|
| 44 |
-
|
| 45 |
-
### Out-of-Scope Use
|
| 46 |
-
|
| 47 |
-
<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
|
| 48 |
-
|
| 49 |
-
[More Information Needed]
|
| 50 |
-
|
| 51 |
-
## Dataset Structure
|
| 52 |
-
|
| 53 |
-
<!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
|
| 54 |
-
|
| 55 |
-
[More Information Needed]
|
| 56 |
-
|
| 57 |
-
## Dataset Creation
|
| 58 |
-
|
| 59 |
-
### Curation Rationale
|
| 60 |
|
| 61 |
-
<!-- Motivation for the creation of this dataset. -->
|
| 62 |
|
| 63 |
-
|
| 64 |
|
| 65 |
-
|
| 66 |
-
|
| 67 |
-
<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
|
| 68 |
-
|
| 69 |
-
#### Data Collection and Processing
|
| 70 |
-
|
| 71 |
-
<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
|
| 72 |
-
|
| 73 |
-
[More Information Needed]
|
| 74 |
-
|
| 75 |
-
#### Who are the source data producers?
|
| 76 |
-
|
| 77 |
-
<!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
|
| 78 |
-
|
| 79 |
-
[More Information Needed]
|
| 80 |
-
|
| 81 |
-
### Annotations [optional]
|
| 82 |
-
|
| 83 |
-
<!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
|
| 84 |
-
|
| 85 |
-
#### Annotation process
|
| 86 |
-
|
| 87 |
-
<!-- This section describes the annotation process such as annotation tools used in the process, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->
|
| 88 |
-
|
| 89 |
-
[More Information Needed]
|
| 90 |
-
|
| 91 |
-
#### Who are the annotators?
|
| 92 |
-
|
| 93 |
-
<!-- This section describes the people or systems who created the annotations. -->
|
| 94 |
-
|
| 95 |
-
[More Information Needed]
|
| 96 |
-
|
| 97 |
-
#### Personal and Sensitive Information
|
| 98 |
-
|
| 99 |
-
<!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
|
| 100 |
-
|
| 101 |
-
[More Information Needed]
|
| 102 |
-
|
| 103 |
-
## Bias, Risks, and Limitations
|
| 104 |
-
|
| 105 |
-
<!-- This section is meant to convey both technical and sociotechnical limitations. -->
|
| 106 |
-
|
| 107 |
-
[More Information Needed]
|
| 108 |
-
|
| 109 |
-
### Recommendations
|
| 110 |
|
| 111 |
-
|
|
|
|
|
|
|
|
|
|
| 112 |
|
| 113 |
-
|
| 114 |
|
| 115 |
-
##
|
| 116 |
|
| 117 |
-
|
| 118 |
|
| 119 |
-
**
|
| 120 |
|
| 121 |
-
|
|
|
|
|
|
|
|
|
|
| 122 |
|
| 123 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 124 |
|
| 125 |
-
|
| 126 |
|
| 127 |
-
##
|
| 128 |
|
| 129 |
-
|
|
|
|
| 130 |
|
| 131 |
-
|
| 132 |
|
| 133 |
-
##
|
| 134 |
|
| 135 |
-
|
|
|
|
|
|
|
| 136 |
|
| 137 |
-
|
| 138 |
|
| 139 |
-
|
| 140 |
|
| 141 |
-
|
|
|
|
|
|
|
| 142 |
|
| 143 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
|
|
|
|
| 2 |
|
| 3 |
+
# Dataset for publication "Toward an Autonomous Robotic Battery Materials Research Platform Powered by Automated Workflow and Ontologized Findable, Accessible, Interoperable, and Reusable Data Management"
|
| 4 |
|
| 5 |
+
---
|
| 6 |
+
## 🔬 Scope
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 7 |
|
| 8 |
+
- The dataset comprises detailed data from **199 coin cell batteries** with either **NMC//graphite** or **LFP//graphite** chemistry. :contentReference[oaicite:14]{index=14}
|
| 9 |
+
- All battery cells were assembled and cycled using the automated robotic battery-materials research platform **Aurora** at **Empa, the Swiss Federal Laboratories for Materials Science and Technology**, within the Laboratory for Materials for Energy Conversion. :contentReference[oaicite:15]{index=15}
|
| 10 |
+
- Each battery was cycled for **1000 cycles** under fully automated and precisely controlled conditions. :contentReference[oaicite:16]{index=16}
|
| 11 |
+
- The dataset supports the peer-reviewed publication: *Toward an Autonomous Robotic Battery Materials Research Platform…* (Batteries & Supercaps, 2025). :contentReference[oaicite:17]{index=17}
|
| 12 |
|
| 13 |
+
---
|
| 14 |
|
| 15 |
+
## 📁 Data Structure
|
| 16 |
|
| 17 |
+
- The dataset is packaged as a **RO-Crate (Research Object Crate)** to facilitate standardized, machine-readable, and FAIR-compliant data sharing. :contentReference[oaicite:18]{index=18}
|
| 18 |
|
| 19 |
+
For **each battery cell**, the following files are included:
|
| 20 |
|
| 21 |
+
### 1. Battery Cell Metadata File
|
| 22 |
+
- **Filename:** `empa__ccid000XXX.metadata.json` :contentReference[oaicite:19]{index=19}
|
| 23 |
+
- **Contents:** Semantically annotated battery assembly data and the cycling protocol applied to that battery cell.
|
| 24 |
+
- **Format:** JSON-LD, using the **Battery Interface Ontology (BattINFO)** to ensure semantic interoperability and rich metadata representation. :contentReference[oaicite:20]{index=20}
|
| 25 |
|
| 26 |
+
### 2. Battery Cell Cycling Data Files
|
| 27 |
+
- **Filenames:**
|
| 28 |
+
- `empa__ccid000XXX.bdf.csv`
|
| 29 |
+
- `empa__ccid000XXX.bdf.parquet` :contentReference[oaicite:21]{index=21}
|
| 30 |
+
- **Description:** Both files contain identical cycling data.
|
| 31 |
+
- `.csv` — for easy human inspection.
|
| 32 |
+
- `.parquet` — for faster automated parsing and processing.
|
| 33 |
+
- **Format:** Conform to the **Battery Data Format (BDF)** for time-series data, as recommended by the **Battery Data Alliance**. :contentReference[oaicite:22]{index=22}
|
| 34 |
|
| 35 |
+
---
|
| 36 |
|
| 37 |
+
## 📦 Files Included in the Dataset
|
| 38 |
|
| 39 |
+
- `Dataset-rocrate.zip` — contains the full RO-Crate. :contentReference[oaicite:23]{index=23}
|
| 40 |
+
- The archive is approximately **2.5 GB** in size. :contentReference[oaicite:24]{index=24}
|
| 41 |
|
| 42 |
+
---
|
| 43 |
|
| 44 |
+
## 📌 Additional Details
|
| 45 |
|
| 46 |
+
- **License:** Creative Commons Attribution 4.0 International (CC-BY 4.0) — allows redistribution and reuse with appropriate credit. :contentReference[oaicite:25]{index=25}
|
| 47 |
+
- **Related Publication:** 10.1002/batt.202500155 (Batteries & Supercaps, 2025) — describes the robotic platform, workflow, and data management strategy. :contentReference[oaicite:26]{index=26}
|
| 48 |
+
- **Purpose / Importance:** Released by the Battery Data Alliance (BDA) in cooperation with Empa and partners to set a new standard for battery-research data: FAIR-compliant, traceable, interoperable and suitable for automated data analysis pipelines. :contentReference[oaicite:29]{index=29}
|
| 49 |
|
| 50 |
+
---
|
| 51 |
|
| 52 |
+
## 🧪 Usage Notes
|
| 53 |
|
| 54 |
+
- You can download and unpack the RO-Crate to access metadata and cycling data for all 199 batteries. :contentReference[oaicite:30]{index=30}
|
| 55 |
+
- The JSON-LD metadata facilitates semantic queries (e.g., via ontology-aware tools) to filter batteries by chemistry, assembly protocol, cycling conditions, etc.
|
| 56 |
+
- The BDF cycling data — in `.parquet` — is well suited for automated analysis workflows (e.g., in Python or Julia), enabling time-series analysis, degradation modelling, machine learning, etc.
|
| 57 |
|
| 58 |
+
---
|