Add figures to the card

README.md

@@ -25,6 +25,14 @@ with sequencing-like errors already applied, and each comes with its true size h
 files the network was trained on are included, as are the code and configuration that made the
 windows.
 
+![What the corpus covers](https://huggingface.co/datasets/Larrivhan/NeCast-simulations/resolve/main/figures/simulations_overview.png)
+
+**What the corpus covers.** **a**, Eight training windows drawn at random from each of the
+twelve families of size history, with the number of windows in each family. Each line is a
+window's 64 interval labels, drawn through the interval centres. **b**, Windows by the type of
+map stored with them. Every window carries sequencing-like errors except those with constant maps
+at the baseline rates. **c**, Variant sites per window, false sites included.
+
 ## Contents
 
 | path | what it holds | size |
@@ -39,6 +47,7 @@ windows.
 | `generator/` | the simulator code, the generation plan and the map scripts | small |
 | `tools/necast_windows.py` | a reader that needs only numpy | small |
 | `logs/` | build logs of the feature files | small |
+| `figures/` | the figures on this card | small |
 | `SHA256SUMS` | a checksum for every file except this card | small |
 
 The windows are grouped by generation chunk: `windows/NNN/` holds chunks `NNN000` to `NNN999`.
@@ -51,12 +60,14 @@ numbers have gaps. The index lists every window that exists.
 - **Sequence and sample.** 30 Mb, 64 diploid individuals (128 haplotypes). msprime 1.4.2 with
   the default coalescent with recombination (the full ancestral recombination graph), a binary
   mutation model, the window's true recombination and mutation maps, and no gene conversion.
-- **Size histories.** Twelve samplers (`generator_recipe`): constant, spectral random walk, size
-  event, multiple events, events on a varying background, bottleneck, exponential change,
-  sawtooth, sawtooth shapes from the literature, out-of-Africa chains, perturbed published human
-  histories (191 curves inferred by SMC++, phlash, MSMC2 and MSMC-IM), and the 18
-  single-population models of the stdpopsim catalogue. Sizes stay between 100 and 1,000,000.
-  The realised parameters of every history are in the metadata.
+- **Size histories.** Twelve families, named in `generator_recipe`: constant (`constant`),
+  exponential (`exponential`), one size change (`size_event`), several changes (`multi_event`),
+  bottleneck (`bottleneck`), event on a trend (`event_on_background`), random walk
+  (`spectral_walk`), sawtooth (`sawtooth`), zigzag-like (`literature_sawtooth`), founder chain
+  (`ooa_chain`), perturbed published human histories (`empirical_human_ne_template`; 191 curves
+  inferred by SMC++, phlash, MSMC2 and MSMC-IM), and the 18 single-population models of the
+  stdpopsim catalogue (`stdpopsim_single_pop`). Sizes stay between 100 and 1,000,000. The
+  realised parameters of every history are in the metadata.
 - **Maps** (`map_type`). A constant map at the baseline rates (`constant_clean`), constant
   rates drawn at random (`constant_random_global`), synthetic heterogeneous maps
   (`synthetic_heterogeneous`), or 30 Mb slices of the deCODE 2019 recombination map and the
@@ -93,6 +104,15 @@ feature file. Now that they are public, they no longer serve as an untouched tes
 
 ## Reading a window
 
+![One window](https://huggingface.co/datasets/Larrivhan/NeCast-simulations/resolve/main/figures/simulations_window.png)
+
+**One window, `sim_00000016`**: a perturbed published human history, slices of the deCODE and
+Roulette maps, and errors. **a**, Diploid genotypes of the 64 individuals at the 133 variant
+sites between 15.00 and 15.10 Mb: 0 pale, 1 light blue, 2 dark blue, missing calls orange.
+**b**, The recombination and mutation maps stored with the window, averaged in 300-kb bins.
+**c**, The simulated history (grey) and its 64 interval labels (black), which are the
+network's targets.
+
 ```python
 from huggingface_hub import hf_hub_download
 import sys

SHA256SUMS

@@ -2286,6 +2286,8 @@ babceb4ad3415ac8c1a5a6f3982aefd73d5f0a24146ae1e49ffc9f491f44fa86  features/regis
 b91dbfe2329d5357608e897338abb91e030df4f635dd79205afd68aad7029606  features/registry/sample_identities.jsonl
 443502d65cb009a6a910c8604abc8a094fdaa4b8a4635fc476313068c66e9bb5  features/registry/selected_indices.npy
 413a4f564393b8934f4a803b34740de95e00348a64e6f1fefd464639b3bb2edc  features/registry/snapshot.json
+edf3fa2df0c9637e371145b1a261682bfc7ef1ddd3def5322a8286660ae50aad  figures/simulations_overview.png
+3c0220b60a34b326ba5e9d64214b94baad369a79feed588fbcf1fb4d15ebf98b  figures/simulations_window.png
 3fa748dbdc9de3f689191648b652295a368071216f6f6adced845b231c9d616d  generator/EXCLUDED_THIRD_PARTY.tsv
 233bb6604c98d42750149c4cd441bb52b9405cf4365bf46dcb2e4451c9507c32  generator/code/.gitignore
 1e7a283f0a0d7492069063129a330e878c5f672cb7213731458954182f3b217d  generator/code/LICENSE