diagnostic variables name and comment

src/Diagnostics/define_diagnostics.jl

@@ -13,6 +13,7 @@ function define_diagnostics!(land_model)
         long_name = "Albedo",
         standard_name = "albedo",
         units = "",
+        comment = "The fraction of incoming radiation reflected by the land surface.",
         compute! = (out, Y, p, t) -> compute_albedo!(out, Y, p, t, land_model),
     )
 
@@ -22,6 +23,7 @@ function define_diagnostics!(land_model)
         long_name = "Net Radiation",
         standard_name = "net_radiation",
         units = "W m^-2",
+        comment = "Balance between incoming and outgoing shortwave and longwave radiation at the land surface.",
         compute! = (out, Y, p, t) ->
             compute_net_radiation!(out, Y, p, t, land_model),
     )
@@ -32,6 +34,7 @@ function define_diagnostics!(land_model)
         long_name = "Surface Temperature",
         standard_name = "surface_temperature",
         units = "K",
+        comment = "Temperature at the land-atmosphere interface.",
         compute! = (out, Y, p, t) ->
             compute_surface_temperature!(out, Y, p, t, land_model),
     )
@@ -42,6 +45,7 @@ function define_diagnostics!(land_model)
         long_name = "Surface Specific Humidity",
         standard_name = "surface_specific_humidity",
         units = "",
+        comment = "Ratio of water vapor mass to total moist air parcel mass.",
         compute! = (out, Y, p, t) ->
             compute_surface_specific_humidity!(out, Y, p, t, land_model),
     )
@@ -52,6 +56,7 @@ function define_diagnostics!(land_model)
         long_name = "Latent Heat Flux",
         standard_name = "latent_heat_flux",
         units = "W m^-2",
+        comment = "Exchange of energy at the land-atmosphere interface due to water evaporation.",
         compute! = (out, Y, p, t) ->
             compute_latent_heat_flux!(out, Y, p, t, land_model),
     )
@@ -62,6 +67,7 @@ function define_diagnostics!(land_model)
         long_name = "Aerodynamic Resistance",
         standard_name = "aerodynamic_resistance",
         units = "m s^-1",
+        comment = "Effiency of turbulent transport controlling the land-atmosphere exchange of sensible and latent heat.",
         compute! = (out, Y, p, t) ->
             compute_aerodynamic_resistance!(out, Y, p, t, land_model),
     )
@@ -72,6 +78,7 @@ function define_diagnostics!(land_model)
         long_name = "Sensible Heat Flux",
         standard_name = "sensible_heat_flux",
         units = "W m^-2",
+        comment = "Exchange of energy at the land-atmosphere interface due to temperature difference.",
         compute! = (out, Y, p, t) ->
             compute_sensible_heat_flux!(out, Y, p, t, land_model),
     )
@@ -82,6 +89,7 @@ function define_diagnostics!(land_model)
         long_name = "Liquid water evaporation",
         standard_name = "vapor_flux",
         units = "m s^-1",
+        comment = "Evaporation of liquid water from the land surface to the atmosphere.",
         compute! = (out, Y, p, t) ->
             compute_vapor_flux!(out, Y, p, t, land_model),
     )
@@ -92,6 +100,7 @@ function define_diagnostics!(land_model)
         long_name = "Surface Air Density",
         standard_name = "surface_air_density",
         units = "kg m^−3",
+        comment = "Density of air and the land-atmosphere interface.",
         compute! = (out, Y, p, t) ->
             compute_surface_air_density!(out, Y, p, t, land_model),
     )
@@ -100,40 +109,44 @@ function define_diagnostics!(land_model)
 
     # Soil temperature (3D) at depth
     add_diagnostic_variable!(
-        short_name = "t",
+        short_name = "tsoil",
         long_name = "Soil temperature",
         standard_name = "soil_temperature",
         units = "K",
+        comment = "Soil temperature at multiple soil depth.",
         compute! = (out, Y, p, t) ->
             compute_soil_temperature!(out, Y, p, t, land_model),
     )
 
     # Surbsurface water storage
     add_diagnostic_variable!(
-        short_name = "w",
+        short_name = "wsoil",
         long_name = "subsurface Water Storage",
         standard_name = "subsurface_water_storage",
         units = "m",
+        comment = "Soil water content at multiple depth.",
         compute! = (out, Y, p, t) ->
             compute_subsurface_water_storage!(out, Y, p, t, land_model),
     )
 
     # Surface water content
     add_diagnostic_variable!(
-        short_name = "ws",
+        short_name = "wsfc",
         long_name = "Surface Water Content",
         standard_name = "surface_water_content",
         units = "m",
+        comment = "Water at the soil surface.",
         compute! = (out, Y, p, t) ->
             compute_surface_water_content!(out, Y, p, t, land_model),
     )
 
-    # Surface water content
+    # Surface snow water content
     add_diagnostic_variable!(
-        short_name = "sigmas",
+        short_name = "ssfc",
         long_name = "Snow Water Equivalent",
         standard_name = "snow_water_equivalent",
         units = "m",
+        comment = "Snow at the soil surface, expressed in water equivalent.",
         compute! = (out, Y, p, t) ->
             compute_snow_water_equivalent!(out, Y, p, t, land_model),
     )