Adding standard names for chemical number densities, new rules about naming chemical species #125
Conversation
mkavulich
requested review from
cacraigucar,
climbfuji,
dustinswales,
gold2718,
grantfirl,
mattldawson,
mwaxmonsky,
nusbaume,
peverwhee,
ss421 and
svahl991
as code owners
|
@cabarton @areinecke FYI - please look at the StandardNamesRules.rst and standard_names.xml only, the yaml and md files are auto-generated from the xml file. |
|
Seems reasonable to me. Do we need to have ion species and electrons added to the standard names list as well? |
|
@jeromebarre You have asked to review chemistry-related changes in the past; what do you think about these proposed chemical naming rules? |
StandardNamesRules.rst
Outdated
| 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`` |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
@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`` |
There was a problem hiding this comment.
Looking at this provided standard name I worry if this particular naming rule could lead to ambiguous variable names. For example if I saw the standard name number_density_of_ionized_he_plus_1 I would not be sure if it means the charge is +1, or if this is the number density of ionized helium added to the literal number one. Would it be better to add the plus_1 before the word ionized? For example:
| not valid standard name characters); e.g. ``number_density_of_ionized_he_plus_1`` | |
| not valid standard name characters); e.g. ``number_density_of_plus_1_ionized_he`` |
5 participants
Description
This PR adds standard names for the number density of specific chemicals and their climatological values. These names are derived from discussion on Issue #112.
This also includes new rules regarding the naming of chemical species in standard names. These are my attempt at a draft of these rules and I welcome any feedback, corrections, or suggested changes, especially from anyone with more knowledge of atmospheric/geochemistry.
Issues
Resolves #112