Update instructions

Author: andersy005

README.md

@@ -8,6 +8,22 @@
 
 Data repository for Project Pythia examples/notebooks
 
+## Sample data sets
+
+These files are used as sample data in Pythia Project examples/notebooks and are downloaded by `pythia_datasets` package:
+
+- `NARR_19930313_0000.nc`
+- `enso_data.csv`
+- `jan-17-co-asos.txt.xz`
+
+### Adding new datasets
+
+To add a new dataset file, please follow these steps:
+
+1. Add the dataset file to the `data/` directory
+2. From the command line, run `python make_registry.py` script to update the registry file residing in `pythia_datasets/registry.txt`
+3. Commit and push your changes to GitHub
+
 [github-ci-badge]: https://img.shields.io/github/workflow/status/ProjectPythia/pythia-datasets/CI?label=CI&logo=github&style=for-the-badge
 [github-lint-badge]: https://img.shields.io/github/workflow/status/ProjectPythia/pythia-datasets/linting?label=linting&logo=github&style=for-the-badge
 [github-ci-link]: https://github.com/ProjectPythia/pythia-datasets/actions?query=workflow%3ACI

data/README.md

@@ -0,0 +1,10 @@
+import os
+import pathlib
+
+import pooch
+
+if __name__ == '__main__':
+    here = pathlib.Path(os.path.dirname(__file__))
+    data_dir = here / 'data'
+
+    pooch.make_registry(data_dir, here / 'pythia_datasets/registry.txt')

data/make_registry.py

@@ -1,3 +1,3 @@
-jan-17-co-asos.txt.xz c3b55b9ed67b3a3fa92636b139778e36240a09f8b6fc4d72526381b7673cc710
 NARR_19930313_0000.nc 65a23aba0e32dc3dfa56e58fab68ad9028646e57547b246a42a8c16ed9152df4
 enso_data.csv d81cafe5ad5cf3ee4b69c94f3401230badeb6429b85f916d62df6d74b553c371
+jan-17-co-asos.txt.xz c3b55b9ed67b3a3fa92636b139778e36240a09f8b6fc4d72526381b7673cc710