Skip to content

Adding standard names for chemical number densities, new rules about naming chemical species #125

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Adding standard names for chemical number densities, new rules about naming chemical species #125

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
68ff5c7
Add proposed number density standard names from Issue 112
mkavulich Sep 24, 2025
a1e2502
First attempt at chemical naming rules
mkavulich Sep 25, 2025
467a44f
Some better wording and more examples for chemical rules
mkavulich Sep 25, 2025
d2d52c6
Merge branch 'main' into feature/number_density
mkavulich Oct 22, 2025
d001558
Meant standard name, not long name here
mkavulich Oct 22, 2025
5d5b779
Move charge number to prefix
mkavulich Nov 5, 2025
c8d988b
Merge remote-tracking branch 'upstream/main' into feature/number_density
mkavulich Nov 5, 2025
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
40 changes: 40 additions & 0 deletions Metadata-standard-names.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,6 +407,46 @@ 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_so2`: Sulfur dioxide volume mixing ratio
* `real(kind=kind_phys)`: units = mol mol-1
* `number_density_of_n`: Number density of neutral atomic nitrogen (N) in air
* `real(kind=kind_phys)`: units = m-3
* `number_density_of_n_from_climatology`: Climatological number density of atomic nitrogen (N), e.g., from MSIS
* `real(kind=kind_phys)`: units = m-3
* `number_density_of_n2`: Number density of molecular nitrogen (N2) in air
* `real(kind=kind_phys)`: units = m-3
* `number_density_of_n2_from_climatology`: Climatological number density molecular nitrogen (N2), e.g., from MSIS
* `real(kind=kind_phys)`: units = m-3
* `number_density_of_o`: Number density of neutral atomic oxygen (O) in air
* `real(kind=kind_phys)`: units = m-3
* `number_density_of_o_from_climatology`: Climatological number density of atomic oxygen (O), e.g., from MSIS
* `real(kind=kind_phys)`: units = m-3
* `number_density_of_o2`: Number density of molecular oxygen (O2) in air
* `real(kind=kind_phys)`: units = m-3
* `number_density_of_o2_from_climatology`: Climatological number density molecular oxygen (O2), e.g., from MSIS
* `real(kind=kind_phys)`: units = m-3
* `number_density_of_no`: Number density of nitric oxide (NO) in air
* `real(kind=kind_phys)`: units = m-3
* `number_density_of_no_from_climatology`: Climatological number density of nitric oxide (NO), e.g., from MSIS
* `real(kind=kind_phys)`: units = m-3
* `number_density_of_ar`: Number density of argon (Ar) in air
* `real(kind=kind_phys)`: units = m-3
* `number_density_of_ar_from_climatology`: Climatological number density of argon (Ar), e.g., from MSIS
* `real(kind=kind_phys)`: units = m-3
* `number_density_of_he`: Number density of helium (He) in air
* `real(kind=kind_phys)`: units = m-3
* `number_density_of_he_from_climatology`: Climatological number density of helium (He), e.g., from MSIS
* `real(kind=kind_phys)`: units = m-3
* `number_density_of_h`: Number density of neutral atomic hydrogen (H) in air
* `real(kind=kind_phys)`: units = m-3
* `number_density_of_h_from_climatology`: Climatological number density of atomic hydrogen (H), e.g., from MSIS
* `real(kind=kind_phys)`: units = m-3
* `number_density_of_anomalous_oxygen`: Number density of energetic, non-thermal atomic oxygen as defined in MSIS
* `real(kind=kind_phys)`: units = m-3
* `number_density_of_anomalous_oxygen_from_climatology`: Climatological number density of anomalous energetic oxygen, e.g., from MSIS
* `real(kind=kind_phys)`: units = m-3
* `number_density_of_neutral_air`: Total number density of neutral air, including all neutral constituents
* `real(kind=kind_phys)`: units = m-3
* `number_density_of_neutral_air_from_climatology`: Climatological total number density of neutral air, e.g., from MSIS
* `real(kind=kind_phys)`: units = m-3
## atmospheric_composition: GOCART aerosols
* `mass_fraction_of_dust001_in_air`: Dust bin1 mass fraction
* `real(kind=kind_phys)`: units = kg kg-1
Expand Down
102 changes: 102 additions & 0 deletions Metadata-standard-names.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -950,6 +950,108 @@ sections:
type: real
kind: kind_phys
units: mol mol-1
- name: number_density_of_n
long_name: Number density of neutral atomic nitrogen (N) in air
type: real
kind: kind_phys
units: m-3
- name: number_density_of_n_from_climatology
long_name: Climatological number density of atomic nitrogen (N), e.g., from MSIS
type: real
kind: kind_phys
units: m-3
- name: number_density_of_n2
long_name: Number density of molecular nitrogen (N2) in air
type: real
kind: kind_phys
units: m-3
- name: number_density_of_n2_from_climatology
long_name: Climatological number density molecular nitrogen (N2), e.g., from MSIS
type: real
kind: kind_phys
units: m-3
- name: number_density_of_o
long_name: Number density of neutral atomic oxygen (O) in air
type: real
kind: kind_phys
units: m-3
- name: number_density_of_o_from_climatology
long_name: Climatological number density of atomic oxygen (O), e.g., from MSIS
type: real
kind: kind_phys
units: m-3
- name: number_density_of_o2
long_name: Number density of molecular oxygen (O2) in air
type: real
kind: kind_phys
units: m-3
- name: number_density_of_o2_from_climatology
long_name: Climatological number density molecular oxygen (O2), e.g., from MSIS
type: real
kind: kind_phys
units: m-3
- name: number_density_of_no
long_name: Number density of nitric oxide (NO) in air
type: real
kind: kind_phys
units: m-3
- name: number_density_of_no_from_climatology
long_name: Climatological number density of nitric oxide (NO), e.g., from MSIS
type: real
kind: kind_phys
units: m-3
- name: number_density_of_ar
long_name: Number density of argon (Ar) in air
type: real
kind: kind_phys
units: m-3
- name: number_density_of_ar_from_climatology
long_name: Climatological number density of argon (Ar), e.g., from MSIS
type: real
kind: kind_phys
units: m-3
- name: number_density_of_he
long_name: Number density of helium (He) in air
type: real
kind: kind_phys
units: m-3
- name: number_density_of_he_from_climatology
long_name: Climatological number density of helium (He), e.g., from MSIS
type: real
kind: kind_phys
units: m-3
- name: number_density_of_h
long_name: Number density of neutral atomic hydrogen (H) in air
type: real
kind: kind_phys
units: m-3
- name: number_density_of_h_from_climatology
long_name: Climatological number density of atomic hydrogen (H), e.g., from MSIS
type: real
kind: kind_phys
units: m-3
- name: number_density_of_anomalous_oxygen
long_name: Number density of energetic, non-thermal atomic oxygen as defined in
MSIS
type: real
kind: kind_phys
units: m-3
- name: number_density_of_anomalous_oxygen_from_climatology
long_name: Climatological number density of anomalous energetic oxygen, e.g.,
from MSIS
type: real
kind: kind_phys
units: m-3
- name: number_density_of_neutral_air
long_name: Total number density of neutral air, including all neutral constituents
type: real
kind: kind_phys
units: m-3
- name: number_density_of_neutral_air_from_climatology
long_name: Climatological total number density of neutral air, e.g., from MSIS
type: real
kind: kind_phys
units: m-3
- name: 'atmospheric_composition: GOCART aerosols'
comment: null
standard_names:
Expand Down
12 changes: 12 additions & 0 deletions StandardNamesRules.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,18 @@ ESM Standard Name Rules
aliases is below. Whenever such an alias exist, use the alias in the
standard name and the full term in the long name.

#. Chemical species in standard names should be denoted by chemical formulae (e.g. ``co2``,
``ch4``, ``c5h8``) or commonly accepted designations (e.g. ``cfc12``); generally when there are
multiple options the shorter name is preferred. A few species with well-established and
unambiguous common names (e.g. water, ozone) are also included. In all cases, the long name
should include specific details about the substance's chemical makeup, as well as the
phase/state of matter if relevant; e.g. ``water_vapor``, ``liquid_h2so4``
Copy link
Collaborator

@gold2718 gold2718 Oct 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this sentence, are water_vapor and liquid_h2so4 supposed to be standard name examples or long name examples? The context leads me to think they are for standard names but in long names, we do not usually use underscores.

Copy link
Collaborator Author

@mkavulich mkavulich Oct 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gold2718 Thanks for catching this, I did mean the standard name not long name here.


#. If the ionization of the chemical species is relevant, "ionized" should be included in the standard
name as a prefix to the substance; e.g. ``number_density_of_ionized_he`` for ionized helium. If
relevant, the net ionization charge should be included as a suffix (in words, because +/- are
not valid standard name characters); e.g. ``number_density_of_ionized_he_plus_1``

#. 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
should be Fortran logicals.
Expand Down
80 changes: 80 additions & 0 deletions standard_names.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -700,6 +700,86 @@
long_name="Sulfur dioxide volume mixing ratio">
<type kind="kind_phys" units="mol mol-1">real</type>
</standard_name>
<standard_name name="number_density_of_n"
long_name="Number density of neutral atomic nitrogen (N) in air">
<type kind="kind_phys" units="m-3">real</type>
</standard_name>
<standard_name name="number_density_of_n_from_climatology"
long_name="Climatological number density of atomic nitrogen (N), e.g., from MSIS">
<type kind="kind_phys" units="m-3">real</type>
</standard_name>
<standard_name name="number_density_of_n2"
long_name="Number density of molecular nitrogen (N2) in air">
<type kind="kind_phys" units="m-3">real</type>
</standard_name>
<standard_name name="number_density_of_n2_from_climatology"
long_name="Climatological number density molecular nitrogen (N2), e.g., from MSIS">
<type kind="kind_phys" units="m-3">real</type>
</standard_name>
<standard_name name="number_density_of_o"
long_name="Number density of neutral atomic oxygen (O) in air">
<type kind="kind_phys" units="m-3">real</type>
</standard_name>
<standard_name name="number_density_of_o_from_climatology"
long_name="Climatological number density of atomic oxygen (O), e.g., from MSIS">
<type kind="kind_phys" units="m-3">real</type>
</standard_name>
<standard_name name="number_density_of_o2"
long_name="Number density of molecular oxygen (O2) in air">
<type kind="kind_phys" units="m-3">real</type>
</standard_name>
<standard_name name="number_density_of_o2_from_climatology"
long_name="Climatological number density molecular oxygen (O2), e.g., from MSIS">
<type kind="kind_phys" units="m-3">real</type>
</standard_name>
<standard_name name="number_density_of_no"
long_name="Number density of nitric oxide (NO) in air">
<type kind="kind_phys" units="m-3">real</type>
</standard_name>
<standard_name name="number_density_of_no_from_climatology"
long_name="Climatological number density of nitric oxide (NO), e.g., from MSIS">
<type kind="kind_phys" units="m-3">real</type>
</standard_name>
<standard_name name="number_density_of_ar"
long_name="Number density of argon (Ar) in air">
<type kind="kind_phys" units="m-3">real</type>
</standard_name>
<standard_name name="number_density_of_ar_from_climatology"
long_name="Climatological number density of argon (Ar), e.g., from MSIS">
<type kind="kind_phys" units="m-3">real</type>
</standard_name>
<standard_name name="number_density_of_he"
long_name="Number density of helium (He) in air">
<type kind="kind_phys" units="m-3">real</type>
</standard_name>
<standard_name name="number_density_of_he_from_climatology"
long_name="Climatological number density of helium (He), e.g., from MSIS">
<type kind="kind_phys" units="m-3">real</type>
</standard_name>
<standard_name name="number_density_of_h"
long_name="Number density of neutral atomic hydrogen (H) in air">
<type kind="kind_phys" units="m-3">real</type>
</standard_name>
<standard_name name="number_density_of_h_from_climatology"
long_name="Climatological number density of atomic hydrogen (H), e.g., from MSIS">
<type kind="kind_phys" units="m-3">real</type>
</standard_name>
<standard_name name="number_density_of_anomalous_oxygen"
long_name="Number density of energetic, non-thermal atomic oxygen as defined in MSIS">
<type kind="kind_phys" units="m-3">real</type>
</standard_name>
<standard_name name="number_density_of_anomalous_oxygen_from_climatology"
long_name="Climatological number density of anomalous energetic oxygen, e.g., from MSIS">
<type kind="kind_phys" units="m-3">real</type>
</standard_name>
<standard_name name="number_density_of_neutral_air"
long_name="Total number density of neutral air, including all neutral constituents">
<type kind="kind_phys" units="m-3">real</type>
</standard_name>
<standard_name name="number_density_of_neutral_air_from_climatology"
long_name="Climatological total number density of neutral air, e.g., from MSIS">
<type kind="kind_phys" units="m-3">real</type>
</standard_name>
</section>
<section name="atmospheric_composition: GOCART aerosols">
<standard_name name="mass_fraction_of_dust001_in_air"
Expand Down