Upload README.md with huggingface_hub

README.md

@@ -1,3 +1,103 @@
----
-license: mit
----
+---
+license: mit
+pretty_name: Blocking Composite Viewer Data
+tags:
+  - atmospheric-science
+  - potential-vorticity
+  - blocking
+  - era5
+  - plotly
+---
+
+# Blocking Composite Viewer Data
+
+This Hugging Face dataset stores compressed JSON payloads for the interactive
+Blocking Composite Viewer at https://yanxingjianken.github.io/blocking-plots/.
+The viewer reads these files directly from the dataset repository and renders
+ERA5 blocking and propagating-anticyclone composites with Plotly.
+
+## Contents
+
+- `blocking/*.json.gz`: blocking-anticyclone composites and RWB subcluster composites.
+- `prp/*.json.gz`: propagating-anticyclone composites and RWB subcluster composites.
+- `blocking/_catalog.json` and `prp/_catalog.json`: variant/stage catalogs used by the viewer dropdowns.
+- `README.md`: this dataset card.
+
+The old root-level JSON exports and the stale `figures/` directory are cleaned
+during the current upload workflow. Publication figures are maintained in the
+`pvtend` source repository instead of this dataset repository.
+
+## Workflow
+
+```mermaid
+graph TD
+    A[ERA5 event NPZ patches] --> B[outputs/blowup_scan/exclude_tracks_blocking.csv]
+    A --> C[outputs/blowup_scan/exclude_tracks_prp.csv]
+    A --> D[pvtend-pipeline classify]
+    B --> D
+    C --> D
+    D --> E[rwb_variant_tracksets_wavg.pkl]
+    A --> F[website/build_and_export_clusters.py]
+    B --> F
+    C --> F
+    E --> F
+    F --> G[website/blocking_export/*.json.gz]
+    F --> H[website/prp_export/*.json.gz]
+    G --> I[website/upload_to_hf.py]
+    H --> I
+    I --> J[yanxingjianken/blocking-composites]
+    J --> K[GitHub Pages blocking-plots viewer]
+```
+
+## Blowup Track Exclusion
+
+The web export applies the latest blowup-screen CSVs by default:
+
+- `outputs/blowup_scan/exclude_tracks_blocking.csv`
+- `outputs/blowup_scan/exclude_tracks_prp.csv`
+
+Those CSVs are generated from per-event NPZ diagnostics by scanning the
+QG-omega-related vertical-motion fields and excluding tracks whose any-stage
+maximum absolute value exceeds 25 Pa s^-1. Applying the same CSVs during web
+export keeps the viewer's `All Events` count consistent with the screened
+production composites and avoids displaying blowup-contaminated composites.
+The cluster builder also prefers `rwb_variant_tracksets_wavg.pkl` by default,
+matching the weighted-average RWB classifications used in the production viewer.
+
+## Regeneration Commands
+
+Run from the `pvtend` repository on the HPC system with the `blocking` micromamba
+environment:
+
+```bash
+cd /net/flood/data2/users/x_yan/pvtend
+micromamba run -n blocking python website/build_and_export_clusters.py --event-type blocking
+micromamba run -n blocking python website/build_and_export_clusters.py --event-type prp
+micromamba run -n blocking python website/upload_to_hf.py --clean-figures
+```
+
+If clustering has already completed and `rwb_cluster_variant_tracksets.pkl` is
+present, resume from the composite-building/export step with parallel workers:
+
+```bash
+micromamba run -n blocking python website/build_and_export_clusters.py --event-type blocking --resume-from-step5 --n-workers 16
+micromamba run -n blocking python website/build_and_export_clusters.py --event-type prp --resume-from-step5 --n-workers 16
+```
+
+To override the automatic exclude CSV lookup, pass `--exclude-file` to
+`website/build_and_export_clusters.py`.
+
+## Viewer Contract
+
+Each `{variant}_{stage}.json.gz` file contains:
+
+- `meta.n_events`: event counts at `dh=-12`, `dh=0`, and `dh=+12`.
+- `coords`: relative longitude/latitude grids.
+- `dh_m12`, `dh_0`, `dh_p12`: level-wise composite fields and orthogonal basis payloads.
+- `meta.field_labels` and `meta.field_groups`: dropdown labels used by the viewer.
+
+The GitHub Pages frontend fetches files from:
+
+```text
+https://huggingface.co/datasets/yanxingjianken/blocking-composites/resolve/main/{blocking,prp}/
+```