Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Standard Name Rules table for dimensionless units, change variables improperly using "1" to "fraction" #62

Merged
merged 9 commits into from
Apr 16, 2024
Merged

Update Standard Name Rules table for dimensionless units, change variables improperly using "1" to "fraction" #62

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
22861e7
Add entry for "frac", separate from "percent"
mkavulich Mar 19, 2024
85b157e
A bit more detail in unitless table
mkavulich Mar 19, 2024
fc87b14
Converting fractions from units "1" to "frac"
mkavulich Mar 19, 2024
b01a282
Return table header to previous state
mkavulich Mar 20, 2024
a922353
Move "1" to the bottom, as it is a catch-all for numerical cases not …
mkavulich Mar 20, 2024
6a1cf44
RST tables are SO annoying 😖
mkavulich Mar 20, 2024
213645b
Forgot to update markdown file
mkavulich Mar 20, 2024
c9cf0e6
Per PR discussion, updating all instances of "frac" to "fraction"
mkavulich Apr 15, 2024
65281ad
Update units for chemical_tracer_scavenging_fractions to "fraction"
mkavulich Apr 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions Metadata-standard-names.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,9 +253,9 @@ Note that appending '_on_previous_timestep' to standard_names in this section yi
* `mass_content_of_cloud_liquid_water_in_atmosphere_layer`: Mass content of cloud liquid water in atmosphere layer
* `real(kind=kind_phys)`: units = kg m-2
* `nonconvective_cloud_area_fraction_in_atmosphere_layer`: cloud area fraction in atmosphere layer excluding clouds produced by the convective schemes
* `real(kind=kind_phys)`: units = 1
* `real(kind=kind_phys)`: units = frac
* `relative_humidity`: Relative humidity
* `real(kind=kind_phys)`: units = 1
* `real(kind=kind_phys)`: units = frac
* `gravitational_acceleration`: Gravitational acceleration
* `real(kind=kind_phys)`: units = m s-2
## diagnostics
Expand Down Expand Up @@ -517,7 +517,7 @@ Variables related to the compute environment
* `do_unified_gravity_wave_physics_gravity_wave_drag_scheme`: Do unified gravity wave physics gravity wave drag scheme
* `logical(kind=)`: units = flag
* `downdraft_area_fraction_in_scale_aware_tke_moist_edmf_pbl_scheme`: Downdraft area fraction in scale aware tke moist edmf pbl scheme
* `real(kind=kind_phys)`: units = 1
* `real(kind=kind_phys)`: units = frac
* `downdraft_fraction_reaching_surface_over_land_for_deep_convection`: Downdraft fraction reaching surface over land for deep convection
* `real(kind=kind_phys)`: units = frac
* `downdraft_fraction_reaching_surface_over_water_for_deep_convection`: Downdraft fraction reaching surface over water for deep convection
Expand All @@ -541,7 +541,7 @@ Variables related to the compute environment
* `equation_of_time`: Equation of time
* `real(kind=kind_phys)`: units = radian
* `relative_humidity_threshold_for_condensation`: Relative humidity threshold for condensation
* `real(kind=kind_phys)`: units = 1
* `real(kind=kind_phys)`: units = frac
* `do_arakawa_wu_downdrafts_for_deep_convection`: Do arakawa wu downdrafts for deep convection
* `logical(kind=)`: units = flag
* `do_debug_output`: Do debug output
Expand Down Expand Up @@ -1055,7 +1055,7 @@ Variables related to the compute environment
* `minimum_cloud_ice_mixing_ratio_wrt_moist_air_threshold`: Minimum cloud ice mixing ratio wrt moist air threshold
* `real(kind=kind_phys)`: units = kg kg-1
* `relative_humidity_threshold_for_ice_nucleation`: Relative humidity threshold for ice nucleation
* `real(kind=kind_phys)`: units = 1
* `real(kind=kind_phys)`: units = frac
* `timescale_for_autoconversion_to_snow`: Timescale for autoconversion to snow
* `real(kind=kind_phys)`: units = s
* `alpha_tuning_coefficient_for_morrison_gettelman_microphysics_scheme`: Alpha tuning coefficient for morrison gettelman microphysics scheme
Expand Down Expand Up @@ -1265,7 +1265,7 @@ Variables related to the compute environment
* `do_turbulent_orographic_form_drag_in_unified_gravity_wave_physics_gravitiy_wave_drag_scheme`: Do turbulent orographic form drag in unified gravity wave physics gravitiy wave drag scheme
* `logical(kind=)`: units = flag
* `updraft_area_fraction_in_scale_aware_tke_moist_edmf_pbl_scheme`: Updraft area fraction in scale aware tke moist edmf pbl scheme
* `real(kind=kind_phys)`: units = 1
* `real(kind=kind_phys)`: units = frac
* `tunable_parameter_1_for_maximum_cloud_base_updraft_velocity_in_chikira_sugiyama_deep_convection`: Tunable parameter 1 for maximum cloud base updraft velocity in chikira sugiyama deep convection
* `real(kind=kind_phys)`: units = m s-1
* `tunable_parameter_2_for_maximum_cloud_base_updraft_velocity_in_chikira_sugiyama_deep_convection`: Tunable parameter 2 for maximum cloud base updraft velocity in chikira sugiyama deep convection
Expand Down Expand Up @@ -1458,7 +1458,7 @@ Variables related to the compute environment
* `real(kind=kind_phys)`: units = 1
## GFS_typedefs_GFS_sfcprop_type
* `wet_canopy_area_fraction`: Wet canopy area fraction
* `real(kind=kind_phys)`: units = 1
* `real(kind=kind_phys)`: units = frac
* `baseline_surface_longwave_emissivity`: Baseline surface longwave emissivity
* `real(kind=kind_phys)`: units = frac
* `baseline_surface_roughness_length`: Baseline surface roughness length
Expand Down
44 changes: 23 additions & 21 deletions StandardNamesRules.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -569,24 +569,26 @@ Units

