docs: add initial dataset card
Browse files
README.md
ADDED
|
@@ -0,0 +1,114 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: cc-by-4.0
|
| 3 |
+
language:
|
| 4 |
+
- en
|
| 5 |
+
size_categories:
|
| 6 |
+
- 1B<n<10B
|
| 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-1-raw
|
| 23 |
+
pretty_name: "Severson 2019 LFP Fastcharge — Tier 1 Raw Mirror"
|
| 24 |
+
---
|
| 25 |
+
|
| 26 |
+
# severson-2019-raw
|
| 27 |
+
|
| 28 |
+
**Tier 1 raw mirror** of the Severson et al. 2019 LFP fastcharge cycling
|
| 29 |
+
dataset, hosted under the [BSEBench](https://bsebench.org) organization for
|
| 30 |
+
reproducibility purposes. **Files are preserved exactly as published.**
|
| 31 |
+
|
| 32 |
+
## Status
|
| 33 |
+
|
| 34 |
+
🚧 **Upload pending** — placeholder dataset card. The raw `.mat` files will
|
| 35 |
+
be uploaded once verified for SHA-256 integrity against the original
|
| 36 |
+
publication.
|
| 37 |
+
|
| 38 |
+
## What this is
|
| 39 |
+
|
| 40 |
+
A bit-exact mirror of the dataset published with :
|
| 41 |
+
|
| 42 |
+
> **Severson, K. A., Attia, P. M., Jin, N., Perkins, N., Jiang, B., Yang, Z.,
|
| 43 |
+
> Chen, M. H., Aykol, M., Herring, P. K., Fraggedakis, D., Bazant, M. Z.,
|
| 44 |
+
> Harris, S. J., Chueh, W. C., Braatz, R. D. (2019).**
|
| 45 |
+
> "Data-driven prediction of battery cycle life before capacity degradation."
|
| 46 |
+
> *Nature Energy*, 4, 383-391. doi:[10.1038/s41560-019-0356-8](https://doi.org/10.1038/s41560-019-0356-8)
|
| 47 |
+
|
| 48 |
+
124 commercial LFP/graphite cells (A123 APR18650M1A, 1.1 Ah nominal) cycled
|
| 49 |
+
under 72 fast-charging protocols at 30 °C, until 80 % capacity retention.
|
| 50 |
+
|
| 51 |
+
## Why "raw mirror" tier
|
| 52 |
+
|
| 53 |
+
BSEBench follows a **dual-tier** dataset strategy :
|
| 54 |
+
|
| 55 |
+
- **Tier 1 (this repo)** — original `.mat` files, SHA-256 verified vs the
|
| 56 |
+
original publication. Used for **provenance verification** and audits.
|
| 57 |
+
- **Tier 2** — see [`bsebench-org/severson-2019`](https://huggingface.co/datasets/bsebench-org/severson-2019)
|
| 58 |
+
for the **harmonized BSEBench-canonical Parquet** with consistent column
|
| 59 |
+
names, BPX-1.1 sign convention, and unified schema.
|
| 60 |
+
|
| 61 |
+
For most filter benchmarking work, you want **Tier 2**. Tier 1 exists to
|
| 62 |
+
let auditors verify our harmonization is faithful to the original.
|
| 63 |
+
|
| 64 |
+
## Original source
|
| 65 |
+
|
| 66 |
+
The original publication was distributed via [data.matr.io](https://data.matr.io/1/)
|
| 67 |
+
(MIT/Stanford battery archive). This URL is recorded as **citation
|
| 68 |
+
metadata** but BSEBench's HuggingFace mirror is the **single source of
|
| 69 |
+
truth** for fetching — independent of `data.matr.io`'s long-term availability.
|
| 70 |
+
|
| 71 |
+
## License
|
| 72 |
+
|
| 73 |
+
[Creative Commons Attribution 4.0 International (CC-BY-4.0)](https://creativecommons.org/licenses/by/4.0/) — same as the original publication.
|
| 74 |
+
|
| 75 |
+
## How to use
|
| 76 |
+
|
| 77 |
+
```python
|
| 78 |
+
from huggingface_hub import snapshot_download
|
| 79 |
+
|
| 80 |
+
local_dir = snapshot_download(
|
| 81 |
+
"bsebench-org/severson-2019-raw",
|
| 82 |
+
repo_type="dataset",
|
| 83 |
+
)
|
| 84 |
+
# local_dir contains the raw .mat files, SHA-256 verified
|
| 85 |
+
```
|
| 86 |
+
|
| 87 |
+
For the BSEBench-harmonized version with a consistent Python API, prefer
|
| 88 |
+
[`bsebench-org/severson-2019`](https://huggingface.co/datasets/bsebench-org/severson-2019).
|
| 89 |
+
|
| 90 |
+
## Citation
|
| 91 |
+
|
| 92 |
+
Cite the **original** Severson 2019 paper (BibTeX above) — not BSEBench's
|
| 93 |
+
mirror. BSEBench's contribution is hosting + harmonization, not the data.
|
| 94 |
+
|
| 95 |
+
If you also use BSEBench tooling, additionally cite :
|
| 96 |
+
|
| 97 |
+
```bibtex
|
| 98 |
+
@misc{bsebench2026,
|
| 99 |
+
author = {Akir, Oussama and BSEBench Contributors},
|
| 100 |
+
title = {{BSEBench}: an open-source benchmark for battery state-estimation filters},
|
| 101 |
+
year = {2026},
|
| 102 |
+
url = {https://bsebench.org},
|
| 103 |
+
}
|
| 104 |
+
```
|
| 105 |
+
|
| 106 |
+
## Provenance manifest
|
| 107 |
+
|
| 108 |
+
A machine-readable manifest validating this dataset's metadata against the
|
| 109 |
+
[`bsebench-dataset-manifest/v1`](https://github.com/bsebench-org/bsebench-specs)
|
| 110 |
+
schema lives at
|
| 111 |
+
[`bsebench-org/bsebench-datasets/manifests/severson_2019_lfp.yaml`](https://github.com/bsebench-org/bsebench-datasets/tree/main/manifests).
|
| 112 |
+
|
| 113 |
+
Including : `source.canonical_url`, `source.canonical_doi`, every file's
|
| 114 |
+
SHA-256 + size, license, and citation BibTeX.
|