Add README.md

README.md

@@ -1,44 +1,163 @@
 ---
+annotations_creators:
+- no-annotation
+language_creators:
+- found
+language:
+- en
+license: cc-by-4.0
+multilinguality:
+- monolingual
+size_categories:
+- 1K<n<10K
+source_datasets:
+- original
+task_categories:
+- other
+task_ids: []
+tags:
+- africa
+- humanitarian
+- hdx
+- electric-sheep-africa
+- cyclones-hurricanes-typhoons
+- hxl
+- eri
+pretty_name: "Eritrea: IBTrACS Storm Tracks"
 dataset_info:
-  features:
-  - name: sid
-    dtype: string
-  - name: number
-    dtype: float64
-  - name: basin
-    dtype: string
-  - name: subbasin
-    dtype: string
-  - name: iso_time
-    dtype: timestamp[ns]
-  - name: nature
-    dtype: string
-  - name: lat
-    dtype: float64
-  - name: lon
-    dtype: float64
-  - name: wmo_wind
-    dtype: string
-  - name: wmo_pres
-    dtype: string
-  - name: esa_source
-    dtype: string
-  - name: esa_processed
-    dtype: string
   splits:
-  - name: train
-    num_bytes: 733072
-    num_examples: 5922
-  - name: test
-    num_bytes: 184035
-    num_examples: 1481
-  download_size: 169081
-  dataset_size: 917107
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
-  - split: test
-    path: data/test-*
+    - name: train
+      num_examples: 5922
+    - name: test
+      num_examples: 1480
 ---
