From 1c65ab45c0ed664891f79c8c881226165d82975e Mon Sep 17 00:00:00 2001
From: "zachary.burnett" <zachary.burnett@noaa.gov>
Date: Thu, 2 Sep 2021 16:15:24 -0400
Subject: [PATCH] add `check_completion` to README.md

---
 README.md | 25 ++++++++++++++++++++++---
 1 file changed, 22 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index c15eb6bd..d7c56a7f 100644
--- a/README.md
+++ b/README.md
@@ -89,7 +89,7 @@ modifying the JSON files.
 
 The following command creates JSON files for coupling `(ATMESH + WW3DATA) -> ADCIRC` over a small Shinnecock Inlet mesh:
 
-```bash
+```shell
 initialize_adcirc \
     --platform HERA \
     --mesh-directory /scratch2/COASTAL/coastal/save/shared/models/meshes/shinnecock/v1.0 \
@@ -238,7 +238,7 @@ optional arguments:
   --verbose             show more verbose log messages
 ```
 
-```bash
+```shell
 cd hera_shinnecock_ike_spinup_tidal_atmesh_ww3data
 generate_adcirc
 ```
@@ -286,7 +286,7 @@ The resulting configuration will have the following structure:
 
 Run the following to submit the model run to the Slurm job queue:
 
-```bash
+```shell
 ./run_hera.sh
 ``` 
 
@@ -299,3 +299,22 @@ The queue will have the following jobs added:
 20967649 1   1    (null)           (None)       ADCIRC_SETUP_unperturbed
 20967650 42  2    afterok:20967649 (Dependency) ADCIRC_HOTSTART_unperturbed
 ```
+
+### 4. track model progress
+`check_completion` checks the completion status of a running model directory.
+
+```
+usage: check_completion [-h] [--model MODEL] [--verbose] [directory ...]
+
+positional arguments:
+  directory      directory containing model run configuration
+
+optional arguments:
+  -h, --help     show this help message and exit
+  --model MODEL  model that is running, one of: `ADCIRC`
+  --verbose      list all errors and problems with runs
+```
+
+```shell
+check_completion hera_shinnecock_ike_spinup_tidal_atmesh_ww3data
+```