Update README.md

README.md

@@ -1,3 +1,34 @@
----
-license: mit
----
+# SIMSHIFT — Inspection Samples
+
+This repository hosts a single representative simulation per task from
+the four SIMSHIFT datasets, for reviewer inspection only. The full
+datasets are hosted separately at
+[simshift/SIMSHIFT_data](https://huggingface.co/datasets/simshift/SIMSHIFT_data).
+
+These files are **not** intended for benchmarking, training, or any
+quantitative evaluation. They exist solely to let reviewers verify file
+format, schema, mesh structure, and output fields without downloading
+the full datasets (the heatsink set in particular is ~520 GB).
+
+## Contents
+
+One sample file per task, in the same HDF5 format and schema as the
+full datasets:
+
+| File                | Task                  |
+|---------------------|-----------------------|
+| `rolling_sample.h5` | Hot Rolling           |
+| `forming_sample.h5` | Sheet Metal Forming   |
+| `motor_sample.h5`   | Electric Motor Design |
+| `heatsink_sample.h5`| Heatsink Design       |
+
+## How the samples were generated
+
+Each file contains a single simulation drawn from the corresponding
+full dataset.The simulation is stored exactly as
+it appears in the full release, using the same HDF5 structure, field
+names, and units.
+
+## License
+
+MIT, identical to the main SIMSHIFT release.