diff --git a/.github/workflows/pull_request_ci.yml b/.github/workflows/pull_request_ci.yml index 949494c..2a620e0 100644 --- a/.github/workflows/pull_request_ci.yml +++ b/.github/workflows/pull_request_ci.yml @@ -19,8 +19,10 @@ jobs: sudo apt-get update sudo apt-get -y install libxml2-utils - - name: Check for duplicate standard names - run: tools/check_xml_unique.py standard_names.xml + - name: Check for duplicate standard names, descriptions + run: | + tools/check_xml_unique.py standard_names.xml + tools/check_xml_unique.py standard_names.xml --field="description" check-name-rules: name: Check standard names against rules diff --git a/Metadata-standard-names.md b/Metadata-standard-names.md index 2a3ed88..9474945 100644 --- a/Metadata-standard-names.md +++ b/Metadata-standard-names.md @@ -31,7 +31,7 @@ Base names can roughly be broken down into three categories: The following names are too general to be chosen as standard names, but they can serve as base names for more specific standard names. -* `amount`: amount +* `amount`: Amount * `real`: units = kg m-2 * `area`: Area * `real`: units = m2 @@ -81,7 +81,7 @@ more specific standard names. * `real`: units = W * `pressure`: Force per unit area * `real`: units = Pa -* `probability`: A number between 0 and 1 indicating the likelihood of an event occurring +* `probability`: A real number between 0 and 1 indicating the likelihood of an event occurring * `real`: units = 1 * `radiative_flux`: The amount of radiative energy traveling through an area per unit time * `real`: units = W m-2 @@ -103,7 +103,7 @@ more specific standard names. * `real`: units = m2 s-1 * `volume`: Volume * `real`: units = m3 -* `volume_flux`: The number of molecules or atoms of a substance traveling through an area per unit time +* `volume_flux`: The movement of a volume of a substance across a unit area per unit time * `real`: units = m s-1 * `volume_fraction`: The fraction of a volume where some condition applies * `real`: units = 1 @@ -126,18 +126,18 @@ They can all be assumed to have units of '1' * `cfc22`: Chlorodifluoromethane * `dimethyl_sulfide`: Dimethyl sulfide; DMS * `hcho`: Formaldehyde -* `hydrophilic_black_carbon`: hydrophilic_black_carbon -* `hydrophobic_black_carbon`: hydrophobic_black_carbon -* `hydrophilic_organic_carbon`: hydrophilic_organic_carbon -* `hydrophobic_organic_carbon`: hydrophobic_organic_carbon +* `hydrophilic_black_carbon`: Hydrophilic black carbon +* `hydrophobic_black_carbon`: Hydrophobic black carbon +* `hydrophilic_organic_carbon`: Hydrophilic organic carbon +* `hydrophobic_organic_carbon`: Hydrophobic organic carbon * `methane`: ch4 -* `n2o`: Nitrous Oxide, N_2O +* `n2o`: Nitrous Oxide; N_2O * `nitrate`: Chemical species containing the nitrate ion * `nitrite`: Chemical species containing the nitrite ion * `no2`: Nitrogen dioxide -* `no`: Nitric oxide NO (Nitrogen oxide, Nitrogen monoxide) -* `oxygen`: Molecular oxygen, O_2 -* `ozone`: Ozone, O_3 +* `no`: Nitric oxide; NO (Nitrogen oxide, Nitrogen monoxide) +* `oxygen`: Molecular oxygen; O_2 +* `ozone`: Ozone; O_3 * `phosphate`: Chemical species containing the phosphate ion * `silicate`: Chemical species containing the silicate ion * `sulfate`: Chemical species containing the sulfate ion @@ -173,7 +173,7 @@ full list of standard names for further details. * `real`: units = W m-2 * `diffuse_vis_albedo`: Albedo of diffuse incident visible radiation * `real`: units = 1 -* `direct_nir_albedo`: Albedo of diffuse incident near-infrared radiation +* `direct_nir_albedo`: Albedo of direct incident near-infrared radiation * `real`: units = 1 * `direct_nir_shortwave_flux`: Flux of direct near-infrared shortwave radiation * `real`: units = W m-2 @@ -185,7 +185,7 @@ full list of standard names for further details. * `real`: units = s-1 * `dry_air_density`: Density of air excluding water vapor component * `real`: units = kg m-3 -* `dry_air_enthalpy_at_constant_pressure`: Specific enthalpy of dry air, h = Cp*T, Cp = Specific heat of dry air at constant pressure, T = temperature +* `dry_air_enthalpy_at_constant_pressure`: Specific enthalpy of dry air, h = Cp*T; Cp = Specific heat of dry air at constant pressure, T = temperature * `real`: units = J kg-1 * `exner_function`: Exner function, (p/p0)^(Rd/cp), where p0 is some reference pressure (1000 hPa if not specified) * `real(kind=kind_phys)`: units = 1 @@ -212,7 +212,7 @@ full list of standard names for further details. * `real`: units = W m-2 * `momentum_flux`: Flux of momentum across a unit surface * `real`: units = Pa -* `nonhygroscopic_ice_nucleating_aerosols`: nonhygroscopic_ice_nucleating_aerosols +* `nonhygroscopic_ice_nucleating_aerosols`: Ice-nucleating aerosols with the property of not accumulating liquid water * `pressure`: Pressure * `real`: units = Pa * `rain`: Precipitation of liquid water from clouds @@ -224,7 +224,7 @@ full list of standard names for further details. * `real`: units = Pa * `relative_humidity`: Ratio of the vapor pressure to the saturation vapor pressure (for liquid water unless otherwise specified) * `real`: units = fraction -* `roughness_length`: Also called surface roughness length, the height above a surface where the wind speed would be zero according to an idealized logarithmic wind profile +* `roughness_length`: Also called surface roughness length; the height above a surface where the wind speed would be zero according to an idealized logarithmic wind profile * `real`: units = m * `sensible_heat_flux`: Flux of sensible heat across a unit surface * `real`: units = W m-2 @@ -233,11 +233,11 @@ full list of standard names for further details. * `snow`: Precipitation of ice crystals from clouds * `snow_area_fraction`: Fraction of an area (usually within a grid cell) covered by snow * `real`: units = fraction -* `soil_moisture`: Liquid water contained within a soil layer +* `soil_moisture`: Water contained within a soil layer * `soil_temperature`: Temperature of a soil layer * `real`: units = K * `solar_declination_angle`: The angle between the equator and Earth's orbital plane with the Sun -* `solar_zenith_angle`: Angle between the direction to the sun and the local zenith (vertical direction) +* `solar_zenith_angle`: The angle between the direction to the sun and the local zenith (vertical direction) * `surface_skin_temperature`: The temperature of the topmost layer of the surface * `real`: units = K * `temperature`: Temperature @@ -246,7 +246,7 @@ full list of standard names for further details. * `real`: units = K m s-1 * `time`: Time * `real`: units = s -* `total_energy`: Energy from all sources +* `total_energy`: Total energy * `total_water`: All water phases (solid, liquid, gas) * `tracer`: A hypothetical zero-mass particle that is advected in fluid flow * `tracers`: Tracers @@ -316,15 +316,15 @@ Currently, the only dimension which supports all six dimension types is horizont * `integer(kind=kind_phys)`: units = s * `specific_heat_of_dry_air_at_constant_pressure`: Specific heat of dry air at constant pressure * `real(kind=kind_phys)`: units = J kg-1 K-1 -* `specific_heat_of_liquid_water_at_20c`: specific heat of liquid water at 20c +* `specific_heat_of_liquid_water_at_20c`: Specific heat of liquid water at 20 degrees Celsius * `real(kind=kind_phys)`: units = J kg-1 K-1 -* `latent_heat_of_vaporization_of_water_at_0c`: latent heat of vaporization of water at 0c +* `latent_heat_of_vaporization_of_water_at_0c`: Latent heat of vaporization of water at 0 degrees Celsius * `real(kind=kind_phys)`: units = J kg-1 -* `dry_air_density_at_stp`: density of dry air at standard temperature and pressure +* `dry_air_density_at_stp`: Density of dry air at standard temperature and pressure * `real(kind=kind_phys)`: units = kg m-3 -* `fresh_liquid_water_density_at_0c`: density of liquid water at 0c +* `fresh_liquid_water_density_at_0c`: Density of liquid water at 0 degrees Celsius * `real(kind=kind_phys)`: units = kg m-3 -* `ratio_of_water_vapor_to_dry_air_gas_constants_minus_one`: (Rwv / Rdair) - 1.0 +* `ratio_of_water_vapor_to_dry_air_gas_constants_minus_one`: Ratio of gas constants of water vapor and dry air minus one; (Rwv / Rdair) - 1.0 * `real(kind=kind_phys)`: units = 1 * `standard_gravitational_acceleration`: scalar constant representing gravitational acceleration * `real(kind=kind_phys)`: units = m s-2 @@ -367,9 +367,9 @@ Note that appending '_on_previous_timestep' to standard_names in this section yi * `real(kind=kind_phys)`: units = m s-1 * `northward_wind`: Wind vector component, positive when directed northward * `real(kind=kind_phys)`: units = m s-1 -* `eastward_wind_at_10m`: Wind vector component at 10m, positive when directed eastward +* `eastward_wind_at_10m`: Wind vector component at 10 meters above surface, positive when directed eastward * `real(kind=kind_phys)`: units = m s-1 -* `northward_wind_at_10m`: Wind vector component at 10m, positive when directed northward +* `northward_wind_at_10m`: Wind vector component at 10 meters above surface, positive when directed northward * `real(kind=kind_phys)`: units = m s-1 * `eastward_wind_at_surface`: Wind vector component closest to surface, positive when directed eastward * `real(kind=kind_phys)`: units = m s-1 @@ -379,9 +379,9 @@ Note that appending '_on_previous_timestep' to standard_names in this section yi * `real(kind=kind_phys)`: units = m s-1 * `wind_from_direction_at_surface`: Direction, from north, of wind speed closest to surface * `real(kind=kind_phys)`: units = degrees -* `dry_static_energy`: Dry static energy Content of Atmosphere Layer +* `dry_static_energy`: Dry static energy content of atmosphere layer * `real(kind=kind_phys)`: units = J kg-1 -* `do_lagrangian_vertical_coordinate`: flag indicating if vertical coordinate is lagrangian +* `do_lagrangian_vertical_coordinate`: Flag indicating if vertical coordinate is lagrangian * `logical(kind=)`: units = flag * `lagrangian_tendency_of_air_pressure`: Vertical pressure velocity * `real(kind=kind_phys)`: units = Pa s-1 @@ -403,15 +403,15 @@ Note that appending '_on_previous_timestep' to standard_names in this section yi * `real(kind=kind_phys)`: units = 1 * `ln_air_pressure_of_dry_air`: Ln air pressure of dry air * `real(kind=kind_phys)`: units = 1 -* `reciprocal_of_exner_function_wrt_air_pressure_at_surface`: inverse exner function w.r.t. surface pressure, (ps/p)^(R/cp) +* `reciprocal_of_exner_function_wrt_air_pressure_at_surface`: inverse exner function with respect to surface pressure; (ps/p)^(R/cp) * `real(kind=kind_phys)`: units = 1 -* `geopotential_height`: geopotential height w.r.t. sea level +* `geopotential_height`: geopotential height with respect to sea level * `real(kind=kind_phys)`: units = m -* `geopotential_height_at_surface`: Geopotential height at local surface w.r.t. sea level +* `geopotential_height_at_surface`: Geopotential height at local surface with respect to sea level * `real(kind=kind_phys)`: units = m -* `geopotential_height_wrt_surface`: geopotential height w.r.t. local surface +* `geopotential_height_wrt_surface`: geopotential height with respect to local surface * `real(kind=kind_phys)`: units = m -* `geopotential_height_wrt_surface_at_interfaces`: geopotential height w.r.t. local surface at interfaces +* `geopotential_height_wrt_surface_at_interfaces`: geopotential height with respect to local surface at interfaces * `real(kind=kind_phys)`: units = m * `potentially_advected_quantities`: Potentially advected quantities * `real(kind=kind_phys)`: units = various @@ -475,7 +475,7 @@ Note that appending '_on_previous_timestep' to standard_names in this section yi * `real(kind=kind_phys)`: units = m2 s-1 * `upward_absolute_vorticity_of_air`: The upward (kth) component of the curl of the vector wind field * `real(kind=kind_phys)`: units = s-1 -* `horizontal_divergence_of_air`: The (horizontal) divergence of the 2-D vector wind field +* `horizontal_divergence_of_air`: The horizontal divergence of the 2-D vector wind field * `real(kind=kind_phys)`: units = s-1 * `upward_heat_flux_in_air_at_surface`: Upward heat flux in air at surface * `real(kind=kind_phys)`: units = W m-2 @@ -485,9 +485,9 @@ Note that appending '_on_previous_timestep' to standard_names in this section yi * `real(kind=kind_phys)`: units = W m-2 * `us_standard_air_pressure_at_sea_level`: US Standard Atmospheric pressure at sea level * `real(kind=kind_phys)`: units = Pa -* `surface_reference_pressure`: Reference pressure used in definition of potential temperature, Exner function, etc. +* `surface_reference_pressure`: Reference pressure used in definition of some other quantity (e.g. potential temperature, Exner function, etc.) * `real(kind=kind_phys)`: units = Pa -* `reference_pressure_in_atmosphere_layer`: reference pressure in atmosphere layer +* `reference_pressure_in_atmosphere_layer`: Reference pressure in atmosphere layer * `real(kind=kind_phys)`: units = Pa * `reference_air_pressure_normalized_by_air_pressure_at_surface`: reference pressure normalized by surface pressure * `real(kind=kind_phys)`: units = 1 @@ -499,17 +499,13 @@ Note that appending '_on_previous_timestep' to standard_names in this section yi * `real(kind=kind_phys)`: units = K * `potential_temperature_of_air_on_previous_timestep`: air potential temperature on previous timestep * `real(kind=kind_phys)`: units = K -* `virtual_temperature`: virtual temperature - * `real(kind=kind_phys)`: units = K -* `virtual_potential_temperature`: virtual potential temperature - * `real(kind=kind_phys)`: units = K * `composition_dependent_gas_constant_of_dry_air`: Composition dependent gas constant of dry air * `real(kind=kind_phys)`: units = J kg-1 K-1 -* `composition_dependent_specific_heat_of_dry_air_at_constant_pressure`: composition dependent specific heat of dry air at constant pressure +* `composition_dependent_specific_heat_of_dry_air_at_constant_pressure`: composition-dependent specific heat of dry air at constant pressure * `real(kind=kind_phys)`: units = J kg-1 K-1 -* `composition_dependent_ratio_of_dry_air_gas_constant_to_specific_heat_of_dry_air_at_constant_pressure`: composition dependent ratio of dry air gas constant to specific heat of dry air at constant pressure +* `composition_dependent_ratio_of_dry_air_gas_constant_to_specific_heat_of_dry_air_at_constant_pressure`: composition-dependent ratio of dry air gas constant to specific heat of dry air at constant pressure * `real(kind=kind_phys)`: units = 1 -* `ratio_of_water_vapor_gas_constant_to_composition_dependent_dry_air_gas_constant_minus_one`: (Rwv / Rdair) - 1.0 +* `ratio_of_water_vapor_gas_constant_to_composition_dependent_dry_air_gas_constant_minus_one`: Ratio of gas constants of water vapor to composition-dependent dry air minus one; (Rwv / Rdair) - 1.0 * `real(kind=kind_phys)`: units = 1 * `mass_content_of_cloud_ice_in_atmosphere_layer`: Mass content of cloud ice in atmosphere layer * `real(kind=kind_phys)`: units = kg m-2 @@ -532,9 +528,9 @@ Note that appending '_on_previous_timestep' to standard_names in this section yi * `gravitational_acceleration`: Gravitational acceleration * `real(kind=kind_phys)`: units = m s-2 ## land_surface -* `land_ice_area_fraction_of_cell_area`: fraction of horizontal area of grid cell that is land ice +* `land_ice_area_fraction_of_cell_area`: fraction of horizontal area of grid cell that is ice over land * `real(kind=kind_phys)`: units = frac -* `mass_content_of_water_in_top_soil_layer`: content per unit area of water in top layer of soil +* `mass_content_of_water_in_top_soil_layer`: mass per unit area of water in top layer of soil * `real(kind=kind_phys)`: units = kg m-2 * `density_of_snow_at_surface`: Density of snow at surface * `real(kind=kind_phys)`: units = kg m-3 @@ -566,23 +562,23 @@ Note that appending '_on_previous_timestep' to standard_names in this section yi * `real(kind=kind_phys)`: units = kg kg-1 * `water_vapor_mixing_ratio_wrt_dry_air_at_top_interfaces`: Ratio of the mass of water vapor to the mass of dry air at all interfaces excluding surface * `real(kind=kind_phys)`: units = kg kg-1 -* `cloud_liquid_water_mixing_ratio_wrt_moist_air_and_condensed_water`: Ratio of the mass of liquid water to the mass of moist air and condensed water +* `cloud_liquid_water_mixing_ratio_wrt_moist_air_and_condensed_water`: Ratio of the mass of cloud liquid water to the mass of moist air and condensed water * `real(kind=kind_phys)`: units = kg kg-1 -* `cloud_liquid_water_mixing_ratio_wrt_moist_air_and_condensed_water_at_top_interfaces`: Ratio of the mass of liquid water to the mass of moist air and condensed water at all interfaces excluding surface +* `cloud_liquid_water_mixing_ratio_wrt_moist_air_and_condensed_water_at_top_interfaces`: Ratio of the mass of cloud liquid water to the mass of moist air and condensed water at all interfaces excluding surface * `real(kind=kind_phys)`: units = kg kg-1 -* `cloud_liquid_water_mixing_ratio_wrt_moist_air`: Ratio of the mass of liquid water to the mass of moist air +* `cloud_liquid_water_mixing_ratio_wrt_moist_air`: Ratio of the mass of cloud liquid water to the mass of moist air * `real(kind=kind_phys)`: units = kg kg-1 -* `cloud_liquid_water_mixing_ratio_wrt_dry_air`: Ratio of the mass of liquid water to the mass of dry air +* `cloud_liquid_water_mixing_ratio_wrt_dry_air`: Ratio of the mass of cloud liquid water to the mass of dry air * `real(kind=kind_phys)`: units = kg kg-1 -* `cloud_liquid_water_mixing_ratio_wrt_dry_air_at_top_interfaces`: Ratio of the mass of liquid water to the mass of dry air at all interfaces excluding surface +* `cloud_liquid_water_mixing_ratio_wrt_dry_air_at_top_interfaces`: Ratio of the mass of cloud liquid water to the mass of dry air at all interfaces excluding surface * `real(kind=kind_phys)`: units = kg kg-1 -* `cloud_ice_mixing_ratio_wrt_moist_air_and_condensed_water`: Ratio of the mass of ice to the mass of moist air and condensed water +* `cloud_ice_mixing_ratio_wrt_moist_air_and_condensed_water`: Ratio of the mass of cloud ice to the mass of moist air and condensed water * `real(kind=kind_phys)`: units = kg kg-1 -* `cloud_ice_mixing_ratio_wrt_moist_air_and_condensed_water_at_top_interfaces`: Ratio of the mass of ice to the mass of moist air and condensed water at all interfaces excluding surface +* `cloud_ice_mixing_ratio_wrt_moist_air_and_condensed_water_at_top_interfaces`: Ratio of the mass of cloud ice to the mass of moist air and condensed water at all interfaces excluding surface * `real(kind=kind_phys)`: units = kg kg-1 -* `cloud_ice_mixing_ratio_wrt_dry_air`: Ratio of the mass of ice to the mass of dry air +* `cloud_ice_mixing_ratio_wrt_dry_air`: Ratio of the mass of cloud ice to the mass of dry air * `real(kind=kind_phys)`: units = kg kg-1 -* `cloud_ice_mixing_ratio_wrt_dry_air_at_top_interfaces`: Ratio of the mass of ice to the mass of dry air at all interfaces excluding surface +* `cloud_ice_mixing_ratio_wrt_dry_air_at_top_interfaces`: Ratio of the mass of cloud ice to the mass of dry air at all interfaces excluding surface * `real(kind=kind_phys)`: units = kg kg-1 * `rain_mixing_ratio_wrt_moist_air_and_condensed_water`: ratio of the mass of rain to the mass of moist air and condensed water * `real(kind=kind_phys)`: units = kg kg-1 @@ -594,21 +590,21 @@ Note that appending '_on_previous_timestep' to standard_names in this section yi * `real(kind=kind_phys)`: units = kg kg-1 * `rain_mixing_ratio_wrt_dry_air_at_top_interfaces`: ratio of the mass of rain to the mass of dry air at all interfaces excluding surface * `real(kind=kind_phys)`: units = kg kg-1 -* `total_water_mixing_ratio_wrt_moist_air_and_condensed_water`: ratio of the mass of water to the mass of moist air and condensed water +* `total_water_mixing_ratio_wrt_moist_air_and_condensed_water`: ratio of the mass of all water phases to the mass of moist air and condensed water * `real(kind=kind_phys)`: units = kg kg-1 -* `total_water_mixing_ratio_wrt_moist_air_and_condensed_water_at_top_interfaces`: ratio of the mass of water to the mass of moist air and condensed water at all interfaces excluding surface +* `total_water_mixing_ratio_wrt_moist_air_and_condensed_water_at_top_interfaces`: ratio of the mass of all water phases to the mass of moist air and condensed water at all interfaces excluding surface * `real(kind=kind_phys)`: units = kg kg-1 -* `total_water_mixing_ratio_wrt_dry_air`: ratio of the mass of water to the mass of dry air +* `total_water_mixing_ratio_wrt_dry_air`: ratio of the mass of all water phases to the mass of dry air * `real(kind=kind_phys)`: units = kg kg-1 -* `total_water_mixing_ratio_wrt_dry_air_at_top_interfaces`: ratio of the mass of water to the mass of dry air at all interfaces excluding surface +* `total_water_mixing_ratio_wrt_dry_air_at_top_interfaces`: ratio of the mass of all water phases to the mass of dry air at all interfaces excluding surface * `real(kind=kind_phys)`: units = kg kg-1 * `water_vapor_mixing_ratio_wrt_moist_air_and_condensed_water_assuming_saturation`: saturated water vapor mass mixing ratio with respect to moist air and condensed water * `real(kind=kind_phys)`: units = kg kg-1 * `water_vapor_mixing_ratio_wrt_moist_air_and_condensed_water_at_top_interfaces_assuming_saturation`: saturated water vapor mass mixing ratio with respect to moist air and condensed water at all interfaces excluding surface * `real(kind=kind_phys)`: units = kg kg-1 -* `derivative_of_ln_water_vapor_partial_pressure_assuming_saturation_wrt_air_temperature`: log derivative of the water vapor partial pressure at saturation with respect to air temperature +* `derivative_of_ln_water_vapor_partial_pressure_assuming_saturation_wrt_air_temperature`: derivative of the natural logarithm of water vapor partial pressure at saturation with respect to air temperature * `real(kind=kind_phys)`: units = K-1 -* `derivative_of_ln_water_vapor_partial_pressure_assuming_saturation_wrt_air_temperature_at_top_interfaces`: log derivative of the water vapor partial pressure at saturation with respect to air temperature at all interfaces excluding surface +* `derivative_of_ln_water_vapor_partial_pressure_assuming_saturation_wrt_air_temperature_at_top_interfaces`: derivative of the natural logarithm of water vapor partial pressure at saturation with respect to air temperature at all interfaces excluding surface * `real(kind=kind_phys)`: units = K-1 * `mole_fraction_of_ozone_in_air`: Mole fraction of ozone in air * `real(kind=kind_phys)`: units = mol mol-1 @@ -636,7 +632,7 @@ Note that appending '_on_previous_timestep' to standard_names in this section yi * `real(kind=kind_phys)`: units = mol mol-1 * `volume_mixing_ratio_of_no2`: Nitrogen dioxide volume mixing ratio * `real(kind=kind_phys)`: units = mol mol-1 -* `volume_mixing_ratio_of_no`: Nitrogen oxide volume mixing ratio +* `volume_mixing_ratio_of_no`: Nitric oxide volume mixing ratio * `real(kind=kind_phys)`: units = mol mol-1 * `volume_mixing_ratio_of_o3`: Ozone volume mixing ratio * `real(kind=kind_phys)`: units = mol mol-1 @@ -657,7 +653,7 @@ Note that appending '_on_previous_timestep' to standard_names in this section yi * `real(kind=kind_phys)`: units = kg kg-1 * `mass_fraction_of_dust005_in_air`: Dust bin5 mass fraction * `real(kind=kind_phys)`: units = kg kg-1 -* `mass_fraction_of_sea_salt001_in_air`: Sea salt bin5 mass fraction +* `mass_fraction_of_sea_salt001_in_air`: Sea salt bin1 mass fraction * `real(kind=kind_phys)`: units = kg kg-1 * `mass_fraction_of_sea_salt002_in_air`: Sea salt bin2 mass fraction * `real(kind=kind_phys)`: units = kg kg-1 @@ -691,7 +687,7 @@ Note that appending '_on_previous_timestep' to standard_names in this section yi * `real(kind=kind_phys)`: units = m-1 ## emissions Emissions variables, contributed for the Community Emissions Data System (CEDS) -* `emissions_of_co_due_to_anthropogenic`: Carbon monoxide emissions from anthropogenic sources, total +* `emissions_of_co_due_to_anthropogenic_sources`: Carbon monoxide emissions from anthropogenic sources, total * `real(kind=kind_phys)`: units = kg m-2 s-1 * `emissions_of_no_due_to_anthropogenic_sources`: Nitric oxide emissions from anthropogenic sources, total * `real(kind=kind_phys)`: units = kg m-2 s-1 @@ -733,11 +729,11 @@ Emissions variables, contributed for the Community Emissions Data System (CEDS) * `real(kind=kind_phys)`: units = kg m-2 s-1 * `emissions_of_hcho_due_to_anthropogenic_solvents`: Formaldehyde emissions from anthropogenic solvents * `real(kind=kind_phys)`: units = kg m-2 s-1 -* `emissions_of_co_due_to_anthropogenic_transportation`: Carbon monoxide emissions from anthropogenic surface Transportation (Road, Rail, Other) +* `emissions_of_co_due_to_anthropogenic_transportation`: Carbon monoxide emissions from anthropogenic surface transportation (road, rail, other) * `real(kind=kind_phys)`: units = kg m-2 s-1 -* `emissions_of_no_due_to_anthropogenic_transportation`: Nitric oxide emissions from anthropogenic surface Transportation (Road, Rail, Other) +* `emissions_of_no_due_to_anthropogenic_transportation`: Nitric oxide emissions from anthropogenic surface transportation (road, rail, other) * `real(kind=kind_phys)`: units = kg m-2 s-1 -* `emissions_of_hcho_due_to_anthropogenic_transportation`: Formaldehyde emissions from anthropogenic surface Transportation (Road, Rail, Other) +* `emissions_of_hcho_due_to_anthropogenic_transportation`: Formaldehyde emissions from anthropogenic surface transportation (road, rail, other) * `real(kind=kind_phys)`: units = kg m-2 s-1 * `emissions_of_co_due_to_anthropogenic_waste`: Carbon monoxide emissions from anthropogenic waste disposal and handling * `real(kind=kind_phys)`: units = kg m-2 s-1 @@ -772,9 +768,9 @@ Optional CCPP framework-provided variables * `integer`: units = index ## system variables Variables related to the compute environment -* `flag_for_mpi_root`: Flag for MPI root +* `flag_for_mpi_root`: Flag for MPI root process * `logical(kind=)`: units = flag -* `log_output_unit`: Log output unit +* `log_output_unit`: Fortran logical unit for output log file * `integer(kind=)`: units = 1 ## GFS_typedefs_GFS_control_type * `sigma_pressure_hybrid_coordinate_a_coefficient`: Sigma pressure hybrid coordinate a coefficient @@ -885,7 +881,7 @@ Variables related to the compute environment * `logical(kind=)`: units = flag * `sigma_pressure_threshold_at_upper_extent_of_background_diffusion`: Sigma pressure threshold at upper extent of background diffusion * `real(kind=kind_phys)`: units = 1 -* `directory_for_rte_rrtmgp_source_code`: Directory for rte rrtmgp source code +* `directory_for_rte_rrtmgp_source_code`: Directory for Radiative Transfer for Energetics/Rapid Radiative Transfer Model for General circulation model applications - Parallel (RRTMGP) source code * `character(kind=len=128)`: units = none * `do_myj_pbl_scheme`: Do Mellor-Yamada-Janjic planetary boundary layer scheme * `logical(kind=)`: units = flag @@ -937,7 +933,7 @@ Variables related to the compute environment * `integer(kind=)`: units = 1 * `do_flux_form_in_chikira_sugiyama_deep_convection_scheme`: Do flux form in chikira sugiyama deep convection scheme * `logical(kind=)`: units = flag -* `do_nrl_2015_ozone_scheme`: Do nrl 2015 ozone scheme +* `do_nrl_2015_ozone_scheme`: Do Naval Research Laboratory 2015 ozone scheme * `logical(kind=)`: units = flag * `do_prescribed_aerosols`: Do prescribed aerosols * `logical(kind=)`: units = flag @@ -1009,9 +1005,9 @@ Variables related to the compute environment * `integer(kind=)`: units = 1 * `identifier_for_grell_freitas_shallow_convection`: Identifier for grell freitas shallow convection * `integer(kind=)`: units = 1 -* `do_gfdl_microphysics_radiation_interaction`: Do gfdl microphysics radiation interaction +* `do_gfdl_microphysics_radiation_interaction`: Do Geophysical Fluid Dynamics Laboratory microphysics radiation interaction * `logical(kind=)`: units = flag -* `identifier_for_gfdl_microphysics_scheme`: Identifier for gfdl microphysics scheme +* `identifier_for_gfdl_microphysics_scheme`: Identifier for Geophysical Fluid Dynamics Laboratory microphysics scheme * `integer(kind=)`: units = 1 * `do_global_cellular_automata`: Do global cellular automata * `logical(kind=)`: units = flag @@ -1025,11 +1021,11 @@ Variables related to the compute environment * `logical(kind=)`: units = flag * `control_for_land_surface_scheme_surface_snow_albedo`: Control for land surface scheme surface snow albedo * `integer(kind=)`: units = 1 -* `do_gsl_drag_suite_large_scale_orographic_and_blocking_drag`: Do gsl drag suite large scale orographic and blocking drag +* `do_gsl_drag_suite_large_scale_orographic_and_blocking_drag`: Do Global Systems Lab drag suite large-scale orographic and blocking drag * `logical(kind=)`: units = flag -* `do_gsl_drag_suite_small_scale_orographic_drag`: Do gsl drag suite small scale orographic drag +* `do_gsl_drag_suite_small_scale_orographic_drag`: Do Global Systems Lab drag suite small-scale orographic drag * `logical(kind=)`: units = flag -* `do_gsl_drag_suite_turbulent_orographic_form_drag`: Do gsl drag suite turbulent orographic form drag +* `do_gsl_drag_suite_turbulent_orographic_form_drag`: Do Global Systems Lab drag suite turbulent orographic form drag * `logical(kind=)`: units = flag * `do_hybrid_edmf_pbl_scheme`: Do hybrid eddy-diffusivity/mass-flux planetary boundary layer scheme * `logical(kind=)`: units = flag @@ -1075,15 +1071,15 @@ Variables related to the compute environment * `logical(kind=)`: units = flag * `identifier_for_noah_land_surface_scheme`: Identifier for noah land surface scheme * `integer(kind=)`: units = 1 -* `do_noah_lsm_ua_extension`: Do noah lsm ua extension +* `do_noah_lsm_ua_extension`: Do Noah land surface model University of Arizona extension * `logical(kind=)`: units = flag * `identifier_for_noah_wrfv4_land_surface_scheme`: Identifier for noah wrfv4 land surface scheme * `integer(kind=)`: units = 1 -* `identifier_for_noahmp_land_surface_scheme`: Identifier for noahmp land surface scheme +* `identifier_for_noahmp`: Identifier for Noah land surface model with multiparameterization options * `integer(kind=)`: units = 1 -* `do_nsstm_analysis_in_gcycle`: Do nsstm analysis in gcycle +* `do_nsstm_analysis_in_gcycle`: Do GFS near-surface sea temperature scheme analysis in gcycle * `logical(kind=)`: units = flag -* `control_for_nsstm`: Control for nsstm +* `control_for_nsstm`: Control for GFS near-surface sea temperature scheme * `integer(kind=)`: units = 1 * `identifier_for_new_tiedtke_deep_convection`: Identifier for new tiedtke deep convection * `integer(kind=)`: units = 1 @@ -1107,7 +1103,7 @@ Variables related to the compute environment * `logical(kind=)`: units = flag * `do_output_of_tendency_of_air_temperature_due_to_shortwave_heating_on_radiation_timestep_assuming_clear_sky`: Do output of tendency of air temperature due to shortwave heating on radiation timestep assuming clear sky * `logical(kind=)`: units = flag -* `do_nrl_2006_ozone_scheme`: Do nrl 2006 ozone scheme +* `do_nrl_2006_ozone_scheme`: Do Naval Research Laboratory 2006 ozone scheme * `logical(kind=)`: units = flag * `control_for_pdf_shape_for_microphysics`: Control for probability density function shape for microphysics * `integer(kind=)`: units = 1 @@ -1139,9 +1135,9 @@ Variables related to the compute environment * `logical(kind=)`: units = flag * `is_restart`: Is restart * `logical(kind=)`: units = flag -* `do_rrtmgp_radiation_scheme`: Do rrtmgp radiation scheme +* `do_rrtmgp_radiation_scheme`: Flag for Rapid Radiative Transfer Model for General circulation model applications - Parallel (RRTMGP) radiation scheme * `logical(kind=)`: units = flag -* `identifier_for_ruc_land_surface_scheme`: Identifier for ruc land surface scheme +* `identifier_for_ruc_land_surface_scheme`: Identifier for Rapid Update Cycle land surface scheme * `integer(kind=)`: units = 1 * `control_for_land_surface_scheme_runoff_and_groundwater`: Control for land surface scheme runoff and groundwater * `integer(kind=)`: units = 1 @@ -1149,9 +1145,9 @@ Variables related to the compute environment * `integer(kind=)`: units = 1 * `identifier_for_scale_aware_mass_flux_shallow_convection`: Identifier for scale aware mass flux shallow convection * `integer(kind=)`: units = 1 -* `identifier_for_simplified_arakawa_schubert_deep_convection`: Identifier for simplified arakawa schubert deep convection +* `identifier_for_sas_deep_convection`: Identifier for Simplified Arakawa-Schubert deep convection scheme * `integer(kind=)`: units = 1 -* `identifier_for_simplified_arakawa_schubert_shallow_convection`: Identifier for simplified arakawa schubert shallow convection +* `identifier_for_sas_shallow_convection`: Identifier for Simplified Arakawa-Schubert shallow convection scheme * `integer(kind=)`: units = 1 * `do_scale_aware_mass_flux_deep_convection`: Do scale aware mass flux deep convection * `logical(kind=)`: units = flag @@ -1161,7 +1157,7 @@ Variables related to the compute environment * `logical(kind=)`: units = flag * `do_sgs_cellular_automata`: Do sgs cellular automata * `logical(kind=)`: units = flag -* `do_simplified_arakawa_schubert_shallow_convection`: Do simplified arakawa schubert shallow convection +* `do_sas_shallow_convection`: Do Simplified Arakawa-Schubert shallow convection scheme * `logical(kind=)`: units = flag * `do_shoc`: Do Simplified Higher-Order Closure stochastic physics scheme * `logical(kind=)`: units = flag @@ -1201,17 +1197,17 @@ Variables related to the compute environment * `integer(kind=)`: units = 1 * `identifier_for_thompson_microphysics_scheme`: Identifier for thompson microphysics scheme * `integer(kind=)`: units = 1 -* `do_ugwp_version_0`: Do ugwp version 0 +* `do_ugwp_version_0`: Do Unified Gravity Wave Physics version 0 * `logical(kind=)`: units = flag -* `do_ugwp_version_0_nonorographic_gwd`: Do ugwp version 0 nonorographic gwd +* `do_ugwp_version_0_nonorographic_gwd`: Do Unified Gravity Wave Physics version 0 non-orographic gravity wave drag * `logical(kind=)`: units = flag -* `do_ugwp_version_0_orographic_gwd`: Do ugwp version 0 orographic gwd +* `do_ugwp_version_0_orographic_gwd`: Do Unified Gravity Wave Physics version 0 orographic gravity wave drag * `logical(kind=)`: units = flag -* `do_ugwp_version_1`: Do ugwp version 1 +* `do_ugwp_version_1`: Do Unified Gravity Wave Physics version 1 * `logical(kind=)`: units = flag -* `do_ugwp_version_1_nonorographic_gwd`: Do ugwp version 1 nonorographic gwd +* `do_ugwp_version_1_nonorographic_gwd`: Do Unified Gravity Wave Physics version 1 non-orographic gravity wave drag * `logical(kind=)`: units = flag -* `do_ugwp_version_1_orographic_gwd`: Do ugwp version 1 orographic gwd +* `do_ugwp_version_1_orographic_gwd`: Do Unified Gravity Wave Physics version 1 orographic gravity wave drag * `logical(kind=)`: units = flag * `do_shoc_cloud_area_fraction_for_radiation`: Do Simplified Higher-Order Closure stochastic physics scheme cloud area fraction for radiation * `logical(kind=)`: units = flag @@ -1247,13 +1243,13 @@ Variables related to the compute environment * `logical(kind=)`: units = flag * `do_call_longwave_radiation`: Do call longwave radiation * `logical(kind=)`: units = flag -* `do_rrtmg_cloud_optics`: Do rrtmg cloud optics +* `do_rrtmg_cloud_optics`: Flag for Rapid Radiative Transfer Model for General circulation model applications (RRTMG) cloud optics * `logical(kind=)`: units = flag -* `do_rrtmgp_cloud_optics_look_up_table`: Do rrtmgp cloud optics look up table +* `do_rrtmgp_cloud_optics_lookup_table`: Flag for Rapid Radiative Transfer Model for General circulation model applications - Parallel (RRTMGP) cloud optics lookup table * `logical(kind=)`: units = flag -* `do_rrtmgp_cloud_optics_with_pade_approximation`: Do rrtmgp cloud optics with pade approximation +* `do_rrtmgp_cloud_optics_with_pade_approximation`: Flag for Rapid Radiative Transfer Model for General circulation model applications - Parallel (RRTMGP) with Pade approximation * `logical(kind=)`: units = flag -* `do_rrtmgp_longwave_jacobian`: Do rrtmgp longwave jacobian +* `do_rrtmgp_longwave_jacobian`: Flag for Rapid Radiative Transfer Model for General circulation model applications - Parallel (RRTMGP) longwave jacobian * `logical(kind=)`: units = flag * `do_call_shortwave_radiation`: Do call shortwave radiation * `logical(kind=)`: units = flag @@ -1323,7 +1319,7 @@ Variables related to the compute environment * `integer(kind=)`: units = index * `index_of_mass_number_concentration_of_nonhygroscopic_ice_nucleating_aerosols_in_tracer_concentration_array`: Index of mass number concentration of nonhygroscopic ice nucleating aerosols in tracer concentration array * `integer(kind=)`: units = index -* `index_of_cloud_liquid_water_mixing_ratio_wrt_moist_air_in_tracer_concentration_array`: Index of liquid water mass mixing ratio with respect to moist air in the tracer concentration array +* `index_of_cloud_liquid_water_mixing_ratio_wrt_moist_air_in_tracer_concentration_array`: Index of cloud liquid water mass mixing ratio with respect to moist air in the tracer concentration array * `integer(kind=)`: units = index * `index_of_mass_number_concentration_of_cloud_droplets_in_tracer_concentration_array`: Index of mass number concentration of cloud droplets in tracer concentration array * `integer(kind=)`: units = index @@ -1391,7 +1387,7 @@ Variables related to the compute environment * `real(kind=kind_phys)`: units = fraction * `max_grid_scale`: Maximum grid scale * `real(kind=kind_phys)`: units = m2 rad-2 -* `max_soil_moisture_content_for_land_surface_model`: Maximum soil moisture content for land surface model +* `max_soil_moisture_content_for_lsm`: Maximum soil moisture content for land surface model * `real(kind=kind_phys)`: units = m * `do_allow_supersaturation_after_sedimentation`: Do allow supersaturation after sedimentation * `logical(kind=)`: units = flag @@ -1445,13 +1441,13 @@ Variables related to the compute environment * `character(kind=len=16)`: units = none * `min_large_ice_fraction`: Minimum large ice fraction * `real(kind=kind_phys)`: units = fraction -* `min_pressure_in_rrtmgp`: Minimum pressure in RRTMGP +* `min_pressure_in_rrtmgp`: Minimum pressure in Rapid Radiative Transfer Model for General circulation model applications - Parallel (RRTMGP) * `real(kind=kind_phys)`: units = Pa * `min_grid_scale`: Min grid scale * `real(kind=kind_phys)`: units = m2 rad-2 -* `min_soil_moisture_content_for_land_surface_model`: Minimum soil moisture content for land surface model +* `min_soil_moisture_content_for_lsm`: Minimum soil moisture content for land surface model * `real(kind=kind_phys)`: units = m -* `min_temperature_in_rrtmgp`: Minimum temperature in RRTMGP +* `min_temperature_in_rrtmgp`: Minimum temperature in Rapid Radiative Transfer Model for General circulation model applications - Parallel (RRTMGP) * `real(kind=kind_phys)`: units = K * `control_for_total_water_mixing_in_mynn_pbl_scheme`: Control for total water mixing in Mellor-Yamada-Nakanishi-Niino planetary boundary layer scheme * `integer(kind=)`: units = 1 @@ -1539,7 +1535,7 @@ Variables related to the compute environment * `integer(kind=)`: units = count * `number_of_ice_roughness_categories`: Number of ice roughness categories * `integer(kind=)`: units = count -* `number_of_spectral_wave_truncation_for_simplified_arakawa_schubert_convection`: Number of spectral wave truncation for simplified arakawa schubert convection +* `number_of_spectral_wave_truncation_for_sas_convection`: Number of spectral wave truncation for Simplified Arakawa-Schubert deep convection scheme * `integer(kind=)`: units = count * `number_of_statistical_measures_of_subgrid_orography`: Number of statistical measures of subgrid orography * `integer(kind=)`: units = count @@ -1577,15 +1573,15 @@ Variables related to the compute environment * `real(kind=kind_phys)`: units = fraction * `rain_evaporation_coefficient_over_land_for_deep_convection`: Rain evaporation coefficient over land for deep convection * `real(kind=kind_phys)`: units = fraction -* `filename_of_rrtmgp_longwave_cloud_optics_coefficients`: Filename of rrtmgp longwave cloud optics coefficients +* `filename_of_rrtmgp_longwave_cloud_optics_coefficients`: File name of Rapid Radiative Transfer Model for General circulation model applications - Parallel (RRTMGP) longwave cloud optics coefficients * `character(kind=len=128)`: units = none -* `filename_of_rrtmgp_shortwave_cloud_optics_coefficients`: Filename of rrtmgp shortwave cloud optics coefficients +* `filename_of_rrtmgp_shortwave_cloud_optics_coefficients`: File name of Rapid Radiative Transfer Model for General circulation model applications - Parallel (RRTMGP) shortwave cloud optics coefficients * `character(kind=len=128)`: units = none -* `filename_of_rrtmgp_longwave_k_distribution`: Filename of rrtmgp longwave k distribution +* `filename_of_rrtmgp_longwave_k_distribution`: File name of Rapid Radiative Transfer Model for General circulation model applications - Parallel (RRTMGP) longwave k-distribution * `character(kind=len=128)`: units = none -* `filename_of_rrtmgp_shortwave_k_distribution`: Filename of rrtmgp shortwave k distribution +* `filename_of_rrtmgp_shortwave_k_distribution`: File name of Rapid Radiative Transfer Model for General circulation model applications - Parallel (RRTMGP) shortwave k-distribution * `character(kind=len=128)`: units = none -* `do_rrtmgp_shortwave_and_rrtmg_longwave_radiation`: Do rrtmgp shortwave and rrtmg longwave radiation +* `do_rrtmgp_shortwave_and_rrtmg_longwave_radiation`: Flag for Rapid Radiative Transfer Model for General circulation model applications - Parallel (RRTMGP) shortwave and Rapid Radiative Transfer Model for global climate model (GCM) applications (RRTMG) longwave radiation schemes * `logical(kind=)`: units = flag * `min_sea_ice_area_fraction`: Min sea ice area fraction * `real(kind=kind_phys)`: units = fraction @@ -1623,7 +1619,7 @@ Variables related to the compute environment * `integer(kind=)`: units = index * `multiplicative_tuning_parameter_for_reduced_surface_heat_fluxes_due_to_canopy_heat_storage`: Multiplicative tuning parameter for reduced surface heat fluxes due to canopy heat storage * `real(kind=kind_phys)`: units = 1 -* `thickness_of_soil_layers_for_land_surface_model`: Thickness of soil layers for land surface model +* `thickness_of_soil_layers_for_lsm`: Thickness of soil layers for land surface model * `real(kind=kind_phys)`: units = m * `cellular_automata_vertical_velocity_perturbation_threshold_for_deep_convection`: Cellular automata vertical velocity perturbation threshold for deep convection * `real(kind=kind_phys)`: units = m s-1 @@ -1663,9 +1659,9 @@ Variables related to the compute environment * `integer(kind=)`: units = count * `sigma_pressure_hybrid_vertical_coordinate`: Sigma pressure hybrid vertical coordinate * `real(kind=kind_phys)`: units = 1 -* `lower_bound_for_depth_of_sea_temperature_for_nsstm`: Lower bound for depth of sea temperature for nsstm +* `lower_bound_for_depth_of_sea_temperature_for_nsstm`: Lower bound for depth of sea temperature for GFS near-surface sea temperature scheme * `integer(kind=)`: units = mm -* `upper_bound_for_depth_of_sea_temperature_for_nsstm`: Upper bound for depth of sea temperature for nsstm +* `upper_bound_for_depth_of_sea_temperature_for_nsstm`: Upper bound for depth of sea temperature for GFS near-surface sea temperature scheme * `integer(kind=)`: units = mm * `index_of_water_vegetation_category`: Index of water vegetation category * `integer(kind=)`: units = index @@ -1713,7 +1709,7 @@ Variables related to the compute environment * `vertical_interface_dimension_interstitial`: Vertical interface dimension interstitial * `integer(kind=)`: units = count ## GFS_typedefs_GFS_tbd_type -* `absolute_momentum_flux_due_to_nonorographic_gwd`: Absolute momentum flux due to nonorographic gravity wave drag +* `absolute_momentum_flux_due_to_nonorographic_gwd`: Absolute momentum flux due to non-orographic gravity wave drag * `real(kind=kind_phys)`: units = various * `cumulative_lwe_thickness_of_convective_precipitation_amount_between_sw_radiation_calls`: Cumulative liquid water equivalent thickness of convective precipitation amount between shortwave radiation calls * `real(kind=kind_phys)`: units = m @@ -1767,7 +1763,7 @@ Variables related to the compute environment * `real(kind=kind_phys)`: units = m * `water_vapor_mixing_ratio_wrt_moist_air_on_previous_timestep`: Specific humidity (water vapor mass mixing ratio with respect to moist air) on previous timestep * `real(kind=kind_phys)`: units = kg kg-1 -* `tendency_of_water_vapor_mixing_ratio_wrt_moist_air_due_to_nonphysics`: Tendency of specific humidity (water vapor mass mixing ratio with respect to moist air) due to nonphysics +* `tendency_of_water_vapor_mixing_ratio_wrt_moist_air_due_to_nonphysics`: Tendency of specific humidity (water vapor mass mixing ratio with respect to moist air) due to non-physics processes * `real(kind=kind_phys)`: units = kg kg-1 s-1 * `momentum_exchange_coefficient_for_myj_schemes`: Momentum exchange coefficient for Mellor-Yamada-Janjic physics schemes * `real(kind=kind_phys)`: units = m s-1 @@ -1779,9 +1775,9 @@ Variables related to the compute environment * `real(kind=kind_phys)`: units = kg2 kg-2 * `random_number`: Random number * `real(kind=kind_phys)`: units = 1 -* `random_number_seed_for_mcica_longwave`: Random number seed for mcica longwave +* `random_number_seed_for_mcica_longwave`: Random number seed for Monte-Carlo Independent Column Approximation longwave scheme * `integer(kind=)`: units = 1 -* `random_number_seed_for_mcica_shortwave`: Random number seed for mcica shortwave +* `random_number_seed_for_mcica_shortwave`: Random number seed for Monte-Carlo Independent Column Approximation shortwave scheme * `integer(kind=)`: units = 1 * `cumulative_min_vertical_index_at_cloud_base_between_sw_radiation_calls`: Cumulative min vertical index at cloud base between sw radiation calls * `real(kind=kind_phys)`: units = 1 @@ -1958,7 +1954,7 @@ Variables related to the compute environment * `real(kind=kind_phys)`: units = 1 * `nonnegative_lwe_thickness_of_precipitation_amount_on_dynamics_timestep`: Non-negative liquid water equivalent thickness of precipitation amount on dynamics timestep * `real(kind=kind_phys)`: units = m -* `normalized_soil_wetness_for_land_surface_model`: Normalized soil wetness for land surface model +* `normalized_soil_wetness_for_lsm`: Normalized soil wetness for land surface model * `real(kind=kind_phys)`: units = fraction * `number_of_snow_layers`: Number of snow layers * `real(kind=kind_phys)`: units = 1 @@ -2020,7 +2016,7 @@ Variables related to the compute environment * `real(kind=kind_phys)`: units = K * `soil_temperature`: Soil temperature * `real(kind=kind_phys)`: units = K -* `soil_temperature_for_land_surface_model`: Soil temperature for land surface model +* `soil_temperature_for_lsm`: Soil temperature for land surface model * `real(kind=kind_phys)`: units = K * `volumetric_soil_moisture_between_soil_bottom_and_water_table`: Volumetric soil moisture between soil bottom and water table * `real(kind=kind_phys)`: units = m3 m-3 @@ -2064,9 +2060,9 @@ Variables related to the compute environment * `real(kind=kind_phys)`: units = fraction * `diffuse_shortwave_albedo_of_land`: land surface albedo for diffuse shortwave radiation * `real(kind=kind_phys)`: units = fraction -* `surface_drag_coefficient_for_heat_and_moisture_for_noahmp`: Surface drag coefficient for heat and moisture for noahmp +* `surface_drag_coefficient_for_heat_and_moisture_for_noahmp`: Surface drag coefficient for heat and moisture for Noah land surface model with multiparameterization options * `real(kind=kind_phys)`: units = 1 -* `surface_drag_coefficient_for_momentum_for_noahmp`: Surface drag coefficient for momentum for noahmp +* `surface_drag_coefficient_for_momentum_for_noahmp`: Surface drag coefficient for momentum for Noah land surface model with multiparameterization options * `real(kind=kind_phys)`: units = 1 * `surface_exchange_coefficient_for_heat`: Surface exchange coefficient for heat * `real(kind=kind_phys)`: units = W m-2 K-1 @@ -2134,15 +2130,15 @@ Variables related to the compute environment * `real(kind=kind_phys)`: units = fraction * `canopy_temperature`: Canopy temperature * `real(kind=kind_phys)`: units = K -* `volume_fraction_of_frozen_soil_moisture_for_land_surface_model`: Volume fraction of frozen soil moisture for land surface model +* `volume_fraction_of_frozen_soil_moisture_for_lsm`: Volume fraction of frozen soil moisture for land surface model * `real(kind=kind_phys)`: units = fraction * `volume_fraction_of_condensed_water_in_soil`: Volume fraction of condensed water in soil * `real(kind=kind_phys)`: units = fraction -* `volume_fraction_of_soil_moisture_for_land_surface_model`: Volume fraction of soil moisture for land surface model +* `volume_fraction_of_soil_moisture_for_lsm`: Volume fraction of soil moisture for land surface model * `real(kind=kind_phys)`: units = fraction * `volume_fraction_of_unfrozen_water_in_soil`: Volume fraction of unfrozen water in soil * `real(kind=kind_phys)`: units = fraction -* `volume_fraction_of_unfrozen_soil_moisture_for_land_surface_model`: Volume fraction of unfrozen soil moisture for land surface model +* `volume_fraction_of_unfrozen_soil_moisture_for_lsm`: Volume fraction of unfrozen soil moisture for land surface model * `real(kind=kind_phys)`: units = fraction * `lwe_thickness_of_surface_snow_amount`: Liquid water equivalent thickness of surface snow amount * `real(kind=kind_phys)`: units = mm @@ -2225,7 +2221,7 @@ Variables related to the compute environment * `real(kind=kind_phys)`: units = W m-2 * `net_downwelling_direct_nir_shortwave_flux_at_surface_for_coupling`: net downwelling direct near-infrared shortwave flux at the surface level for coupling * `real(kind=kind_phys)`: units = W m-2 -* `net_downwelling_direct_uv_and_vis_shortwave_flux_at_surface_for_coupling`: downwelling direct ultraviolet and visible shortwave flux at the surface level for coupling +* `net_downwelling_direct_uv_and_vis_shortwave_flux_at_surface_for_coupling`: net_downwelling direct ultraviolet and visible shortwave flux at the surface level for coupling * `real(kind=kind_phys)`: units = W m-2 * `net_downwelling_longwave_flux_at_surface_for_coupling`: Net downwelling longwave flux at surface for coupling * `real(kind=kind_phys)`: units = W m-2 @@ -2259,11 +2255,11 @@ Variables related to the compute environment * `real(kind=kind_phys)`: units = m * `physics_field_for_coupling`: Physics field for coupling * `real(kind=kind_phys)`: units = m2 s-2 -* `rrtmgp_jacobian_of_lw_flux_upward`: Rrtmgp jacobian of lw flux upward +* `rrtmgp_jacobian_of_upward_lw_flux`: Rapid Radiative Transfer Model for General circulation model applications - Parallel (RRTMGP) jacobian of upward longwave flux * `real(kind=kind_phys)`: units = W m-2 K-1 -* `rrtmgp_lw_flux_profile_downward_allsky`: Rrtmgp lw flux profile downward allsky +* `rrtmgp_lw_downward_allsky_flux_profile`: Rapid Radiative Transfer Model for General circulation model applications - Parallel (RRTMGP) longwave downward all-sky flux profile * `real(kind=kind_phys)`: units = W m-2 -* `rrtmgp_lw_flux_profile_upward_allsky`: Rrtmgp lw flux profile upward allsky +* `rrtmgp_lw_upward_allsky_flux_profile`: Rapid Radiative Transfer Model for General circulation model applications - Parallel (RRTMGP) longwave upward all-sky flux profile * `real(kind=kind_phys)`: units = W m-2 * `area_type_from_coupled_process`: Area type from coupled process * `real(kind=kind_phys)`: units = 1 @@ -2319,7 +2315,7 @@ Variables related to the compute environment * `real(kind=kind_phys)`: units = K s-1 * `cellular_automata_vertical_scaling_factor`: Cellular automata vertical scaling factor * `real(kind=kind_phys)`: units = fraction -* `shum_scaling_factors_from_coupled_process`: Stochastic HUMidity stochastic physics option scaling factors from coupled process +* `shum_scaling_factors_from_coupled_process`: Stochastic Humidity stochastic physics option scaling factors from coupled process * `real(kind=kind_phys)`: units = 1 * `skeb_x_wind_scaling_factors_from_coupled_process`: Stochastic Kinetic Energy Backscatter x-wind scaling factors from coupled process * `real(kind=kind_phys)`: units = 1 @@ -2342,7 +2338,7 @@ Variables related to the compute environment * `real(kind=kind_phys)`: units = kg-1 * `exner_function_wrt_surface_pressure`: Exner function with respect to surface pressure, (p/ps)^(Rd/cp) * `real(kind=kind_phys)`: units = 1 -* `exner_function_at_surface_adjacent_layer`: exner function (p/p0)^(Rd/cp), where p0 is 1000 hPa and p is the pressure at the surface adjacent layer +* `exner_function_at_surface_adjacent_layer`: exner function (p/p0)^(Rd/cp), where p0 is 1000 hPa and p is the pressure at the surface-adjacent layer * `real(kind=kind_phys)`: units = 1 * `exner_function_at_interfaces`: exner function (p/p0)^(Rd/cp), where p0 is 1000 hPa and p is the pressure at vertical layer interfaces * `real(kind=kind_phys)`: units = 1 @@ -2379,11 +2375,11 @@ Variables related to the compute environment * `y_wind_at_surface_adjacent_layer`: Y wind at surface adjacent layer * `real(kind=kind_phys)`: units = m s-1 ## GFS_typedefs_GFS_cldprop_type -* `convective_cloud_area_fraction_between_sw_radiation_calls_from_cnvc90`: Convective cloud area fraction between sw radiation calls from cnvc90 +* `convective_cloud_area_fraction_between_sw_radiation_calls_from_cnvc90`: Convective cloud area fraction between shortwave radiation calls from GFS Convective Cloud Diagnostics * `real(kind=kind_phys)`: units = fraction -* `pressure_at_convective_cloud_base_between_sw_radiation_calls_from_cnvc90`: Pressure at convective cloud base between sw radiation calls from cnvc90 +* `pressure_at_convective_cloud_base_between_sw_radiation_calls_from_cnvc90`: Pressure at convective cloud base between shortwave radiation calls from GFS Convective Cloud Diagnostics * `real(kind=kind_phys)`: units = Pa -* `pressure_at_convective_cloud_top_between_sw_radiation_calls_from_cnvc90`: Pressure at convective cloud top between sw radiation calls from cnvc90 +* `pressure_at_convective_cloud_top_between_sw_radiation_calls_from_cnvc90`: Pressure at convective cloud top between shortwave radiation calls from GFS Convective Cloud Diagnostics * `real(kind=kind_phys)`: units = Pa ## GFS_typedefs_GFS_radtend_type * `cosine_of_solar_zenith_angle_for_daytime_points_on_radiation_timestep`: Cosine of solar zenith angle for daytime points on radiation timestep diff --git a/StandardNamesRules.rst b/StandardNamesRules.rst index 3aa572f..2aac17a 100644 --- a/StandardNamesRules.rst +++ b/StandardNamesRules.rst @@ -64,7 +64,7 @@ ESM Standard Name Rules In the latter example, ``ln`` is operating on the quantity ``water_vapor_partial_pressure_assuming_saturation``, while ``derivative_of`` is a combined transformation of ``water_vapor_partial_pressure_assuming_saturation`` and ``air_temperature``. When multiple transformations are present, a more detailed description - should be provided in the ``long_name`` field to prevent any possible ambiguity. + should be provided in the ``description`` field to prevent any possible ambiguity. #. Variables are current and instantaneous unless specified. Variables that are not current (e.g., previous timestep) or non-instantaneous (e.g., accumulated values) @@ -94,7 +94,7 @@ ESM Standard Name Rules ``[variable]_at_top_interfaces`` is defined on `n` points, and ``[variable]_at_bottom_interfaces`` is defined on `n` points. -#. By default, *mixing_ratio* refers to mass mixing ratios. The long name should +#. By default, *mixing_ratio* refers to mass mixing ratios. The description should explicitly specify that it refers to the *mass* mixing ratio. Mass mixing ratios should contain information regarding with respect to what quantity they are defined, and options are *wrt_dry_air*, @@ -146,7 +146,7 @@ ESM Standard Name Rules #. Spell out acronyms unless they are obvious to a vast majority of scientists/developers who may come across them. A list of currently-used aliases is below. Whenever such an alias exist, use the alias in the - standard name and the full term in the long name. + standard name and the full term in the description. #. For control-oriented variables, if the variable is a Fortran logical, use flag_for ``_X``. If it is any other data type, use control_for ``_X``. All flags @@ -165,23 +165,27 @@ Technical specifications ======================== #. The standard name dictionary consists of a number of individual XML elements: - one "standard_name" element for each entry. A standard name entry consist of a "name" attribute - that represents the variable name, and (optionally) a "long_name" attribute that gives - a detailed description of what that name represents. The standard_name XML entry also contains a nested - "type" entry, indicating the data type that a standard_name should represent, and as attributes the + one ``standard_name`` element for each entry. A standard name entry consist of a ``name`` attribute + that represents the variable name, and (optionally) a ``description`` attribute that gives + a detailed description of what that name represents. Note that the ``description`` field is only + provided for information and disambiguation only (though it should be unique), and does not need to be included for + individual implementations of the standard names. This is not necessarily the same as the ``long_name`` entry as described + in the `CCPP Technical Documentation `_, + but it can be used to inform the contents of that field. The ``standard_name`` XML entry also contains a nested + ``type`` entry, indicating the data type that a ``standard_name`` should represent, and as attributes the physical units of that variable quantity (see the `section on Units <#units>`_) and the FORTRAN "kind" of the variable quantity. For example, the element for the variable name ``exner_function`` may look similar to this: + description="exner function, (p/p0)^(Rd/cp), where p0 is 1000 hPa"> real - This XML element indicates that the variable ``exner_function`` represents the quantity described by the ``long_name`` + This XML element indicates that the variable ``exner_function`` represents the quantity described by the ``description`` attribute. It is a real variable of "kind_phys" kind, and units of "1", meaning it is non-dimensional and does not correspond to a more descriptive non-dimensional type such as "fraction"; see the `section on Units <#units>`_ - for more details + for more details. These standard_name elements can optionally be separated by "section" elements. These are parsed out into human-readable sections in the generated markdown file (``Metadata-standard-names.md``). @@ -628,10 +632,16 @@ Acronyms, Abbreviations, and Aliases +---------------------+---------------------------------------------------------+ | **Short** | **Meaning** | +=====================+=========================================================+ +| cnvc90 | GFS Convective Cloud Diagnostics | ++---------------------+---------------------------------------------------------+ | edmf | eddy-diffusivity/mass-flux | +---------------------+---------------------------------------------------------+ | gwd | gravity wave drag | +---------------------+---------------------------------------------------------+ +| gfdl | Geophysical Fluid Dynamics Laboratory | ++---------------------+---------------------------------------------------------+ +| gfs | Global Forecast System | ++---------------------+---------------------------------------------------------+ | ir | infrared | +---------------------+---------------------------------------------------------+ | lwe | liquid water equivalent | @@ -646,10 +656,19 @@ Acronyms, Abbreviations, and Aliases +---------------------+---------------------------------------------------------+ | nir | near-infrared part of the EM spectrum (radiation) | +---------------------+---------------------------------------------------------+ +| nrl | Naval Research Lab | ++---------------------+---------------------------------------------------------+ +| nsstm | GFS near-surface sea temperature scheme | ++---------------------+---------------------------------------------------------+ | pbl | planetary boundary layer | +---------------------+---------------------------------------------------------+ | pdf | probability density function | +---------------------+---------------------------------------------------------+ +| rrtmgp | Rapid Radiative Transfer Model for General circulation | +| | model applications - Parallel | ++---------------------+---------------------------------------------------------+ +| sas | simplified Arakawa-Schubert scheme | ++---------------------+---------------------------------------------------------+ | skeb | stochastic kinetic energy backscatter | +---------------------+---------------------------------------------------------+ | shoc | simplified higher-order closure stochastic scheme | @@ -664,6 +683,8 @@ Acronyms, Abbreviations, and Aliases +---------------------+---------------------------------------------------------+ | toa | top of atmosphere | +---------------------+---------------------------------------------------------+ +| ugwp | Unified Gravity Wave Physics | ++---------------------+---------------------------------------------------------+ | uv | ultraviolet part of the EM spectrum (radiation) | +---------------------+---------------------------------------------------------+ | vis | visible part of the EM spectrum (radiation) | diff --git a/standard_names.xml b/standard_names.xml index b228759..6992d9f 100644 --- a/standard_names.xml +++ b/standard_names.xml @@ -7,121 +7,120 @@ comment="The following names are too general to be chosen as\n standard names, but they can serve as base names for\n more specific standard names.\n"> - + real real + description="The fraction of an area where some condition applies"> real + description="A field consisting of either 0 or 1 at every point"> integer + description="A real number used in a mathematical equation, typically derived empirically and/or adjusted based on some other physical phenomenon to change the behavior of an equation, scheme, or other modeling unit"> real + description="Mass per unit volume"> real real + description="Total energy within some surface"> real + description="Total energy within some volume"> real + description="Number of instances per unit time"> real real + description="The amount of heat traveling through an area per unit time"> real + description="Movement of heat due to advection"> real real + description="Mass traveling through an area per unit time"> real + description="The fraction of a given mass where some condition applies"> real + description="Movement of some specified mass by advection"> real real + description="The ratio of the number of molecules or atoms of a substance to the total number of molecules/atoms in a given volume"> real + description="The number of molecules or atoms of a substance traveling through an area per unit time"> real + description="The transfer of momentum through an area per unit time"> real + description="The pressure of a component gas independent of other components"> real + description="The amount of time between regular events"> real + description="Energy per unit time"> real + description="Force per unit area"> real + description="A real number between 0 and 1 indicating the likelihood of an event occurring"> real + description="The amount of radiative energy traveling through an area per unit time"> real + description="Distance from the center to the perimeter of a circle or sphere"> real + description="Directionless distance per unit time"> real + description="A deformation force across a unit area"> real @@ -131,120 +130,116 @@ real + description="The vertical distance between two constant-pressure surfaces"> real + description="Distance per unit time"> real + description="A scalar function with its gradient equal to the velocity vector of an irrotational flow"> real real + description="The movement of a volume of a substance across a unit area per unit time"> real + description="The fraction of a volume where some condition applies"> real + description="A ratio of the number of molecules or atoms of a substance to another in a unit volume"> real + description="Movement of some volume of a specified substance by advection"> real + description="The curl of a velocity vector"> real
+ description="Isoprene"> + description="Carbon dioxide"> + description="Carbon monoxide"> + description="Tetrachloromethane"> + description="Trichlorofluoromethane"> + description="Dichlorodifluoromethane"> + description="1,1,2-Trichloro-1,2,2-trifluoroethane"> + description="Chlorodifluoromethane"> + description="Dimethyl sulfide; DMS"> + description="Formaldehyde"> - + - + - + - + + description="ch4"> + description="Nitrous Oxide; N_2O"> + description="Chemical species containing the nitrate ion"> + description="Chemical species containing the nitrite ion"> + description="Nitrogen dioxide"> + description="Nitric oxide; NO (Nitrogen oxide, Nitrogen monoxide)"> + description="Molecular oxygen; O_2"> + description="Ozone; O_3"> + description="Chemical species containing the phosphate ion"> + description="Chemical species containing the silicate ion"> + description="Chemical species containing the sulfate ion"> + description="so2">
+ description="Vorticity of fluid relative to an inertial frame; the sum of relative and planetary vorticities"> real + description="The pressure of air"> real real + description="The temperature of air"> real + description="The fraction of incident radiation reflected by a surface"> real real + description="Fraction of an area (usually within a grid cell) containing cloud"> real + description="Amount of condensed water in cloud"> + description="Cloud particles consisting of solid water (ice)"> + description="Cloud particles consisting of liquid water"> + description="Albedo of diffuse incident near-infrared radiation"> real + description="Flux of diffuse near-infrared and shortwave radiation"> real + description="Albedo of diffuse incident shortwave radiation"> real + description="Flux of diffuse ultraviolet and visible shortwave radiation"> real + description="Albedo of diffuse incident visible radiation"> real + description="Albedo of direct incident near-infrared radiation"> real + description="Flux of direct near-infrared shortwave radiation"> real + description="Flux of direct ultraviolet and visible shortwave radiation"> real + description="Albedo of direct incident visible light"> real real + description="Density of air excluding water vapor component"> real + description="Specific enthalpy of dry air, h = Cp*T; Cp = Specific heat of dry air at constant pressure, T = temperature"> real + description="Exner function, (p/p0)^(Rd/cp), where p0 is some reference pressure (1000 hPa if not specified)"> real + description="A measure of shear stress within a fluid layer with units of distance per time"> real @@ -348,49 +343,49 @@ real + description="Gravitational potential energy of a unit mass relative to sea level"> real + description="Geopotential divided by the gravitational constant"> real + description="Precipitation consisting of heavily rimed ice crystals"> real + description="Precipitation formed by accretion of supercooled water droplets into a solid piece of ice"> + description="Aerosols with the property of accumulating liquid water"> + description="Latent heat flux across a unit surface"> real + description="Flux of longwave radiation across a unit surface"> real + description="Flux of momentum across a unit surface"> real + description="Ice-nucleating aerosols with the property of not accumulating liquid water"> real + description="Precipitation of liquid water from clouds"> real @@ -399,94 +394,93 @@ integer + description="Some pressure value for comparison to or calculation of other values"> real + description="Ratio of the vapor pressure to the saturation vapor pressure (for liquid water unless otherwise specified)"> real + description="Also called surface roughness length; the height above a surface where the wind speed would be zero according to an idealized logarithmic wind profile"> real + description="Flux of sensible heat across a unit surface"> real + description="Flux of shortwave radiation across a unit surface"> real + description="Precipitation of ice crystals from clouds"> + description="Fraction of an area (usually within a grid cell) covered by snow"> real + description="Water contained within a soil layer"> + description="Temperature of a soil layer"> real + description="The angle between the equator and Earth's orbital plane with the Sun"> + description="The angle between the direction to the sun and the local zenith (vertical direction)"> + description="The temperature of the topmost layer of the surface"> real real + description="Flux of temperature across a unit surface"> real real - + + description="All water phases (solid, liquid, gas)"> + description="A hypothetical zero-mass particle that is advected in fluid flow"> + description="Specific turbulent kinetic energy"> real + description="The theoretical potential temperature of dry air that would have the same density as moist air"> real + description="The theoretical temperature of dry air that would have the same density as moist air"> real + description="Water in the gaseous phase"> + description="Movement of air with a net displacement"> + description="Shear stress exerted by wind parallel to the surface"> real + description="Speed of moving air"> real
@@ -525,27 +519,27 @@ other supported dimension standard names are listed below.\n"> + description="Size horizontal dimension"> integer + description="number of vertical layers"> integer + description="number of vertical layers extended up by 1"> integer + description="number of vertical interfaces"> integer + description="index of a particular vertical layer"> integer + description="index of a particular vertical interface"> integer @@ -561,7 +555,7 @@ integer + description="Total number of OpenMP (shared-memory) parallel threads."> integer @@ -585,29 +579,29 @@ real + description="Specific heat of liquid water at 20 degrees Celsius"> real + description="Latent heat of vaporization of water at 0 degrees Celsius"> real + description="Density of dry air at standard temperature and pressure"> real + description="Density of liquid water at 0 degrees Celsius"> real + description="Ratio of gas constants of water vapor and dry air minus one; (Rwv / Rdair) - 1.0"> real + description="scalar constant representing gravitational acceleration"> real @@ -643,7 +637,7 @@ real + description="Air pressure at local surface"> real @@ -659,67 +653,67 @@ real + description="Horizontal wind in a direction perpendicular to y_wind"> real + description="Horizontal wind in a direction perpendicular to x_wind"> real + description="Wind vector component, positive when directed eastward"> real + description="Wind vector component, positive when directed northward"> real + description="Wind vector component at 10 meters above surface, positive when directed eastward"> real + description="Wind vector component at 10 meters above surface, positive when directed northward"> real + description="Wind vector component closest to surface, positive when directed eastward"> real + description="Wind vector component closest to surface, positive when directed northward"> real + description="Scalar wind speed closest to surface"> real + description="Direction, from north, of wind speed closest to surface"> real + description="Dry static energy content of atmosphere layer"> real + description="Flag indicating if vertical coordinate is lagrangian"> logical + description="Vertical pressure velocity"> real + description="Density of dry air"> real + description="Midpoint air pressure"> real + description="Dry midpoint pressure"> real @@ -741,23 +735,23 @@ real + description="inverse exner function with respect to surface pressure; (ps/p)^(R/cp)"> real + description="geopotential height with respect to sea level"> real + description="Geopotential height at local surface with respect to sea level"> real + description="geopotential height with respect to local surface"> real + description="geopotential height with respect to local surface at interfaces"> real @@ -785,11 +779,11 @@ logical + description="Flag to indicate if physics grid is initialized"> logical + description="Logging setting for negative constituent mass fixer"> character @@ -808,71 +802,71 @@ real + description="Change of dry air enthalpy per unit time at constant pressure; d/dt(Cp*T)"> real + description="Change in temperature per unit time"> real + description="Change in air temperature due to model physics per unit time"> real + description="Change in potential temperature per unit time"> real + description="Change of potential temperature of air due to model physics per unit time"> real + description="Change in x wind per unit time"> real + description="Change in x wind due to model physics per unit time"> real + description="Change in y wind per unit time"> real + description="Change in y wind due to model physics per unit time"> real + description="Change in eastward wind per unit time"> real + description="Change in eastward wind due to model physics per unit time"> real + description="Change in northward wind per unit time"> real + description="Change in northward wind due to model physics per unit time"> real + description="Scalar function describing the streamlines of the horizontal wind"> real + description="Scalar potential of the horizontal wind"> real + description="The upward (kth) component of the curl of the vector wind field"> real + description="The horizontal divergence of the 2-D vector wind field"> real @@ -885,58 +879,49 @@ real + description="US Standard Atmospheric pressure at sea level"> real + description="Reference pressure used in definition of some other quantity (e.g. potential temperature, Exner function, etc.)"> real - + real + description="reference pressure normalized by surface pressure"> real + description="Reference pressure in atmosphere layer normalized by surface reference pressure"> real + description="exner function, (p/p0)^(Rd/cp), where p0 is 1000 hPa"> real + description="air potential temperature"> real - real - - - real - - + description="air potential temperature on previous timestep"> real real + description="composition-dependent specific heat of dry air at constant pressure"> real + description="composition-dependent ratio of dry air gas constant to specific heat of dry air at constant pressure"> real + description="Ratio of gas constants of water vapor to composition-dependent dry air minus one; (Rwv / Rdair) - 1.0"> real @@ -959,7 +944,7 @@ + description="cloud area fraction in atmosphere layer excluding clouds produced by the convective schemes"> real @@ -974,30 +959,30 @@
+ description="fraction of horizontal area of grid cell that is ice over land"> real + description="mass per unit area of water in top layer of soil"> real real + description="fraction of horizontal area of grid cell that is urban"> real + description="volume fraction of water in liquid phase in soil at critical point"> real + description="volume fraction of water in liquid phase in soil at saturation"> real + description="volume fraction of water in liquid phase in soil at wilting point"> real
@@ -1014,114 +999,114 @@ integer + description="Ratio of the mass of water vapor to the mass of moist air"> real + description="Ratio of the mass of water vapor to the mass of moist air and hydrometeors"> real + description="Ratio of the mass of water vapor to the mass of moist air and hydrometeors at all interfaces excluding surface"> real real + description="Ratio of the mass of water vapor to the mass of dry air"> real + description="Ratio of the mass of water vapor to the mass of dry air at all interfaces excluding surface"> real + description="Ratio of the mass of cloud liquid water to the mass of moist air and condensed water"> real + description="Ratio of the mass of cloud liquid water to the mass of moist air and condensed water at all interfaces excluding surface"> real + description="Ratio of the mass of cloud liquid water to the mass of moist air"> real + description="Ratio of the mass of cloud liquid water to the mass of dry air"> real + description="Ratio of the mass of cloud liquid water to the mass of dry air at all interfaces excluding surface"> real + description="Ratio of the mass of cloud ice to the mass of moist air and condensed water"> real + description="Ratio of the mass of cloud ice to the mass of moist air and condensed water at all interfaces excluding surface"> real + description="Ratio of the mass of cloud ice to the mass of dry air"> real + description="Ratio of the mass of cloud ice to the mass of dry air at all interfaces excluding surface"> real + description="ratio of the mass of rain to the mass of moist air and condensed water"> real + description="ratio of the mass of rain to the mass of moist air and condensed water at all interfaces excluding surface"> real + description="ratio of the mass of rain to the mass of moist air"> real + description="ratio of the mass of rain to the mass of dry air"> real + description="ratio of the mass of rain to the mass of dry air at all interfaces excluding surface"> real + description="ratio of the mass of all water phases to the mass of moist air and condensed water"> real + description="ratio of the mass of all water phases to the mass of moist air and condensed water at all interfaces excluding surface"> real + description="ratio of the mass of all water phases to the mass of dry air"> real + description="ratio of the mass of all water phases to the mass of dry air at all interfaces excluding surface"> real + description="saturated water vapor mass mixing ratio with respect to moist air and condensed water"> real + description="saturated water vapor mass mixing ratio with respect to moist air and condensed water at all interfaces excluding surface"> real + description="derivative of the natural logarithm of water vapor partial pressure at saturation with respect to air temperature"> real + description="derivative of the natural logarithm of water vapor partial pressure at saturation with respect to air temperature at all interfaces excluding surface"> real @@ -1131,264 +1116,264 @@ real + description="Methane volume mixing ratio"> real + description="Carbon monoxide volume mixing ratio"> real + description="Carbon dioxide volume mixing ratio"> real + description="Tetrachloromethane volume mixing ratio"> real + description="Trichlorofluoromethane volume mixing ratio"> real + description="Dichlorodifluoromethane volume mixing ratio"> real + description="1,1,2-Trichloro-1,2,2-trifluoroethane volume mixing ratio"> real + description="Chlorodifluoromethane volume mixing ratio"> real + description="Dioxygen volume mixing ratio"> real + description="Nitrous oxide volume mixing ratio"> real + description="Nitrogen dioxide volume mixing ratio"> real + description="Nitric oxide volume mixing ratio"> real + description="Ozone volume mixing ratio"> real + description="Formaldehyde volume mixing ratio"> real + description="Isoprene volume mixing ratio"> real + description="Sulfur dioxide volume mixing ratio"> real
+ description="Dust bin1 mass fraction"> real + description="Dust bin2 mass fraction"> real + description="Dust bin3 mass fraction"> real + description="Dust bin4 mass fraction"> real + description="Dust bin5 mass fraction"> real + description="Sea salt bin1 mass fraction"> real + description="Sea salt bin2 mass fraction"> real + description="Sea salt bin3 mass fraction"> real + description="Sea salt bin4 mass fraction"> real + description="Sea salt bin5 mass fraction"> real + description="Hydrophobic black carbon mass fraction"> real + description="Hydrophilic black carbon mass fraction"> real + description="Hydrophobic organic carbon mass fraction"> real + description="Hydrophilic organic carbon mass fraction"> real + description="Sulfate mass fraction"> real + description="Nitrate bin1 mass fraction"> real + description="Nitrate bin2 mass fraction"> real + description="Nitrate bin3 mass fraction"> real + description="Aerosol extinction at wavelength1"> real + description="Aerosol extinction at wavelength2"> real + description="Aerosol extinction at wavelength3"> real
- + real + description="Nitric oxide emissions from anthropogenic sources, total"> real + description="Formaldehyde emissions from anthropogenic sources, total"> real + description="Carbon monoxide emissions from anthropogenic non-combustion agricultural sector"> real + description="Nitric oxide emissions from anthropogenic non-combustion agricultural sector"> real + description="Formaldehyde emissions from anthropogenic non-combustion agricultural sector"> real + description="Carbon monoxide emissions from anthropogenic non-combustion energy transformation and extraction"> real + description="Nitric oxide emissions from anthropogenic non-combustion energy transformation and extraction"> real + description="Formaldehyde emissions from anthropogenic non-combustion energy transformation and extraction"> real + description="Carbon monoxide emissions from anthropogenic industrial combustion and processes"> real + description="Nitric oxide emissions from anthropogenic industrial combustion and processes"> real + description="Formaldehyde emissions from anthropogenic industrial combustion and processes"> real + description="Carbon monoxide emissions from anthropogenic residential, commercial, and others"> real + description="Nitric oxide emissions from anthropogenic residential, commercial, and others"> real + description="Formaldehyde emissions from anthropogenic residential, commercial, and others"> real + description="Carbon monoxide emissions from anthropogenic international shipping"> real + description="Nitric oxide emissions from anthropogenic international shipping"> real + description="Formaldehyde emissions from anthropogenic international shipping"> real + description="Carbon monoxide emissions from anthropogenic solvents"> real + description="Nitric oxide emissions from anthropogenic solvents"> real + description="Formaldehyde emissions from anthropogenic solvents"> real + description="Carbon monoxide emissions from anthropogenic surface transportation (road, rail, other)"> real + description="Nitric oxide emissions from anthropogenic surface transportation (road, rail, other)"> real + description="Formaldehyde emissions from anthropogenic surface transportation (road, rail, other)"> real + description="Carbon monoxide emissions from anthropogenic waste disposal and handling"> real + description="Nitric oxide emissions from anthropogenic waste disposal and handling"> real + description="Formaldehyde emissions from anthropogenic waste disposal and handling"> real
@@ -1396,46 +1381,46 @@
+ description="Error message for error handling in CCPP"> character + description="Error code for error handling in CCPP"> integer
+ description="CCPP physics scheme name"> character + description="CCPP Constituent Properties"> ccpp_constituent_prop_ptr_t + description="Array of constituents managed by CCPP Framework"> real + description="CCPP constituent minimum values"> real + description="Number of constituents managed by CCPP Framework"> integer + description="CCPP block count"> integer + description="CCPP block sizes"> integer + description="Number of current OpenMP thread. This variable may only be used during CCPP run phase"> integer
@@ -1443,11 +1428,11 @@
+ description="Flag for MPI root process"> logical + description="Fortran logical unit for output log file"> integer
@@ -1480,7 +1465,7 @@ real + description="Maximum atmosphere heat diffusivity due to background"> real @@ -1502,15 +1487,15 @@ real + description="Identifier for 2018 scale-aware turbulent kinetic energy moist eddy-diffusivity/mass-flux planetary boundary layer scheme"> integer + description="Control for scale-aware turbulent kinetic energy moist eddy-diffusivity/mass-flux planetary boundary layer scheme"> integer + description="Identifier for 2019 scale-aware turbulent kinetic energy moist eddy-diffusivity/mass-flux planetary boundary layer scheme"> integer @@ -1529,11 +1514,11 @@ real + description="Control for cloud species mixing in Mellor-Yamada-Nakanishi-Niino planetary boundary layer scheme"> integer + description="Control for cloud probability density function in Mellor-Yamada-Nakanishi-Niino planetary boundary layer scheme"> integer @@ -1570,7 +1555,7 @@ real + description="Control for subgrid-scale cloud radiation coupling in Mellor-Yamada-Nakanishi-Niino planetary boundary layer scheme"> integer @@ -1583,7 +1568,7 @@ real + description="Critical relative humidity at the top of the atmosphere"> real @@ -1622,31 +1607,32 @@ real - + character + description="Do Mellor-Yamada-Janjic planetary boundary layer scheme"> logical + description="Do Mellor-Yamada-Janjic surface layer scheme"> logical + description="Do Mellor-Yamada-Nakanishi-Niino planetary boundary layer scheme"> logical + description="Do Mellor-Yamada-Nakanishi-Niino surface layer scheme"> logical + description="Do Unifed Gravity Wave Physics gravity wave drag scheme"> logical + description="Downdraft area fraction in scale-aware turbulent kinetic energy moist eddy-diffusivity/mass-flux planetary boundary layer scheme"> real @@ -1656,19 +1642,19 @@ real + description="Control for eddy-diffusivity mass flux in Mellor-Yamada-Nakanishi-Niino planetary boundary layer scheme"> integer + description="Control for eddy-diffusivity mass flux momentum transport in Mellor-Yamada-Nakanishi-Niino surface layer scheme"> integer + description="Control for eddy-diffusivity mass flux partitioning in Mellor-Yamada-Nakanishi-Niino planetary boundary layer scheme"> integer + description="Control for eddy-diffusivity mass flux turbulent kinetic energy transport in Mellor-Yamada-Nakanishi-Niino planetary boundary layer scheme"> integer @@ -1710,7 +1696,8 @@ logical - + logical @@ -1750,7 +1737,7 @@ integer + description="Do convective gravity wave drag"> logical @@ -1805,11 +1792,11 @@ logical + description="Do generic tendency due to gravity wave drag"> logical + description="Do generic tendency due to planetary boundary layer"> logical @@ -1821,10 +1808,12 @@ integer - + logical - + integer @@ -1840,23 +1829,26 @@ logical + description="Do gravity wave drag"> logical integer - + logical - + logical - + logical + description="Do hybrid eddy-diffusivity/mass-flux planetary boundary layer scheme"> logical @@ -1902,11 +1894,11 @@ integer + description="Control for maximum cloud overlap method"> integer + description="Identifier for maximum random cloud overlap method"> integer @@ -1919,25 +1911,30 @@ integer + description="Do mountain blocking for stochastically perturbed physics tendencies"> logical integer - + logical integer - + integer - + +GFS near-surface sea temperature scheme logical - + integer @@ -1973,11 +1970,12 @@ logical - + logical + description="Control for probability density function shape for microphysics"> integer @@ -2014,7 +2012,7 @@ logical + description="Do limited surface roughness length over ocean"> logical @@ -2023,10 +2021,12 @@ logical - + logical - + integer @@ -2038,10 +2038,12 @@ integer - + integer - + integer @@ -2051,21 +2053,22 @@ logical + description="Do scale-aware turbulent kinetic energy moist eddy-diffusivity/mass-flux planetary boundary layer scheme"> logical logical - + logical + description="Do Simplified Higher-Order Closure stochastic physics scheme"> logical + description="Do Simplified Higher-Order Closure stochastic physics scheme after convection parameterization"> logical @@ -2090,11 +2093,11 @@ logical + description="Do Stochastic HUMidity stochastic physics option"> logical + description="Do Stochastic Kinetic Energy Backscatter option"> logical @@ -2121,26 +2124,32 @@ integer - + logical - + logical - + logical - + logical - + logical - + logical + description="Do Simplified Higher-Order Closure stochastic physics scheme cloud area fraction for radiation"> logical @@ -2165,18 +2174,18 @@ integer + description="Do Yonsei University (YSU) planetary boundary layer scheme"> logical integer + description="Identifier for Zhao-Carr probability density function microphysics scheme"> integer + description="Do hurricane-specific code in hybrid eddy-diffusivity/mass-flux planetary boundary layer scheme"> logical @@ -2194,16 +2203,20 @@ logical - + logical - + logical - + logical - + logical @@ -2243,7 +2256,7 @@ integer + description="Control for drag option in gravity wave drag scheme"> integer @@ -2280,7 +2293,7 @@ integer + description="Index of convective cloud condensate mass mixing ratio with respect to moist air in the XYZ-dimensioned restart array"> integer @@ -2290,7 +2303,7 @@ integer + description="Index of graupel mass mixing ratio with respect to moist air in the tracer concentration array"> integer @@ -2300,7 +2313,7 @@ integer + description="Index of cloud ice mass mixing ratio with respect to moist air in the tracer concentration array"> integer @@ -2313,7 +2326,7 @@ integer + description="Index of cloud liquid water mass mixing ratio with respect to moist air in the tracer concentration array"> integer @@ -2323,7 +2336,7 @@ integer + description="Index of ozone mass mixing ratio with respect to moist air in the tracer concentration array"> integer @@ -2333,7 +2346,7 @@ integer + description="Index of rain mass mixing ratio with respect to moist air in the tracer concentration array"> integer @@ -2343,15 +2356,15 @@ integer + description="Index of snow mass mixing ratio with respect to moist air in the tracer concentration array"> integer + description="Index of specific humidity (water vapor mass mixing ratio with respect to moist air) on previous timestep in xyz dimensioned restart array"> integer + description="Index of specific humidity (water vapor mass mixing ratio with respect to moist air) two timesteps back in xyz dimensioned restart array"> integer @@ -2367,14 +2380,14 @@ integer + description="Index of turbulent kinetic energy in tracer concentration array"> integer integer + description="Index of specific humidity (water vapor mass mixing ratio with respect to moist air) in tracer concentration array"> integer @@ -2408,7 +2421,7 @@ real + description="Maximum tendency of air potential temperature due to large-scale precipitation"> real @@ -2418,15 +2431,15 @@ real + description="Maximum critical relative humidity"> real + description="Maximum grid scale"> real - + real @@ -2484,15 +2497,15 @@ real + description="Minimum threshold cloud condensate mass mixing ratio with respect to moist air"> real + description="Minimum threshold cloud liquid water mass mixing ratio with respect to moist air"> real + description="Minimum threshold cloud ice mass mixing ratio with respect to moist air"> real @@ -2508,30 +2521,30 @@ character + description="Minimum large ice fraction"> real + description="Minimum pressure in Rapid Radiative Transfer Model for General circulation model applications - Parallel (RRTMGP)"> real real - + real + description="Minimum temperature in Rapid Radiative Transfer Model for General circulation model applications - Parallel (RRTMGP)"> real + description="Control for total water mixing in Mellor-Yamada-Nakanishi-Niino planetary boundary layer scheme"> integer + description="Control for mixing length in Mellor-Yamada-Nakanishi-Niino planetary boundary layer scheme"> integer @@ -2556,15 +2569,15 @@ real + description="Tunable parameters for convective gravity wave drag"> real + description="Multiplicative tunable parameters for mountain blocking and orographic gravity wave drag"> real + description="Control for additional diagnostics in Mellor-Yamada-Nakanishi-Niino planetary boundary layer scheme"> integer @@ -2577,7 +2590,7 @@ integer + description="Number of probability density function-based variables in XYZ-dimensioned restart array"> integer @@ -2661,7 +2674,8 @@ integer - + integer @@ -2718,19 +2732,24 @@ real - + character - + character - + character - + character - + logical @@ -2787,14 +2806,15 @@ real - + real real + description="Period of maximum diagnostics reset"> real @@ -2816,15 +2836,15 @@ real + description="Total amplitude of stochastically perturbed physics tendencies perturbation"> real + description="Do turbulent orographic form drag in Unified Gravity Wave Physics gravity wave drag scheme"> logical + description="Updraft area fraction in scale-aware turbulent kinetic energy moist eddy-diffusivity/mass-flux planetary boundary layer scheme"> real @@ -2851,10 +2871,12 @@ real - + integer - + integer @@ -2866,11 +2888,11 @@
+ description="Cloud ice mass mixing ratio with respect to moist air in interstitial scheme"> real + description="Cloud liquid water mass mixing ratio with respect to moist air in interstitial scheme"> real @@ -2883,11 +2905,11 @@ real + description="Process-split cumulative tendency of the graupel mass mixing ratio with respect to moist air"> real + description="Process-split cumulative tendency of the cloud ice mass mixing ratio with respect to moist air"> real @@ -2897,33 +2919,33 @@ real + description="Process-split cumulative tendency of the cloud liquid water mass mixing ratio with respect to moist air"> real + description="Process-split cumulative tendency of the ozone mass mixing ratio with respect to moist air"> real + description="Process-split cumulative tendency of the rain mass mixing ratio with respect to moist air"> real + description="Process-split cumulative tendency of the snow mass mixing ratio with respect to moist air"> real real + description="Process-split cumulative change in turbulent kinetic energy per unit time"> real real + description="Process-split cumulative tendency of specific humidity (water vapor mass mixing ratio with respect to moist air)"> real @@ -2938,11 +2960,11 @@
+ description="Absolute momentum flux due to non-orographic gravity wave drag"> real + description="Cumulative liquid water equivalent thickness of convective precipitation amount between shortwave radiation calls"> real @@ -2958,7 +2980,7 @@ real + description="Atmospheric heat diffusivity from Simplified Higher-Order Closure stochastic physics scheme"> real @@ -2974,7 +2996,7 @@ real + description="Convective cloud condensate mass mixing ratio with respect to moist air"> real @@ -2996,7 +3018,7 @@ real + description="Heat exchange coefficient for Mellor-Yamada-Janjic physics schemes"> real @@ -3006,11 +3028,11 @@ real + description="Upward flux of specific humidity (water vapor mass mixing ratio with respect to moist air) at surface for MYJ surface layer scheme"> real + description="Cumulative maximum vertical index at cloud base between shortwave radiation calls"> real @@ -3023,15 +3045,15 @@ real + description="Specific humidity (water vapor mass mixing ratio with respect to moist air) on previous timestep"> real + description="Tendency of specific humidity (water vapor mass mixing ratio with respect to moist air) due to non-physics processes"> real + description="Momentum exchange coefficient for Mellor-Yamada-Janjic physics schemes"> real @@ -3041,23 +3063,25 @@ real + description="Variance of specific humidity (water vapor mass mixing ratio with respect to moist air)"> real real - + integer - + integer real + description="Specific humidity (water vapor mass mixing ratio with respect to moist air) at the top of the viscous sublayer"> real @@ -3067,15 +3091,15 @@ real + description="Subgrid-scale cloud ice mass mixing ratio with respect to moist air"> real + description="Subgrid-scale cloud liquid water mass mixing ratio with respect to moist air"> real + description="Subgrid-scale cloud fraction from Simplified Higher-Order Closure stochastic physics scheme"> real @@ -3088,14 +3112,14 @@ real + description="Surface specific humidity (water vapor mass mixing ratio with respect to moist air) for Mellor-Yamada-Janjic physics schemes"> real real + description="Covariance of air temperature and specific humidity (water vapor mass mixing ratio with respect to moist air)"> real @@ -3105,23 +3129,23 @@ real + description="Change of air temperature to withhold from stochastically perturbed physics tendencies per unit time"> real + description="Change of activated cloud condensation nuclei from climatology per unit time"> real + description="Liquid water equivalent thickness of rain amount on dynamics timestep for coupling"> real + description="Liquid water equivalent thickness of snowfall amount on dynamics timestep for coupling"> real + description="Non-advected turbulent kinetic energy multiplied by 2"> real @@ -3131,11 +3155,11 @@ real + description="Specific humidity (water vapor mass mixing ratio with respect to moist air) on previous timestep in XYZ-dimensioned restart array"> real + description="Specific humidity (water vapor mass mixing ratio with respect to moist air) two timesteps back"> real @@ -3145,7 +3169,7 @@ real + description="Scaling factor for specific humidity (water vapor mass mixing ratio with respect to moist air) at the top of the viscous sublayer"> real
@@ -3157,7 +3181,7 @@ real + description="Baseline surface roughness length"> real @@ -3176,11 +3200,11 @@ real + description="Cloud condensed water mass mixing ratio with respect to moist air at surface over ice"> real + description="Cloud condensed water mass mixing ratio with respect to moist air at surface over land"> real @@ -3262,7 +3286,7 @@ real - long_name="Upward specific humidity (water vapor mass mixing ratio with respect to moist air) flux at surface"> + description="Upward specific humidity (water vapor mass mixing ratio with respect to moist air) flux at surface"> real @@ -3290,42 +3314,42 @@ real + description="Liquid water equivalent thickness of convective precipitation amount on previous timestep"> real + description="Liquid water equivalent thickness of explicit precipitation amount on previous timestep"> real + description="Liquid water equivalent thickness of graupel amount on previous timestep"> real + description="Liquid water equivalent thickness of ice precipitation amount on previous timestep"> real real + description="Maximum vegetation area fraction"> real + description="albedo for near-infrared radiation with strong dependence on cosine of the zenith angle"> real - long_name="albedo for near-infrared radiation with weak dependence on cosine of the zenith angle"> + description="albedo for near-infrared radiation with weak dependence on cosine of the zenith angle"> real - long_name="albedo for visible radiation with strong dependence on cosine of the zenith angle"> + description="albedo for visible radiation with strong dependence on cosine of the zenith angle"> real - long_name="albedo for visible radiation with weak dependence on cosine of the zenith angle"> + description="albedo for visible radiation with weak dependence on cosine of the zenith angle"> real @@ -3341,10 +3365,11 @@ real + description="Non-negative liquid water equivalent thickness of precipitation amount on dynamics timestep"> real - + real @@ -3357,7 +3382,7 @@ real + description="Height above mean sea level at local surface"> real @@ -3412,19 +3437,19 @@ real + description="Liquid water equivalent thickness of ice in surface snow"> real + description="Liquid water equivalent thickness of liquid water in surface snow"> real + description="Liquid water equivalent thickness of snowfall amount on previous timestep"> real + description="Liquid water equivalent snowfall rate"> real @@ -3442,22 +3467,23 @@ real - + real real + description="Specific humidity (water vapor mass mixing ratio with respect to moist air) at two meters above surface"> real + description="mixing ratio of the mass of water vapor to the mass of moist air and hydrometeors, at two meters above surface"> real + description="Specified upward specific humidity (water vapor mass mixing ratio with respect to moist air) flux at surface"> real @@ -3482,49 +3508,51 @@ real + description="ice surface albedo for diffuse near-infrared radiation"> real + description="land surface albedo for diffuse near-infrared radiation"> real + description="ice surface albedo for diffuse visible radiation"> real + description="land surface albedo for diffuse visible radiation"> real + description="ice surface albedo for direct near-infrared radiation"> real + description="land surface albedo for direct near-infrared radiation"> real + description="ice surface albedo for direct visible radiation"> real + description="land surface albedo for direct visible radiation"> real + description="ice surface albedo for diffuse shortwave radiation"> real + description="land surface albedo for diffuse shortwave radiation"> real - + real - + real @@ -3555,43 +3583,43 @@ real + description="surface roughness length"> real + description="surface roughness length from wave model"> real + description="surface roughness length over ice"> real + description="surface roughness length over land"> real + description="surface roughness length over water"> real + description="Skin temperature at surface"> real + description="Skin temperature at surface over (or where) ice"> real + description="Skin temperature at surface over (or where) land"> real + description="Skin temperature at surface over (or where) ocean"> real + description="Skin temperature at surface over (or where) snow"> real @@ -3601,15 +3629,15 @@ real + description="surface snow-free albedo over land"> real + description="Liquid water equivalent surface snow"> real + description="Specific humidity (water vapor mass mixing ratio with respect to moist air) at surface"> real @@ -3631,7 +3659,7 @@ real + description="Upper bound of maximum albedo assuming deep snow"> real @@ -3640,23 +3668,26 @@ real - + real real - + real real - + real + description="Liquid water equivalent thickness of surface snow amount"> real @@ -3675,11 +3706,11 @@ real + description="Specific humidity (water vapor mass mixing ratio with respect to moist air) at surface over ice"> real + description="Specific humidity (water vapor mass mixing ratio with respect to moist air) at surface over land"> real @@ -3694,19 +3725,19 @@ real + description="cumulative downwelling diffuse near-infrared shortwave flux at the surface level for coupling multiplied by the duration of the timestep"> real + description="cumulative downwelling diffuse ultraviolet and visible shortwave flux at the surface level for coupling multiplied by the duration of the timestep"> real + description="cumulative downwelling direct near-infrared shortwave flux at the surface level for coupling multiplied by the duration of the timestep"> real + description="cumulative downwelling direct ultraviolet and visible shortwave flux at the surface level for coupling multiplied by the duration of the timestep"> real @@ -3716,19 +3747,19 @@ real + description="cumulative net downwelling diffuse near-infrared shortwave flux at the surface level for coupling multiplied by the duration of the timestep"> real + description="cumulative net downwelling diffuse ultraviolet and visible shortwave flux at the surface level for coupling multiplied by the duration of the timestep"> real + description="cumulative net downwelling direct near-infrared shortwave flux at the surface level for coupling multiplied by the duration of the timestep"> real + description="cumulative net downwelling direct ultraviolet and visible shortwave flux at the surface level for coupling multiplied by the duration of the timestep"> real @@ -3756,26 +3787,26 @@ real + description="Specific humidity (water vapor mass mixing ratio with respect to moist air) at 2 meters above surface used for coupling"> real real + description="downwelling diffuse near-infrared shortwave flux at the surface level for coupling"> real + description="downwelling diffuse ultraviolet and visible shortwave flux at the surface level for coupling"> real + description="downwelling direct near-infrared shortwave flux at the surface level for coupling"> real + description="downwelling direct ultraviolet and visible shortwave flux at the surface level for coupling"> real @@ -3785,19 +3816,19 @@ real + description="net downwelling diffuse near-infrared shortwave flux at the surface level for coupling"> real + description="net downwelling diffuse ultraviolet and visible shortwave flux at the surface level for coupling"> real + description="net downwelling direct near-infrared shortwave flux at the surface level for coupling"> real + description="net_downwelling direct ultraviolet and visible shortwave flux at the surface level for coupling"> real @@ -3828,7 +3859,7 @@ real - long_name="Tendency of specific humidity (water vapor mass mixing ratio with respect to moist air) due to moist convection used for coupling"> + description="Tendency of specific humidity (water vapor mass mixing ratio with respect to moist air) due to moist convection used for coupling"> real @@ -3838,46 +3869,49 @@ real + description="Cumulative liquid water equivalent thickness of convective precipitation amount for coupling"> real + description="Cumulative liquid water equivalent thickness of precipitation amount for coupling"> real + description="Cumulative liquid water equivalent thickness of snow amount for coupling"> real real - + real - + real - + real real + description="downwelling diffuse near-infrared shortwave flux at the surface level on the radiation timestep"> real + description="downwelling diffuse ultraviolet and visible shortwave flux at the surface level on the radiation timestep"> real + description="downwelling direct near-infrared shortwave flux at the surface level on the radiation timestep"> real + description="downwelling direct ultraviolet and visible shortwave flux at the surface level on the radiation timestep"> real @@ -3890,15 +3924,15 @@ real + description="surface albedo for diffuse near-infrared radiation for coupling"> real + description="surface albedo for direct near-infrared radiation for coupling"> real + description="Liquid water equivalent surface snow from coupled process"> real @@ -3908,19 +3942,19 @@ real + description="upwelling diffuse near-infrared shortwave flux at the surface level on the radiation timestep"> real + description="upwelling diffuse ultraviolet and visible shortwave flux at the surface level on the radiation timestep"> real + description="upwelling direct near-infrared shortwave flux at the surface level on the radiation timestep"> real + description="upwelling direct ultraviolet and visible shortwave flux at the surface level on the radiation timestep"> real @@ -3930,11 +3964,11 @@ real + description="surface albedo for diffuse visible radiation for coupling"> real + description="surface albedo for direct visible radiation for coupling"> real @@ -3956,19 +3990,19 @@ real + description="Stochastic Humidity stochastic physics option scaling factors from coupled process"> real + description="Stochastic Kinetic Energy Backscatter x-wind scaling factors from coupled process"> real + description="Stochastic Kinetic Energy Backscatter y-wind scaling factors from coupled process"> real + description="Stochastically perturbed physics tendencies scaling factors from coupled process"> real @@ -3986,22 +4020,22 @@ real + description="Cloud liquid water mass mixing ratio with respect to moist air at surface-adjacent layer"> real real + description="Exner function with respect to surface pressure, (p/ps)^(Rd/cp)"> real + description="exner function (p/p0)^(Rd/cp), where p0 is 1000 hPa and p is the pressure at the surface-adjacent layer"> real + description="exner function (p/p0)^(Rd/cp), where p0 is 1000 hPa and p is the pressure at vertical layer interfaces"> real @@ -4014,7 +4048,7 @@ real + description="Graupel mass mixing ratio with respect to moist air"> real @@ -4027,7 +4061,7 @@ real + description="Ozone mass mixing ratio with respect to moist air"> real @@ -4037,7 +4071,7 @@ real + description="Snow mass mixing ratio with respect to moist air"> real @@ -4047,7 +4081,7 @@ real + description="Specific humidity (water vapor mass mixing ratio with respect to moist air) at surface-adjacent layer"> real @@ -4058,13 +4092,16 @@
- + real - + real - + real
@@ -4079,7 +4116,7 @@ sfcflw_type + description="surface albedo for diffuse shortwave radiation on the timestep for radiation physics"> real @@ -4127,11 +4164,11 @@ real + description="Latitude interpolation scaling factor complement for absolute momentum flux due to non-orographic gravity wave drag"> real + description="Latitude interpolation scaling factor for absolute momentum flux due to non-orographic gravity wave drag"> real @@ -4147,7 +4184,7 @@ integer + description="Lower latitude index of absolute momentum flux due to non-orographic gravity wave drag for interpolation"> integer @@ -4175,7 +4212,7 @@ integer + description="Upper latitude index of absolute momentum flux due to non-orographic gravity wave drag for interpolation"> integer @@ -4196,7 +4233,7 @@ real + description="Cloud liquid water mass mixing ratio with respect to moist air of new state"> real @@ -4206,7 +4243,7 @@ real + description="Graupel mass mixing ratio with respect to moist air of new state"> real @@ -4219,7 +4256,7 @@ real + description="Cloud ice mass mixing ratio with respect to moist air of new state"> real @@ -4232,14 +4269,14 @@ real + description="Rain mass mixing ratio with respect to moist air of new state"> real real + description="Snow mass mixing ratio with respect to moist air of new state"> real @@ -4249,11 +4286,11 @@ real + description="Specific humidity (water vapor mass mixing ratio with respect to moist air) of new state at surface-adjacent layer"> real + description="Specific humidity (water vapor mass mixing ratio with respect to moist air) of new state"> real diff --git a/standard_names_v1_0.xsd b/standard_names_v1_0.xsd index 5ecc4f0..b163919 100644 --- a/standard_names_v1_0.xsd +++ b/standard_names_v1_0.xsd @@ -31,7 +31,7 @@ - + @@ -53,7 +53,7 @@ - + diff --git a/tools/check_xml_unique.py b/tools/check_xml_unique.py index 20d7ce9..41488d5 100755 --- a/tools/check_xml_unique.py +++ b/tools/check_xml_unique.py @@ -34,6 +34,10 @@ def parse_command_line(args, description): type=str, help="XML file with standard name library") parser.add_argument("--overwrite", action='store_true', help="flag to remove duplicates and overwrite the file") + parser.add_argument("--field", type=str, default="name", + help="Field to check for uniqueness; default is 'name'") + parser.add_argument("--debug", action='store_true', + help="flag for additional debug print statements") pargs = parser.parse_args(args) return pargs @@ -66,8 +70,11 @@ def main_func(): #get list of all standard names all_std_names = [] for name in root.findall('./section/standard_name'): - all_std_names.append(name.attrib['name']) - + try: + all_std_names.append(name.attrib[args.field]) + except KeyError: + if (args.debug): + print(f"WARNING: no field '{args.field}' for standard name '{name.attrib['name']}' ") #get list of all unique and duplicate standard names, in source order seen = set() uniq_std_names = [] @@ -79,13 +86,12 @@ def main_func(): else: dup_std_names.append(x) - if args.overwrite: - #delete all duplicate elements after the first - if len(dup_std_names)>0: - print('The following duplicate standard names were found:') - for dup in dup_std_names: - rm_elements = root.findall('./section/standard_name[@name="%s"]'%dup)[1:] - print(f"{dup}, ({len(rm_elements)} duplicate(s))") + if len(dup_std_names)>0: + print(f'The following duplicate {args.field} entries were found:') + for dup in dup_std_names: + rm_elements = root.findall(f'./section/standard_name[@{args.field}="{dup}"]')[1:] + print(f"{dup}, ({len(rm_elements)} duplicate(s))") + if args.overwrite: print(f'Removing duplicates and overwriting {stdname_file}') for dup in dup_std_names: first_use = True #Logical that indicates the first use of the duplicated name @@ -101,17 +107,11 @@ def main_func(): #Overwrite the xml file with the new, duplicate-free element tree: tree.write(stdname_file, "utf-8") else: - print('No duplicate standard names were found.') - else: - #write out duplicate standard names - if len(dup_std_names)>0: - print('The following duplicate standard names were found:') - for dup in dup_std_names: - rm_elements = root.findall('./section/standard_name[@name="%s"]'%dup)[1:] - print(f"{dup}, ({len(rm_elements)} duplicate(s))") + # If not overwriting, exit with status 1 to indicate failure sys.exit(1) - else: - print('No duplicate standard names were found.') + else: + print(f'No duplicate {args.field}s were found.') + ############################################################################### if __name__ == "__main__": diff --git a/tools/write_standard_name_table.py b/tools/write_standard_name_table.py index 2f66d04..90754fd 100755 --- a/tools/write_standard_name_table.py +++ b/tools/write_standard_name_table.py @@ -60,58 +60,58 @@ def convert_text_to_link(text_str): return link_str ######################################################################## -def standard_name_to_long_name(prop_dict, context=None): +def standard_name_to_description(prop_dict, context=None): ######################################################################## - """Translate a standard_name to its default long_name + """Translate a standard_name to its default description Note: This code is copied from the CCPP Framework. - >>> standard_name_to_long_name({'standard_name':'cloud_optical_depth_layers_from_0p55mu_to_0p99mu'}) + >>> standard_name_to_description({'standard_name':'cloud_optical_depth_layers_from_0p55mu_to_0p99mu'}) 'Cloud optical depth layers from 0.55mu to 0.99mu' - >>> standard_name_to_long_name({'local_name':'foo'}) #doctest: +IGNORE_EXCEPTION_DETAIL + >>> standard_name_to_description({'local_name':'foo'}) #doctest: +IGNORE_EXCEPTION_DETAIL Traceback (most recent call last): - CCPPError: No standard name to convert foo to long name - >>> standard_name_to_long_name({}) #doctest: +IGNORE_EXCEPTION_DETAIL + CCPPError: No standard name to convert foo to description + >>> standard_name_to_description({}) #doctest: +IGNORE_EXCEPTION_DETAIL Traceback (most recent call last): - CCPPError: No standard name to convert to long name - >>> standard_name_to_long_name({'local_name':'foo'}, context=ParseContext(linenum=3, filename='foo.F90')) #doctest: +IGNORE_EXCEPTION_DETAIL + CCPPError: No standard name to convert to description + >>> standard_name_to_description({'local_name':'foo'}, context=ParseContext(linenum=3, filename='foo.F90')) #doctest: +IGNORE_EXCEPTION_DETAIL Traceback (most recent call last): - CCPPError: No standard name to convert foo to long name at foo.F90:3 - >>> standard_name_to_long_name({}, context=ParseContext(linenum=3, filename='foo.F90')) #doctest: +IGNORE_EXCEPTION_DETAIL + CCPPError: No standard name to convert foo to description at foo.F90:3 + >>> standard_name_to_description({}, context=ParseContext(linenum=3, filename='foo.F90')) #doctest: +IGNORE_EXCEPTION_DETAIL Traceback (most recent call last): - CCPPError: No standard name to convert to long name at foo.F90:3 + CCPPError: No standard name to convert to description at foo.F90:3 """ # We assume that standar_name has been checked for validity # Make the first char uppercase and replace each underscore with a space if 'standard_name' in prop_dict: standard_name = prop_dict['standard_name'] if standard_name: - long_name = standard_name[0].upper() + re.sub("_", " ", + description = standard_name[0].upper() + re.sub("_", " ", standard_name[1:]) else: - long_name = '' + description = '' # end if # Next, substitute a decimal point for the p in [:digit]p[:digit] - match = _REAL_SUBST_RE.match(long_name) + match = _REAL_SUBST_RE.match(description) while match is not None: - long_name = match.group(1) + '.' + match.group(2) - match = _REAL_SUBST_RE.match(long_name) + description = match.group(1) + '.' + match.group(2) + match = _REAL_SUBST_RE.match(description) # end while else: - long_name = '' + description = '' if 'local_name' in prop_dict: lname = ' {}'.format(prop_dict['local_name']) else: lname = '' # end if ctxt = context_string(context) - emsg = 'No standard name to convert{} to long name{}' + emsg = 'No standard name to convert{} to description{}' raise CCPPError(emsg.format(lname, ctxt)) # end if - return long_name + return description ############################################################################### -def parse_command_line(args, description): +def parse_command_line(args, program_description): ############################################################################### - parser = argparse.ArgumentParser(description=description, + parser = argparse.ArgumentParser(description=program_description, formatter_class=argparse.RawTextHelpFormatter) parser.add_argument("standard_name_file", @@ -165,12 +165,12 @@ def parse_section(snl, sec, level='##'): parse_section(snl, std_name, level + '#') continue stdn_name = std_name.get('name') - stdn_longname = std_name.get('long_name') - if stdn_longname is None: + stdn_description = std_name.get('description') + if stdn_description is None: sdict = {'standard_name':stdn_name} - stdn_longname = standard_name_to_long_name(sdict) + stdn_description = standard_name_to_description(sdict) # end if - snl.write("* `{}`: {}\n".format(stdn_name, stdn_longname)) + snl.write("* `{}`: {}\n".format(stdn_name, stdn_description)) # Should only be a type in the standard_name text for item in std_name: if item.tag == 'type':