Datasets:
docs: add initial dataset card
Browse files
README.md
ADDED
|
@@ -0,0 +1,125 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: cc-by-4.0
|
| 3 |
+
language:
|
| 4 |
+
- en
|
| 5 |
+
size_categories:
|
| 6 |
+
- 100M<n<1B
|
| 7 |
+
task_categories:
|
| 8 |
+
- time-series-forecasting
|
| 9 |
+
- tabular-regression
|
| 10 |
+
tags:
|
| 11 |
+
- battery
|
| 12 |
+
- state-of-charge
|
| 13 |
+
- state-of-health
|
| 14 |
+
- lithium-ion
|
| 15 |
+
- LFP
|
| 16 |
+
- lithium-iron-phosphate
|
| 17 |
+
- fast-charging
|
| 18 |
+
- cycling
|
| 19 |
+
- kalman-filter
|
| 20 |
+
- benchmark
|
| 21 |
+
- bsebench
|
| 22 |
+
- tier-2-canonical
|
| 23 |
+
- parquet
|
| 24 |
+
- bpx-1.1
|
| 25 |
+
pretty_name: "Severson 2019 LFP Fastcharge — BSEBench Canonical (Tier 2)"
|
| 26 |
+
---
|
| 27 |
+
|
| 28 |
+
# severson-2019
|
| 29 |
+
|
| 30 |
+
**Tier 2 BSEBench-canonical** Parquet harmonization of the Severson et al.
|
| 31 |
+
2019 LFP fastcharge cycling dataset. Hosted under the [BSEBench](https://bsebench.org)
|
| 32 |
+
organization for filter benchmark reproducibility.
|
| 33 |
+
|
| 34 |
+
## Status
|
| 35 |
+
|
| 36 |
+
🚧 **Harmonization pending** — placeholder dataset card. Awaiting :
|
| 37 |
+
|
| 38 |
+
1. Tier 1 raw mirror upload at [`bsebench-org/severson-2019-raw`](https://huggingface.co/datasets/bsebench-org/severson-2019-raw)
|
| 39 |
+
2. Publication of `bsebench-specs` v0.2.0 with the canonical
|
| 40 |
+
`TimeSeriesSchema` Pydantic model
|
| 41 |
+
3. Implementation + testing of the Severson harmonization adapter at
|
| 42 |
+
[`bsebench-datasets/src/bsebench_datasets/adapters/severson_2019.py`](https://github.com/bsebench-org/bsebench-datasets/blob/main/src/bsebench_datasets/adapters/severson_2019.py)
|
| 43 |
+
|
| 44 |
+
## What this will be
|
| 45 |
+
|
| 46 |
+
The Severson 2019 dataset converted to the **BSEBench canonical Parquet schema** :
|
| 47 |
+
|
| 48 |
+
| Column | Type | Description |
|
| 49 |
+
|---|---|---|
|
| 50 |
+
| `cell_id` | string | identifier within the dataset |
|
| 51 |
+
| `time_s` | float64 | seconds since experiment start (`t=0` at first sample) |
|
| 52 |
+
| `voltage_V` | float64 | terminal voltage, always positive |
|
| 53 |
+
| `current_A` | float64 | BPX-1.1 sign convention : charge=positive, discharge=negative |
|
| 54 |
+
| `temperature_C` | float64 | cell surface temperature |
|
| 55 |
+
| `cycle_number` | int32 | cycle counter, 1-indexed |
|
| 56 |
+
| `step_id` | string | within-cycle step identifier |
|
| 57 |
+
| `capacity_Ah` | float64? | running cumulative capacity |
|
| 58 |
+
|
| 59 |
+
Partitioned by `cell_id` for parallel reading. Total expected size ≈ 50 GB
|
| 60 |
+
uncompressed, ≈ 8 GB after Zstandard compression.
|
| 61 |
+
|
| 62 |
+
## Why "canonical" tier
|
| 63 |
+
|
| 64 |
+
This is the version **users should consume** for filter benchmarking. It :
|
| 65 |
+
|
| 66 |
+
- Maps Severson's original column names to BSEBench's standardized schema
|
| 67 |
+
- Harmonizes sign conventions to BPX-1.1
|
| 68 |
+
- Strips metadata not needed for state-estimation
|
| 69 |
+
- Loads in 1 line via `bsebench-datasets`
|
| 70 |
+
|
| 71 |
+
For provenance / audit, see the [Tier 1 raw mirror](https://huggingface.co/datasets/bsebench-org/severson-2019-raw).
|
| 72 |
+
|
| 73 |
+
## Anchor standards
|
| 74 |
+
|
| 75 |
+
- Sign convention : [BPX 1.1](https://bpxstandard.com/) (discharge = negative)
|
| 76 |
+
- Time-series schema : [LF Energy BDF](https://lfenergy.org/lf-energy-battery-data-alliance-announces-the-battery-data-format-bdf/)
|
| 77 |
+
(Dec 2025) where applicable
|
| 78 |
+
|
| 79 |
+
## License
|
| 80 |
+
|
| 81 |
+
[CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/) — same as the
|
| 82 |
+
original Severson 2019 publication.
|
| 83 |
+
|
| 84 |
+
## How to use (target API)
|
| 85 |
+
|
| 86 |
+
```python
|
| 87 |
+
# Once shipped (M2.1)
|
| 88 |
+
from bsebench_datasets import load_bsebench
|
| 89 |
+
|
| 90 |
+
ds = load_bsebench("severson-2019", revision="v1.0")
|
| 91 |
+
print(ds.chemistry) # "LFP"
|
| 92 |
+
print(ds.first_cell_data().head()) # canonical Parquet columns
|
| 93 |
+
```
|
| 94 |
+
|
| 95 |
+
## Citation
|
| 96 |
+
|
| 97 |
+
```bibtex
|
| 98 |
+
@article{severson2019,
|
| 99 |
+
author = {Severson, K. A. and Attia, P. M. and Jin, N. and Perkins, N.
|
| 100 |
+
and Jiang, B. and Yang, Z. and Chen, M. H. and Aykol, M.
|
| 101 |
+
and Herring, P. K. and Fraggedakis, D. and Bazant, M. Z.
|
| 102 |
+
and Harris, S. J. and Chueh, W. C. and Braatz, R. D.},
|
| 103 |
+
title = {Data-driven prediction of battery cycle life before
|
| 104 |
+
capacity degradation},
|
| 105 |
+
journal = {Nature Energy},
|
| 106 |
+
volume = {4},
|
| 107 |
+
pages = {383--391},
|
| 108 |
+
year = {2019},
|
| 109 |
+
doi = {10.1038/s41560-019-0356-8},
|
| 110 |
+
}
|
| 111 |
+
|
| 112 |
+
@misc{bsebench2026,
|
| 113 |
+
author = {Akir, Oussama and BSEBench Contributors},
|
| 114 |
+
title = {{BSEBench}: an open-source benchmark for battery state-estimation filters},
|
| 115 |
+
year = {2026},
|
| 116 |
+
url = {https://bsebench.org},
|
| 117 |
+
}
|
| 118 |
+
```
|
| 119 |
+
|
| 120 |
+
## Provenance
|
| 121 |
+
|
| 122 |
+
Derived from [`bsebench-org/severson-2019-raw`](https://huggingface.co/datasets/bsebench-org/severson-2019-raw)
|
| 123 |
+
via [`bsebench-datasets/src/bsebench_datasets/adapters/severson_2019.py`](https://github.com/bsebench-org/bsebench-datasets/blob/main/src/bsebench_datasets/adapters/severson_2019.py).
|
| 124 |
+
The harmonization script's commit SHA is recorded in the manifest YAML at
|
| 125 |
+
[`bsebench-datasets/manifests/severson_2019_lfp.yaml`](https://github.com/bsebench-org/bsebench-datasets/tree/main/manifests).
|