CSN Basic Rules

Basic Rules

• This section provides some basic rules but many additional rules and naming patterns are given in other sections as explained below.
  
  

• Every standard name has an object part that describes a particular object and a quantity part that describes a particular attribute of that object that can be quantified with a number. Numerous templates, patterns and rules for constructing object names and quantity names are provided on the CSDMS Quantity Templates and CSDMS Object Templates pages. Quantity names are sometimes constructed using one of the CSDMS Process Names.
  
  

• A standard name may have an optional operation prefix that ends with "_of". See the CSDMS Operation Templates page for more information.
  
  

• Standard names consist of lower-case letters and digits. They contain no blank spaces. Underscores are the only non-alphanumeric character that is allowed in a standard name. All hyphens are converted to underscores.
  
  

• A single underscore is used between separate words in either object names or quantity names. A double underscore is used between the object part and the quantity part of the name. (But this rule has not yet been used in the examples.)
  
  

• There are several short reserved words such as of, in, on (or and?), at and to. These are used within patterns that deal with various issues as described in the CSDMS Object Templates, CSDMS Quantity Templates and CSDMS Operation Templates.
  
  

• Many CSDMS Standard Names contain a person's last name. If the last name ends with the letter "s" — as in Burgers, Gibbs, Jones, Reynolds, Shields and Stokes — then it is retained. However, a possessive "s" is never added to the name, so we would use "newton" vs. "newtons" in a standard name.
  
  

• Approved acronyms may be included in standard names, but they are usually spelled out explicitly as in "counterclockwise" instead of "ccw". Standard symbols for the chemical elements (but lower-case, like "h" and "c") can be used in naming quantities like "bond_angle" that involve multiple atoms in a molecule. See Attributes of Molecules on the CSDMS Quantity Templates page. Other possible acronyms are: stp = standard temperature and pressure, toa = top of atmosphere (used in CF). The acronym "wrt" = "with respect to" is used in some operation templates.
  
  

• As explained at the top of the CSDMS Process Names page, the "ing" ending on process names such as "shearing" and "melting" is often dropped for quantities like "shear_stress" and "melt_rate" that use the Process_name + Quantity Pattern. However, the "ing" ending may be retained when the same word is used in a quantity like "melting_point_temperature" (vs. "melt_temperature").
  
  

• The rightmost word in an object name is the "base object" to which the quantity applies. If the rightmost word in a quantity name is a quantity suffix, then the base quantity is the last two words in the quantity name. Otherwise, the base quantity is the last word.
  
  

• In general, the words in an object name or quantity name are ordered left to right from the general to the specific. Removing words from the left will often then result in another valid object or quantity. For example, "conductivity" => "hydraulic_conductivity" => "saturated_hydraulic_conductivity" => "effective_saturated_hydraulic_conductivity".
  
  

• Some cases will most likely require new rules to avoid ambiguity. For example, should we use:

channel_bed_shear_stress
channel_bed_water_shear_stress
channel_water_at_bed_shear_stress or
channel_water_bed_shear_stress

Similarly, should we use:

axial_tilt_angle or axis_tilt_angle ?
channel_water_flow_speed or channel_water_speed ?
forest_area_fraction or forested_area_fraction ?