+
+# Eritrea: IBTrACS Storm Tracks
+
+**Publisher:** HDX · **Source:** [HDX](https://data.humdata.org/dataset/eri-ibtracs-tropical-storm-tracks) · **License:** `cc-by-igo` · **Updated:** 2025-10-14
+
+---
+
+## Abstract
+
+The International Best Track Archive for Climate Stewardship (IBTrACS) project is the most complete global collection of tropical cyclones available. It merges recent and historical tropical cyclone data from multiple agencies to create a unified, publicly available, best-track dataset that improves inter-agency comparisons.   
+   
+ Fields available:   
+ SID: A unique storm identifier (SID) assigned by IBTrACS algorithm.  
+ ISO_TIME: Time of the observation in ISO format (YYYY-MM-DD hh:mm:ss)   
+ BASIN: Basin of the current storm position   
+ SUBBASIN: Sub-basin of the current storm position   
+ NATURE: Type of storm (a combination of the various types from the available sources)   
+ NUMBER: Number of the storm for the year (restarts at 1 for each year   
+ LAT: Mean position - latitude (a combination of the available positions)   
+ LON: Mean position - longitude (a combination of the available positions)   
+ WMO_WIND: Maximum sustained wind speed assigned by the responsible WMO agency   
+ WMO_PRES: Minimum central pressure assigned by the responsible WMO agency.
+
+Each row in this dataset represents geolocated point observations. Temporal coverage is indicated by the `iso_time` column(s). Geographic scope: **ERI**.
+
+*Curated into ML-ready Parquet format by [Electric Sheep Africa](https://huggingface.co/electricsheepafrica).*
+
+---
+
+## Dataset Characteristics
+
+| | |
+|---|---|
+| **Domain** | Climate and environment |
+| **Unit of observation** | Geolocated point observations |
+| **Rows (total)** | 7,403 |
+| **Columns** | 12 (3 numeric, 8 categorical, 1 datetime) |
+| **Train split** | 5,922 rows |
+| **Test split** | 1,480 rows |
+| **Geographic scope** | ERI |
+| **Publisher** | HDX |
+| **HDX last updated** | 2025-10-14 |
+
+---
+
+## Variables
+
+**Geographic** — `iso_time`, `lat` (range -11.7–31.9), `lon` (range 41.3–141.0).
+
+**Outcome / Measurement** — `number` (range 1.0–142.0).
+
+**Identifier / Metadata** — `sid` (2013305N07141, 1996288N09092, 1886306N10092), `esa_source` (HDX), `esa_processed` (2026-04-06).
+
+**Other** — `basin` (North India, South Indian, Western North Pacific), `subbasin` (Arabian Sea, Bay of Bengal, Missing), `nature` (Tropical, Not reported, Disturbance), `wmo_wind` ( , 25, 30), `wmo_pres` ( , 1000, 1002).
+
+---
+
+## Quick Start
+
+```python
+from datasets import load_dataset
+
+ds    = load_dataset("electricsheepafrica/africa-eri-ibtracs-tropical-storm-tracks")
+train = ds["train"].to_pandas()
+test  = ds["test"].to_pandas()
+
+print(train.shape)
+train.head()
+```
+
+---
+
+## Schema
+
+| Column | Type | Null % | Range / Sample Values |
+|---|---|---|---|
+| `sid` | object | 0.0% | 2013305N07141, 1996288N09092, 1886306N10092 |
+| `number` | float64 | 0.0% | 1.0 – 142.0 (mean 66.4258) |
+| `basin` | object | 0.0% | North India, South Indian, Western North Pacific |
+| `subbasin` | object | 0.0% | Arabian Sea, Bay of Bengal, Missing |
+| `iso_time` | datetime64[ns] | 0.0% |  |
+| `nature` | object | 0.0% | Tropical, Not reported, Disturbance |
+| `lat` | float64 | 0.0% | -11.7 – 31.9 (mean 13.9236) |
+| `lon` | float64 | 0.0% | 41.3 – 141.0 (mean 65.8907) |
+| `wmo_wind` | object | 0.0% |  , 25, 30 |
+| `wmo_pres` | object | 0.0% |  , 1000, 1002 |
+| `esa_source` | object | 0.0% | HDX |
+| `esa_processed` | object | 0.0% | 2026-04-06 |
+
+---
+
+## Numeric Summary
+
+| Column | Min | Max | Mean | Median |
+|---|---|---|---|---|
+| `number` | 1.0 | 142.0 | 66.4258 | 75.0 |
+| `lat` | -11.7 | 31.9 | 13.9236 | 13.5 |
+| `lon` | 41.3 | 141.0 | 65.8907 | 64.6 |
+
+---
+
+## Curation
+
+Raw data was downloaded from HDX via the CKAN API and converted to Parquet. Column names were lowercased and standardised to snake_case. Common missing-value markers (`N/A`, `null`, `none`, `-`, `unknown`, `no data`, `#N/A`) were unified to `NaN`. 4 column(s) were cast from string to numeric or datetime based on parse-success rate (>85% threshold). The dataset was split 80/20 into train and test partitions using a fixed random seed (42) and saved as Snappy-compressed Parquet.
+
+---
+
+## Limitations
+
+- Data originates from HDX and has not been independently validated by ESA.
+- Automated cleaning cannot correct for misreported values, definitional inconsistencies, or sampling bias in the original collection.
+- Refer to the [original HDX dataset page](https://data.humdata.org/dataset/eri-ibtracs-tropical-storm-tracks) for the publisher's own methodology notes and caveats.
+
+---
+
+## Citation
+
+```bibtex
+@dataset{hdx_africa_eri_ibtracs_tropical_storm_tracks,
+  title     = {Eritrea: IBTrACS Storm Tracks},
+  author    = {HDX},
+  year      = {2025},
+  url       = {https://data.humdata.org/dataset/eri-ibtracs-tropical-storm-tracks},
+  note      = {Repackaged for machine learning by Electric Sheep Africa (https://huggingface.co/electricsheepafrica)}
+}
+```
+
+---
+
+*[Electric Sheep Africa](https://huggingface.co/electricsheepafrica) — Africa's ML dataset infrastructure. Lagos, Nigeria.*