Adding a few rof notebooks

README.md

@@ -100,6 +100,7 @@ Options:
   -lnd, --land        Run land component diagnostics
   -ice, --seaice      Run sea ice component diagnostics
   -glc, --landice     Run land ice component diagnostics
+  -rof, --river-runoff Run river runoff component diagnostics
   --config_path       Path to the YAML configuration file containing specifications for notebooks (default config.yml)
   -h, --help          Show this message and exit.
 ```

cupid/run.py

@@ -17,6 +17,7 @@
   -lnd, --land        Run land component diagnostics
   -ice, --seaice      Run sea ice component diagnostics
   -glc, --landice     Run land ice component diagnostics
+  -rof, --river-runoff Run river runoff component diagnostics
   -config_path        Path to the YAML configuration file containing specifications for notebooks (default: config.yml)
   -h, --help          Show this message and exit.
 """
@@ -46,6 +47,7 @@
 @click.option("--land", "-lnd", is_flag=True, help="Run land component diagnostics")
 @click.option("--seaice", "-ice", is_flag=True, help="Run sea ice component diagnostics")
 @click.option("--landice", "-glc", is_flag=True, help="Run land ice component diagnostics")
+@click.option("--river-runoff", "-rof", is_flag=True, help="Run river runoff component diagnostics")
 @click.argument("config_path", default="config.yml")
 def run(
     config_path,
@@ -57,6 +59,7 @@ def run(
     land=False,
     seaice=False,
     landice=False,
+    river_runoff=False,
 ):
     """
     Main engine to set up running all the notebooks.
@@ -81,11 +84,12 @@ def run(
         "lnd": land,
         "ice": seaice,
         "glc": landice,
+        "rof": river_runoff,
     }
 
     # Automatically run all if no components specified
 
-    if True not in [atmosphere, ocean, land, seaice, landice]:
+    if True not in [atmosphere, ocean, land, seaice, landice, river_runoff]:
         all = True
         for key in component_options.keys():
             component_options[key] = True

examples/coupled_model/config.yml

@@ -95,13 +95,21 @@ timeseries:
     end_years: [102]
     level: 'lev'
 
+  rof:
+    vars: []
+    derive_vars: []
+    hist_str: 'initial_hist'
+    start_years: [2]
+    end_years: [102]
+    level: 'lev'
+
 compute_notebooks:
 
   # This is where all the notebooks you want run and their
   # parameters are specified. Several examples of different
   # types of notebooks are provided.
 
-  # The first key (here simple_no_params_nb) is the name of the
+  # The second key (here adf_quick_run) is the name of the
   # notebook from nb_path_root, minus the .ipynb
 
     infrastructure:
@@ -194,6 +202,11 @@ book_toc:
       chapters:
         - file: ice/seaice
 
+    - caption: River Runoff
+      chapters:
+        - file: rof/month_annual_flow
+        - file: rof/ocean_discharge
+
 #####################################
 # Keys for Jupyter Book _config.yml #
 #####################################

examples/key_metrics/config.yml

@@ -129,6 +129,24 @@ compute_notebooks:
             obs_name: 'GrIS_MARv3.12_climo_1960_1999.nc'
             climo_nyears: 40
 
+    rof:
+      global_discharge_gauge_compare_obs:
+        parameter_groups:
+          none:
+            analysis_name: ""
+            grid_name: 'f09_f09_mosart' # ROF grid name
+            rof_start_date: '0091-01-01'
+            rof_end_date: '0101-01-01'
+            figureSave: False
+      global_discharge_ocean_compare_obs:
+        parameter_groups:
+          none:
+            analysis_name: ""
+            grid_name: 'f09_f09_mosart' # ROF grid name
+            rof_start_date: '0091-01-01'
+            rof_end_date: '0101-01-01'
+            figureSave: False
+
 #    ice:
 #      seaice:
 #        parameter_groups: