Add plot_results.py to generate simple matplotlib plot

Author: johnkit

.gitignore

@@ -5,4 +5,5 @@ __pycache__
 .args.txt
 
 # Some distribution files
+dist/*.tgz
 dist/neuralhydrology_demo1/app/

dist/neuralhydrology_demo1/README.md

@@ -69,3 +69,13 @@ options:
 
 Note: You can also put arguments in .args.txt file
 ```
+
+## Plotting Results
+
+The `plot_results.py` script is provided to generated simple plots of a trained model test results.
+The script requires matplotlib and xarray packages.
+The results for each run are written to a file named `test_results.nc` under the basin folder.
+An example of the path is
+`.../experiments/03164000/runs/run_0703_025058/test/model_epoch050/test_results.nc`
+so the corresponding command is
+`python3 plot_results.py .../experiments/03164000/runs/run_0703_025058/test/model_epoch050/test_results.nc`

neuralhydrology/package_demo1.py

@@ -1,17 +1,33 @@
-"""Script to build Demo1 install package in dist directory"""
+"""Script to build Demo1 install package in dist directory
+
+
+To create tar file, be sure to remote any pyc files first.
+Because I cannot figure out how to do that in tar, do this:
+
+cd dist
+rm -rf neuralhydrology_demo1/app/demo1/__pycache__/ && tar zcf neuralhydrology_demo1.tgz neuralhydrology_demo1/
+"""
 
 import pathlib
 import shutil
+import tarfile
 
 source_dir = pathlib.Path(__file__).parent
 dist_dir = source_dir.parent / 'dist/neuralhydrology_demo1'
 app_dir = dist_dir / 'app'
 
+# Delete any existing tgz and app files
+tgz_file = source_dir / 'dist/neuralhydrology_demo1.tgz'
+tgz_file.unlink(missing_ok=True)
+shutil.rmtree(app_dir)
+
 # Copy source files to app dir
 app_dir.mkdir(parents=True, exist_ok=True)
 
-from_path = source_dir / 'demo1.py'
-shutil.copy2(from_path, app_dir)
+filenames = ['demo1.py', 'plot_results.py']
+for filename in filenames:
+    from_path = source_dir / filename
+    shutil.copy2(from_path, app_dir)
 
 source_sub_dir = source_dir / 'demo1'
 app_sub_dir = app_dir / 'demo1'
@@ -20,3 +36,9 @@
 for filename in filenames:
     from_path = source_sub_dir / filename
     shutil.copy2(from_path, app_sub_dir)
+
+# Generate tgz file
+tgz_path = source_dir.parent / 'dist/neuralhydrology_demo1.tgz'
+with tarfile.open(tgz_path, 'w:gz') as tar:
+    tar.add(dist_dir)
+    print(f'Wrote {tgz_path}')

neuralhydrology/plot_results.py

@@ -0,0 +1,30 @@
+"""Plot model run results (observed & simulated)
+
+Requires matplotlib and xarray packages
+"""
+
+import argparse
+
+import matplotlib.pyplot as plt
+import xarray as xr
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser(
+        description='Plot NueralHydrology results file. Requires xarray & matplotlib')
+    parser.add_argument('results_file', help='test_results.nc file for basin/model')
+    args = parser.parse_args()
+
+    ds = xr.open_dataset(args.results_file)
+    print(ds)
+
+    qobs = ds['QObs(mm/d)_obs']
+    qsim = ds['QObs(mm/d)_sim']
+
+    px = 1/plt.rcParams['figure.dpi'] # inches per pixel
+    fig, ax = plt.subplots(figsize=(800*px, 600*px))
+    ax.plot(qobs['date'], qobs, label='Observed')
+    ax.plot(qsim['date'], qsim, label='Simulated')
+    ax.set_ylabel("Discharge (mm/d)")
+    ax.set_title(f"Basin {ds.attrs['basin']}/{ds.attrs['run']} - NSE {ds.attrs['NSE']:.3f}")
+    ax.legend()
+    plt.show()