update and add README files

FINO1/README.md

@@ -0,0 +1,6 @@
+File descriptions:
+
+* `dat2nc.py`: script to transform FINO 1 `.dat` files to a netCDF4 file (most recommended)
+* `dat2nc-convention-sem.py`: script to transform FINO 1 `.dat` files to a netCDF4 file (not recommended, uses compound data structures, for which software support is still lacking)
+* `automated-check-snippets.py`: script for (semi-)automated quality checks, such as outlier detection
+* `convention_read.py`: helper code for `automated-check-snippets.py`

MMIJ/README.md

@@ -0,0 +1,6 @@
+File descriptions:
+
+* `csv2nc.py`: script to transform the MMIJ `.csv` file to a netCDF4 file (most recommended)
+* `csv2nc-compound-sem.py`: script to transform the MMIJ `.csv` file to a netCDF4 file (not recommended, uses compound data structures, for which software support is still lacking)
+* `csv2nc-compound-nosem.py`: script, variant of `csv2nc-compound-sem.py`, to transform the MMIJ `.csv` file to a netCDF4 file (not recommended, uses compound data structures, for which software support is still lacking)
+* `automated-check-snippets.py`: script for (semi-)automated quality checks, such as outlier detection

OWEZ/README.md

@@ -0,0 +1,5 @@
+File descriptions:
+
+* `xls2h5.py`: script to transform OWEZ `.xls` files to an HDF5 file
+* `automated-check-snippets.py`: script for (semi-)automated quality checks, such as outlier detection
+* `convention_read.py`: helper code for `automated-check-snippets.py`

README.md

@@ -1,2 +1,14 @@
 # met-data-scripts
 Python scripts for transforming specific metocean datasets from text-based to binary formats and checking them for data quality issues
+
+This repository contains scripts used during the analysis of three North Sea metocean datasets used for wind energy research.
+Each directory pertains to one dataset.
+
+Within each directory are a number of scripts:
+
+* one or more scripts for transforming text-based dataset files to binary dataset files
+* one script for performing automated quality checks on the data
+* possibly one helper script
+
+More information is given as comments in the script files and in a `README.md` file in each directory.
+_(Once available a reference will be added here to a publication describing the research in the context of which these scripts were created.)_