#. For dimensionless variables, the following units can be used:

+------------------------+-------------------------------------------------------------------------------------+
| **Unit** | **Use case** |
+========================+=====================================================================================+
| count | integers that describe the dimension/length of an array |
+------------------------+-------------------------------------------------------------------------------------+
| flag | logicals/booleans that can be either true or false |
+------------------------+-------------------------------------------------------------------------------------+
| index | integers that can be an index in an array |
+------------------------+-------------------------------------------------------------------------------------+
| kg kg-1 | mass mixing ratios |
+------------------------+-------------------------------------------------------------------------------------+
| m3 m-3 | volume fraction (e.g. for soil moisture) |
+------------------------+-------------------------------------------------------------------------------------+
| mol mol-1 | molar mixing ratios (also volumetric mixing ratio for gases) |
+------------------------+-------------------------------------------------------------------------------------+
| none | strings and character arrays |
+------------------------+-------------------------------------------------------------------------------------+
| 1 | any number (integer, real, complex), e.g. fractions, scaling factors, ... |
+------------------------+-------------------------------------------------------------------------------------+
| percent | fractions etc. expressed in percent, ranging from 0 to 100% |
+------------------------+-------------------------------------------------------------------------------------+
+------------------------+-----------------------------------------------------------------------------------------------+
| **Unit** | **Use case** |
+========================+===============================================================================================+
| count | integers that describe the dimension/length of an array |
+------------------------+-----------------------------------------------------------------------------------------------+
| flag | logicals/booleans that can be either true or false |
+------------------------+-----------------------------------------------------------------------------------------------+
| index | integers that can be an index in an array |
+------------------------+-----------------------------------------------------------------------------------------------+
| kg kg-1 | mass mixing ratios |
+------------------------+-----------------------------------------------------------------------------------------------+
| m3 m-3 | volume fraction (e.g. for soil moisture) |
+------------------------+-----------------------------------------------------------------------------------------------+
| mol mol-1 | molar mixing ratios (also volumetric mixing ratio for gases) |
+------------------------+-----------------------------------------------------------------------------------------------+
| none | strings and character arrays |
+------------------------+-----------------------------------------------------------------------------------------------+
| frac | fractions not listed above, typically valid in the range [0,1] |
+------------------------+-----------------------------------------------------------------------------------------------+
| percent | fractions expressed in percent, typically ranging from 0% to 100% |
+------------------------+-----------------------------------------------------------------------------------------------+
| 1 | any number (integer, real, complex) not listed above, e.g. scaling factors, error codes, etc. |
+------------------------+-----------------------------------------------------------------------------------------------+
14 changes: 7 additions & 7 deletions standard_names.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -409,10 +409,10 @@
<standard_name
name="nonconvective_cloud_area_fraction_in_atmosphere_layer"
long_name="cloud area fraction in atmosphere layer excluding clouds produced by the convective schemes">
<type kind="kind_phys" units="1">real</type>
<type kind="kind_phys" units="frac">real</type>
</standard_name>
<standard_name name="relative_humidity">
<type kind="kind_phys" units="1">real</type>
<type kind="kind_phys" units="frac">real</type>
</standard_name>
<standard_name name="gravitational_acceleration">
<type kind="kind_phys" units="m s-2">real</type>
Expand Down Expand Up @@ -863,7 +863,7 @@
<type kind="" units="flag">logical</type>
</standard_name>
<standard_name name="downdraft_area_fraction_in_scale_aware_tke_moist_edmf_pbl_scheme">
<type kind="kind_phys" units="1">real</type>
<type kind="kind_phys" units="frac">real</type>
</standard_name>
<standard_name name="downdraft_fraction_reaching_surface_over_land_for_deep_convection">
<type kind="kind_phys" units="frac">real</type>
Expand Down Expand Up @@ -899,7 +899,7 @@
<type kind="kind_phys" units="radian">real</type>
</standard_name>
<standard_name name="relative_humidity_threshold_for_condensation">
<type kind="kind_phys" units="1">real</type>
<type kind="kind_phys" units="frac">real</type>
</standard_name>
<standard_name name="do_arakawa_wu_downdrafts_for_deep_convection">
<type kind="" units="flag">logical</type>
Expand Down Expand Up @@ -1670,7 +1670,7 @@
<type kind="kind_phys" units="kg kg-1">real</type>
</standard_name>
<standard_name name="relative_humidity_threshold_for_ice_nucleation">
<type kind="kind_phys" units="1">real</type>
<type kind="kind_phys" units="frac">real</type>
</standard_name>
<standard_name name="timescale_for_autoconversion_to_snow">
<type kind="kind_phys" units="s">real</type>
Expand Down Expand Up @@ -1985,7 +1985,7 @@
<type kind="" units="flag">logical</type>
</standard_name>
<standard_name name="updraft_area_fraction_in_scale_aware_tke_moist_edmf_pbl_scheme">
<type kind="kind_phys" units="1">real</type>
<type kind="kind_phys" units="frac">real</type>
</standard_name>
<standard_name name="tunable_parameter_1_for_maximum_cloud_base_updraft_velocity_in_chikira_sugiyama_deep_convection">
<type kind="kind_phys" units="m s-1">real</type>
Expand Down Expand Up @@ -2276,7 +2276,7 @@
</section>
<section name="GFS_typedefs_GFS_sfcprop_type">
<standard_name name="wet_canopy_area_fraction">
<type kind="kind_phys" units="1">real</type>
<type kind="kind_phys" units="frac">real</type>
</standard_name>
<standard_name name="baseline_surface_longwave_emissivity">
<type kind="kind_phys" units="frac">real</type>
Expand Down
Loading