Create README.md

README.md

@@ -0,0 +1,16 @@
+# Njord sample data
+
+This repo contains a 1 degree global ocean sample dataset. Example graph creation and training commands are included in `commands.sh`. The MDP (mllam-data-prep) config files are used to produce training ready Zarrs included here. The main config file used during training by Njord is `global_ocean_1.yaml` with variable weighting, clamping, and data store references.
+
+```
+sample_data/
+├── commands.sh
+├── global_era5_1_mdp_config.yaml
+├── global_era5_1_mdp_config.zarr
+├── global_ocean_1_mdp_config.yaml
+├── global_ocean_1_mdp_config.zarr
+├── global_ocean_1.yaml
+└── graphs/
+    ├── global_cluster_graph/
+    └── global_hierarchical_graph/
+```