Add lat-lon for MOSART output (#592)

* add lat-lon for MOSART output

* add more river variables

Author: chengzhuzhang

e3sm_diags/driver/default_diags/lat_lon_river_model_vs_model.cfg

@@ -0,0 +1,82 @@
+[#]
+sets = ["lat_lon_river"]
+case_id = "model_vs_model"
+variables = ["RIVER_DISCHARGE_OVER_LAND_LIQ"]
+seasons = ["ANN", "DJF", "MAM", "JJA", "SON"]
+regions = ["global"]
+test_colormap = "WhiteBlueGreenYellowRed.rgb"
+reference_colormap = "WhiteBlueGreenYellowRed.rgb"
+diff_colormap = "BrBG"
+
+[#]
+sets = ["lat_lon_river"]
+case_id = "model_vs_model"
+variables = ["FLOODED_FRACTION"]
+seasons = ["ANN", "DJF", "MAM", "JJA", "SON"]
+regions = ["global"]
+test_colormap = "WhiteBlueGreenYellowRed.rgb"
+reference_colormap = "WhiteBlueGreenYellowRed.rgb"
+diff_colormap = "BrBG"
+
+[#]
+sets = ["lat_lon_river"]
+case_id = "model_vs_model"
+variables = ["WRM_STORAGE"]
+seasons = ["ANN", "DJF", "MAM", "JJA", "SON"]
+regions = ["global"]
+test_colormap = "WhiteBlueGreenYellowRed.rgb"
+reference_colormap = "WhiteBlueGreenYellowRed.rgb"
+diff_colormap = "BrBG"
+
+
+[#]
+sets = ["lat_lon_river"]
+case_id = "model_vs_model"
+variables = ["WRM_IRR_DEFICIT"]
+seasons = ["ANN", "DJF", "MAM", "JJA", "SON"]
+regions = ["global"]
+test_colormap = "WhiteBlueGreenYellowRed.rgb"
+reference_colormap = "WhiteBlueGreenYellowRed.rgb"
+diff_colormap = "BrBG"
+
+
+[#]
+sets = ["lat_lon_river"]
+case_id = "model_vs_model"
+variables = ["WRM_IRR_DEMAND"]
+seasons = ["ANN", "DJF", "MAM", "JJA", "SON"]
+regions = ["global"]
+test_colormap = "WhiteBlueGreenYellowRed.rgb"
+reference_colormap = "WhiteBlueGreenYellowRed.rgb"
+diff_colormap = "BrBG"
+
+[#]
+sets = ["lat_lon_river"]
+case_id = "model_vs_model"
+variables = ["WRM_IRR_SUPPLY"]
+seasons = ["ANN", "DJF", "MAM", "JJA", "SON"]
+regions = ["global"]
+test_colormap = "WhiteBlueGreenYellowRed.rgb"
+reference_colormap = "WhiteBlueGreenYellowRed.rgb"
+diff_colormap = "BrBG"
+
+[#]
+sets = ["lat_lon_river"]
+case_id = "model_vs_model"
+variables = ["FLOODPLAIN_FRACTION"]
+seasons = ["ANN", "DJF", "MAM", "JJA", "SON"]
+regions = ["global"]
+test_colormap = "WhiteBlueGreenYellowRed.rgb"
+reference_colormap = "WhiteBlueGreenYellowRed.rgb"
+diff_colormap = "BrBG"
+
+
+[#]
+sets = ["lat_lon_river"]
+case_id = "model_vs_model"
+variables = ["FLOODPLAIN_VOLUME"]
+seasons = ["ANN", "DJF", "MAM", "JJA", "SON"]
+regions = ["global"]
+test_colormap = "WhiteBlueGreenYellowRed.rgb"
+reference_colormap = "WhiteBlueGreenYellowRed.rgb"
+diff_colormap = "BrBG"

e3sm_diags/driver/default_diags/lat_lon_river_model_vs_obs.cfg

@@ -0,0 +1,8 @@
+[#]
+sets = ["lat_lon_river"]
+variables = ["RIVER_DISCHARGE_OVER_LAND_LIQ"]
+seasons = ["ANN", "DJF", "MAM", "JJA", "SON"]
+regions = ["global"]
+test_colormap = "WhiteBlueGreenYellowRed.rgb"
+reference_colormap = "WhiteBlueGreenYellowRed.rgb"
+diff_colormap = "BrBG"

e3sm_diags/driver/lat_lon_river_driver.py

@@ -0,0 +1,20 @@
+from __future__ import print_function
+
+from e3sm_diags.driver.lat_lon_driver import (
+    create_and_save_data_and_metrics as base_create_and_save_data_and_metrics,
+)
+from e3sm_diags.driver.lat_lon_driver import create_metrics as base_create_metrics
+from e3sm_diags.driver.lat_lon_driver import run_diag as base_run_diag
+
+
+def create_and_save_data_and_metrics(parameter, test, ref):
+    return base_create_and_save_data_and_metrics(parameter, test, ref)
+
+
+def create_metrics(ref, test, ref_regrid, test_regrid, diff):
+    """Creates the mean, max, min, rmse, corr in a dictionary"""
+    return base_create_metrics(ref, test, ref_regrid, test_regrid, diff)
+
+
+def run_diag(parameter):
+    return base_run_diag(parameter)

e3sm_diags/parameter/__init__.py

@@ -5,6 +5,7 @@
 from .diurnal_cycle_parameter import DiurnalCycleParameter
 from .enso_diags_parameter import EnsoDiagsParameter
 from .lat_lon_land_parameter import LatLonLandParameter
+from .lat_lon_river_parameter import LatLonRiverParameter
 from .meridional_mean_2d_parameter import MeridionalMean2dParameter
 from .qbo_parameter import QboParameter
 from .streamflow_parameter import StreamflowParameter
@@ -29,5 +30,6 @@
     "tc_analysis": TCAnalysisParameter,
     "annual_cycle_zonal_mean": ACzonalmeanParameter,
     "lat_lon_land": LatLonLandParameter,
+    "lat_lon_river": LatLonRiverParameter,
     "aerosol_aeronet": CoreParameter,
 }

e3sm_diags/parameter/core_parameter.py

@@ -29,6 +29,7 @@ def __init__(self):
             "tc_analysis",
             "annual_cycle_zonal_mean",
             "lat_lon_land",
+            "lat_lon_river",
             "aerosol_aeronet",
         ]
         self.dataset = ""

e3sm_diags/parameter/lat_lon_river_parameter.py

@@ -0,0 +1,6 @@
+from .core_parameter import CoreParameter
+
+
+class LatLonRiverParameter(CoreParameter):
+    def __init__(self):
+        super(LatLonRiverParameter, self).__init__()

e3sm_diags/parser/__init__.py

@@ -27,5 +27,6 @@
     "tc_analysis": TCAnalysisParser,
     "annual_cycle_zonal_mean": CoreParser,
     "lat_lon_land": CoreParser,
+    "lat_lon_river": CoreParser,
     "aerosol_aeronet": CoreParser,
 }

e3sm_diags/plot/cartopy/lat_lon_river_plot.py

@@ -0,0 +1,8 @@
+from __future__ import print_function
+
+from e3sm_diags.plot.cartopy.lat_lon_plot import plot as base_plot
+
+
+def plot(reference, test, diff, metrics_dict, parameter):
+
+    return base_plot(reference, test, diff, metrics_dict, parameter)

e3sm_diags/viewer/default_viewer.py

@@ -25,6 +25,7 @@
     "zonal_mean_xy": "Zonal mean line plots",
     "lat_lon": "Latitude-Longitude contour maps",
     "lat_lon_land": "Latitude-Longitude contour maps (land variables)",
+    "lat_lon_river": "Latitude-Longitude contour maps (river variables)",
     "polar": "Polar contour maps",
     "cosp_histogram": "CloudTopHeight-Tau joint histograms",
     "diurnal_cycle": "Diurnal cycle phase maps",
@@ -111,7 +112,7 @@ def create_viewer(root_dir, parameters):
                             )
                             row_name_and_filename.append((row_name, fnm))
 
-                    if set_name == "lat_lon" or set_name == "lat_lon_land":
+                    if set_name in ["lat_lon", "lat_lon_land", "lat_lon_river"]:
                         metrics_path = os.path.join(
                             results_dir,
                             "{}".format(set_name),
@@ -188,7 +189,7 @@ def create_viewer(root_dir, parameters):
         print((name, url), table_tuple, taylor_diag_tuple)
         return [(name, url), table_tuple, taylor_diag_tuple]
 
-    if set_name == "lat_lon_land":
+    if set_name == "lat_lon_land" or set_name == "lat_lon_river":
         table_tuple = lat_lon_viewer.generate_lat_lon_metrics_table(
             LAT_LON_TABLE_INFO, SEASONS, viewer, root_dir, parameters
         )

e3sm_diags/viewer/lat_lon_viewer.py

@@ -37,6 +37,9 @@ def generate_lat_lon_metrics_table(
     if set_name == "lat_lon_land":
         table_name = "-land"
 
+    if set_name == "lat_lon_river":
+        table_name = "-river"
+
     table_dir = os.path.join(
         root_dir, f"table-data{table_name}"
     )  # output_dir/viewer/table-data