home.md

+## Getting Started With The `docker-geocat` Containers From DockerHub
+Based on: https://groups.ssec.wisc.edu/groups/goes-r/algorithm-working-group/geocat-and-framework/geocat-user-documentation/installing-and-testing-the-experimental-lib_sat-version-of-geocat
+
+### Pull the container you want from DockerHub; this is also how you check for & grab updates.
+```bash
+docker pull nbearson/docker-geocat:latest
+```
+
+Available containers; these are used in place of `nbearson/docker-geocat:latest` in all docker commands.
+* `nbearson/docker-geocat:latest` - stable; points at `nbearson/docker-geocat:crtm_2_0_x` for now
+* `nbearson/docker-geocat:crtm_2_0_x - stable; uses CRTM 2.0.x
+* `nbearson/docker-geocat:crtm_2_1_x - stable; uses CRTM 2.1.x
+* `nbearson/docker-geocat:experimental  # unstable; used for testing new library updates before they're pushed to the stable versions
+
+### Start up the container
+```bash
+docker run -it --rm -v "$PWD":/workspace -w /workspace nbearson/docker-geocat:latest /bin/bash
+```
+
+You should now be at a bash prompt as root inside the docker container.
+
+
+### Checkout the code
+```bash
+git clone https://gitlab.ssec.wisc.edu/geocat/geocat.git
+
+cd geocat
+./install.sh -no_data
+mkdir -p l1_output l2_output rtm_output nav_output active_output nwp_files area_files snow_archive
+```
+
+### Get ancillary
+This is a script put in the container's $PATH when it's created; it
+downloads the large ancillary datasets and extracts them to the right locations
+under a data/ directory. This can take a long time to run, and requires ~30 GB of
+free space.
+```bash
+setup_geocat_ancil
+```
+
+### Build geocat
+```bash
+./register_algorithms.sh
+cd src
+make gfortran_opt
+cd ..
+```
+
+### Run regression tests
+```bash
+cd test/dev_lib_sat_regression_test
+wget ftp.ssec.wisc.edu:/pub/geocat/test_data/geocat_lib_sat_regression_test_data_20160728.tar.gz
+tar xf geocat_lib_sat_regression_test_data_20160728.tar.gz 
+rm geocat_lib_sat_regression_test_data_20160728.tar.gz 
+
+make -f regression_test.mk
+
+glance stats --doPassFail ./geocat_ref/nav_output/geocatNAV.GOES-12.2009306.174500.hdf \
+./geocat_test/nav_output/geocatNAV.GOES-12.2009306.174500.hdf &> /dev/null && echo PASS || echo FAIL
+# should PASS
+
+glance stats --doPassFail ./geocat_ref/nav_output/geocatNAV.GOES-12.2009306.174500.hdf \
+./geocat_test/nav_output/geocatNAV.GOES-12.2009306.174500.hdf &> /dev/null && echo PASS || echo FAIL
+# should FAIL
+```
\ No newline at end of file