Datasets:
docs: regen card with normal hyphens
Browse files
README.md
CHANGED
|
@@ -37,7 +37,7 @@ canonical schema across four entities: `cell_metadata` + `test_metadata`
|
|
| 37 |
(JSON), `timeseries` + `cycle_summary` (Parquet). Consumers read one format
|
| 38 |
instead of writing per-source loaders.
|
| 39 |
|
| 40 |
-
**Scope: harmonization only.** celljar focuses on measurements
|
| 41 |
conversion and schema normalization. It deliberately leaves fitting and
|
| 42 |
modeling to downstream tools that specialize in those steps.
|
| 43 |
|
|
@@ -58,10 +58,10 @@ cycle_summary.parquet # per-cycle aggregates (aging studies); join on (test_
|
|
| 58 |
|
| 59 |
Four entities; field list generated from the authoritative [JSON Schemas](https://github.com/mihnathul/celljar/tree/main/schemas):
|
| 60 |
|
| 61 |
-
- **`cell_metadata`** (JSON, one file per cell)
|
| 62 |
-
- **`test_metadata`** (JSON, one file per test)
|
| 63 |
-
- **`timeseries`** (Parquet, one row per measurement sample)
|
| 64 |
-
- **`cycle_summary`** (Parquet, one row per cycle / aging checkpoint)
|
| 65 |
|
| 66 |
`*` = required field (others nullable). See [JSON Schemas](https://github.com/mihnathul/celljar/tree/main/schemas) for full type info, enum values, and constraints.
|
| 67 |
|
|
@@ -75,7 +75,7 @@ Join keys: `cells.cell_id = tests.cell_id`, `tests.test_id = timeseries.test_id`
|
|
| 75 |
## Download the whole bundle
|
| 76 |
|
| 77 |
```bash
|
| 78 |
-
# CLI
|
| 79 |
pip install huggingface_hub
|
| 80 |
huggingface-cli download mihnathul/celljar --repo-type dataset --local-dir ./celljar-bundle
|
| 81 |
|
|
@@ -91,9 +91,9 @@ local = snapshot_download(repo_id="mihnathul/celljar", repo_type="dataset", revi
|
|
| 91 |
print(local) # local path containing cells/, tests/, timeseries.parquet, cycle_summary.parquet
|
| 92 |
```
|
| 93 |
|
| 94 |
-
## Query in place
|
| 95 |
|
| 96 |
-
### DuckDB
|
| 97 |
|
| 98 |
```sql
|
| 99 |
INSTALL httpfs; LOAD httpfs;
|
|
@@ -109,7 +109,7 @@ GROUP BY 1,2,3,4,5
|
|
| 109 |
ORDER BY t.test_id;
|
| 110 |
```
|
| 111 |
|
| 112 |
-
### pandas / Polars
|
| 113 |
|
| 114 |
```python
|
| 115 |
import pandas as pd
|
|
@@ -119,7 +119,7 @@ df = pd.read_parquet(
|
|
| 119 |
)
|
| 120 |
```
|
| 121 |
|
| 122 |
-
### `datasets` library
|
| 123 |
|
| 124 |
```python
|
| 125 |
from datasets import load_dataset
|
|
@@ -141,7 +141,7 @@ the data, and, if it's helpful, celljar alongside.
|
|
| 141 |
|
| 142 |
- **This harmonized bundle** (packaging, schema, derived test-metadata fields):
|
| 143 |
[CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/).
|
| 144 |
-
- **Upstream raw data** retains each publisher's original license
|
| 145 |
per-source below. Each source's license terms apply when you use its tests.
|
| 146 |
|
| 147 |
To make attribution easy, every `tests/*.json` row carries its own
|
|
|
|
| 37 |
(JSON), `timeseries` + `cycle_summary` (Parquet). Consumers read one format
|
| 38 |
instead of writing per-source loaders.
|
| 39 |
|
| 40 |
+
**Scope: harmonization only.** celljar focuses on measurements - unit
|
| 41 |
conversion and schema normalization. It deliberately leaves fitting and
|
| 42 |
modeling to downstream tools that specialize in those steps.
|
| 43 |
|
|
|
|
| 58 |
|
| 59 |
Four entities; field list generated from the authoritative [JSON Schemas](https://github.com/mihnathul/celljar/tree/main/schemas):
|
| 60 |
|
| 61 |
+
- **`cell_metadata`** (JSON, one file per cell) - `cell_id`*, `source`*, `source_cell_id`, `manufacturer`, `model_number`, `chemistry`*, `cathode`, `anode`, `electrolyte`, `form_factor`*, `nominal_capacity_Ah`, `nominal_voltage_V`, `max_voltage_V`, `min_voltage_V`
|
| 62 |
+
- **`test_metadata`** (JSON, one file per test) - `test_id`*, `cell_id`*, `test_type`*, `temperature_C_min`, `temperature_C_max`, `soc_range_min`, `soc_range_max`, `soc_step`, `c_rate_charge`, `c_rate_discharge`, `protocol_description`, `num_cycles`, `soh_pct`, `soh_method`, `cycle_count_at_test`, `test_year`, `source_doi`, `source_url`, `source_citation`, `source_license`, `source_license_url`, `n_samples`, `duration_s`, `voltage_observed_min_V`, `voltage_observed_max_V`, `current_observed_min_A`, `current_observed_max_A`, `temperature_observed_min_C`, `temperature_observed_max_C`, `sample_dt_min_s`, `sample_dt_median_s`, `sample_dt_max_s`
|
| 63 |
+
- **`timeseries`** (Parquet, one row per measurement sample) - `test_id`*, `cycle_number`*, `step_number`, `step_type`, `timestamp_s`*, `voltage_V`, `current_A`, `temperature_C`, `coulomb_count_Ah`, `energy_Wh`, `displacement_um`
|
| 64 |
+
- **`cycle_summary`** (Parquet, one row per cycle / aging checkpoint) - `test_id`*, `cell_id`*, `cycle_number`, `equivalent_full_cycles`, `elapsed_time_s`, `capacity_Ah`, `capacity_retention_pct`, `resistance_dc_ohm`, `resistance_dc_pulse_duration_s`, `resistance_dc_soc_pct`, `energy_Wh`, `coulombic_efficiency`, `temperature_C_mean`
|
| 65 |
|
| 66 |
`*` = required field (others nullable). See [JSON Schemas](https://github.com/mihnathul/celljar/tree/main/schemas) for full type info, enum values, and constraints.
|
| 67 |
|
|
|
|
| 75 |
## Download the whole bundle
|
| 76 |
|
| 77 |
```bash
|
| 78 |
+
# CLI - pulls everything (cells/*.json, tests/*.json, timeseries.parquet, cycle_summary.parquet)
|
| 79 |
pip install huggingface_hub
|
| 80 |
huggingface-cli download mihnathul/celljar --repo-type dataset --local-dir ./celljar-bundle
|
| 81 |
|
|
|
|
| 91 |
print(local) # local path containing cells/, tests/, timeseries.parquet, cycle_summary.parquet
|
| 92 |
```
|
| 93 |
|
| 94 |
+
## Query in place - no download needed
|
| 95 |
|
| 96 |
+
### DuckDB - full SQL across all entities over HTTPS
|
| 97 |
|
| 98 |
```sql
|
| 99 |
INSTALL httpfs; LOAD httpfs;
|
|
|
|
| 109 |
ORDER BY t.test_id;
|
| 110 |
```
|
| 111 |
|
| 112 |
+
### pandas / Polars - predicate-pushdown read of one test
|
| 113 |
|
| 114 |
```python
|
| 115 |
import pandas as pd
|
|
|
|
| 119 |
)
|
| 120 |
```
|
| 121 |
|
| 122 |
+
### `datasets` library - streaming
|
| 123 |
|
| 124 |
```python
|
| 125 |
from datasets import load_dataset
|
|
|
|
| 141 |
|
| 142 |
- **This harmonized bundle** (packaging, schema, derived test-metadata fields):
|
| 143 |
[CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/).
|
| 144 |
+
- **Upstream raw data** retains each publisher's original license - listed
|
| 145 |
per-source below. Each source's license terms apply when you use its tests.
|
| 146 |
|
| 147 |
To make attribution easy, every `tests/*.json` row carries its own
|