Skip to content

Update Rules, update schema file, add new test to validate XML #137

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

Merged
mkavulich merged 15 commits into from
Feb 12, 2026
Merged

Update Rules, update schema file, add new test to validate XML #137

Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
0d899a8
Use xs:choice to specify that a section can either contain standard n…
mkavulich Jan 9, 2026
66b542b
Make standard name type elements optional, and specify a maximum occu…
mkavulich Jan 9, 2026
65e78c9
Make comments for standard name entries allowed; don't restrict secti…
mkavulich Jan 9, 2026
ca53e72
Update XSD file to have all "type" elements lowercase, remove double …
mkavulich Jan 18, 2026
14185d7
Update standard names, xml now fully validates!
mkavulich Jan 18, 2026
d69006d
Add new CI test to validate XML
mkavulich Jan 18, 2026
75c4da8
Test incorrect XML entry to check that CI catches badness
mkavulich Jan 18, 2026
fa7f951
Success! New test properly fails when XML does not validate.
mkavulich Jan 19, 2026
3fc2c5c
- Rename standard names schema to not include version number
mkavulich Jan 19, 2026
db4c0cf
fortran --> Fortran
mkavulich Jan 19, 2026
d5eb747
Fix formatting: code-formatted text needs two backticks, not one
mkavulich Jan 19, 2026
803e562
fix some more formatting, remove 'chemical species' and 'generic name…
mkavulich Jan 19, 2026
95a1d35
This caused a lot more trouble than I intended; reverting for now
mkavulich Jan 19, 2026
3738196
Merge remote-tracking branch 'upstream/main' into validate_xml
mkavulich Jan 31, 2026
97b1e93
Remove unnecessary python requirement from xmllint test
mkavulich Jan 31, 2026
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
21 changes: 21 additions & 0 deletions .github/workflows/pull_request_ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,27 @@ on:
- release/*

jobs:
validate-xml:
name: Use xmlllint to validate the xml file against the schema file
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: "3.x"
Copy link
Collaborator

@nusbaume nusbaume Jan 23, 2026

Choose a reason for hiding this comment

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

Is this section needed? I didn't think xmllint needed Python (but I could be wrong).

Copy link
Collaborator Author

@mkavulich mkavulich Jan 31, 2026

Choose a reason for hiding this comment

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

Removed, good catch.


- name: Install dependencies
run: |
sudo apt-get update
sudo apt-get -y install libxml2-utils

- name: Run xmllint
run: |
xmllint --schema standard_names_v1_0.xsd standard_names.xml --noout

check-unique-standard-names:
name: Check for duplicates in standard names
runs-on: ubuntu-latest
Expand Down
20 changes: 10 additions & 10 deletions Metadata-standard-names.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -344,11 +344,11 @@ Note that appending '_on_previous_timestep' to standard_names in this section yi
* `specific_heat_of_dry_air_at_constant_pressure`: Specific heat of dry air at constant pressure
* `real`: units = J kg-1 K-1
* `physics_state_due_to_dynamics`: Physics state due to dynamics
* `physics_state`: units = none
* `ddt`: units = none
* `timestep_for_physics`: Timestep for physics
* `integer`: units = s
* `total_tendency_of_physics`: Total tendency of physics
* `physics_tend`: units = none
* `ddt`: units = none
* `air_pressure_at_top_of_atmosphere_model`: Air pressure at top of atmosphere model
* `real`: units = Pa
* `air_pressure_at_sea_level`: Air pressure at sea level
Expand Down Expand Up @@ -804,7 +804,7 @@ Optional CCPP framework-provided variables
* `ccpp_scheme_name`: CCPP physics scheme name
* `character`: units = none
* `ccpp_constituent_properties`: CCPP Constituent Properties
* `ccpp_constituent_prop_ptr_t`: units = none
* `ddt`: units = none
* `ccpp_constituents`: Array of constituents managed by CCPP Framework
* `real`: units = none
* `ccpp_constituent_min_values`: CCPP constituent minimum values
Expand Down Expand Up @@ -1957,7 +1957,7 @@ Variables related to the compute environment
* `real`: units = 1
* `temperature_in_ice_layer`: Temperature in ice layer
* `real`: units = K
* `upward_flux_of_water_vapor_mixing_ratio_wrt_moist_air_at_surface`: Upward flux of water vapor mixing ratio wrt moist air at surface
* `upward_flux_of_water_vapor_mixing_ratio_wrt_moist_air_at_surface`: Upward specific humidity (water vapor mass mixing ratio with respect to moist air) flux at surface
* `real`: units = kg kg-1 m s-1
* `upward_temperature_flux_at_surface`: Upward temperature flux at surface
* `real`: units = K m s-1
Expand Down Expand Up @@ -1989,11 +1989,11 @@ Variables related to the compute environment
* `real`: units = fraction
* `nir_albedo_strong_cosz`: albedo for near-infrared radiation with strong dependence on cosine of the zenith angle
* `real`: units = fraction
* `nir_albedo_weak_cosz`: Nir albedo weak cosz
* `nir_albedo_weak_cosz`: albedo for near-infrared radiation with weak dependence on cosine of the zenith angle
* `real`: units = fraction
* `vis_albedo_strong_cosz`: Vis albedo strong cosz
* `vis_albedo_strong_cosz`: albedo for visible radiation with strong dependence on cosine of the zenith angle
* `real`: units = fraction
* `vis_albedo_weak_cosz`: Vis albedo weak cosz
* `vis_albedo_weak_cosz`: albedo for visible radiation with weak dependence on cosine of the zenith angle
* `real`: units = fraction
* `min_vegetation_area_fraction`: Min vegetation area fraction
* `real`: units = fraction
Expand Down Expand Up @@ -2292,7 +2292,7 @@ Variables related to the compute environment
* `real`: units = Pa
* `temperature_at_2m_for_coupling`: Temperature at 2m for coupling
* `real`: units = K
* `tendency_of_water_vapor_mixing_ratio_wrt_moist_air_due_to_moist_convection_for_coupling`: Tendency of water vapor mixing ratio wrt moist air due to moist convection for coupling
* `tendency_of_water_vapor_mixing_ratio_wrt_moist_air_due_to_moist_convection_for_coupling`: Tendency of specific humidity (water vapor mass mixing ratio with respect to moist air) due to moist convection used for coupling
* `real`: units = kg kg-1 s-1
* `x_wind_at_10m_for_coupling`: X wind at 10m for coupling
* `real`: units = m s-1
Expand Down Expand Up @@ -2438,15 +2438,15 @@ Variables related to the compute environment
* `cosine_of_solar_zenith_angle_on_radiation_timestep`: Cosine of solar zenith angle on radiation timestep
* `real`: units = 1
* `surface_lw_fluxes_assuming_total_and_clear_sky_on_radiation_timestep`: Surface lw fluxes assuming total and clear sky on radiation timestep
* `sfcflw_type`: units = W m-2
* `ddt`: units = W m-2
* `diffuse_shortwave_albedo_on_radiation_timestep`: surface albedo for diffuse shortwave radiation on the timestep for radiation physics
* `real`: units = fraction
* `surface_longwave_emissivity`: Surface longwave emissivity
* `real`: units = fraction
* `air_temperature_at_surface_adjacent_layer_on_radiation_timestep`: Air temperature at surface adjacent layer on radiation timestep
* `real`: units = K
* `surface_sw_fluxes_assuming_total_and_clear_sky_on_radiation_timestep`: Surface sw fluxes assuming total and clear sky on radiation timestep
* `sfcfsw_type`: units = W m-2
* `ddt`: units = W m-2
* `tendency_of_air_temperature_due_to_longwave_heating_assuming_clear_sky_on_radiation_timestep`: Tendency of air temperature due to longwave heating assuming clear sky on radiation timestep
* `real`: units = K s-1
* `tendency_of_air_temperature_due_to_integrated_dynamics_through_earths_atmosphere`: Tendency of air temperature due to integrated dynamics through earths atmosphere
Expand Down
26 changes: 15 additions & 11 deletions Metadata-standard-names.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -752,7 +752,7 @@ section:
units: J kg-1 K-1
- name: physics_state_due_to_dynamics
description: Physics state due to dynamics
type: physics_state
type: ddt
kind: null
units: none
- name: timestep_for_physics
Expand All @@ -762,7 +762,7 @@ section:
units: s
- name: total_tendency_of_physics
description: Total tendency of physics
type: physics_tend
type: ddt
kind: null
units: none
- name: air_pressure_at_top_of_atmosphere_model
Expand Down Expand Up @@ -1953,7 +1953,7 @@ section:
units: none
- name: ccpp_constituent_properties
description: CCPP Constituent Properties
type: ccpp_constituent_prop_ptr_t
type: ddt
kind: null
units: none
- name: ccpp_constituents
Expand Down Expand Up @@ -4975,7 +4975,8 @@ section:
kind: null
units: K
- name: upward_flux_of_water_vapor_mixing_ratio_wrt_moist_air_at_surface
description: Upward flux of water vapor mixing ratio wrt moist air at surface
description: Upward specific humidity (water vapor mass mixing ratio with respect
to moist air) flux at surface
type: real
kind: null
units: kg kg-1 m s-1
Expand Down Expand Up @@ -5059,17 +5060,20 @@ section:
kind: null
units: fraction
- name: nir_albedo_weak_cosz
description: Nir albedo weak cosz
description: albedo for near-infrared radiation with weak dependence on cosine
of the zenith angle
type: real
kind: null
units: fraction
- name: vis_albedo_strong_cosz
description: Vis albedo strong cosz
description: albedo for visible radiation with strong dependence on cosine of
the zenith angle
type: real
kind: null
units: fraction
- name: vis_albedo_weak_cosz
description: Vis albedo weak cosz
description: albedo for visible radiation with weak dependence on cosine of the
zenith angle
type: real
kind: null
units: fraction
Expand Down Expand Up @@ -5855,8 +5859,8 @@ section:
kind: null
units: K
- name: tendency_of_water_vapor_mixing_ratio_wrt_moist_air_due_to_moist_convection_for_coupling
description: Tendency of water vapor mixing ratio wrt moist air due to moist convection
for coupling
description: Tendency of specific humidity (water vapor mass mixing ratio with
respect to moist air) due to moist convection used for coupling
type: real
kind: null
units: kg kg-1 s-1
Expand Down Expand Up @@ -6247,7 +6251,7 @@ section:
units: 1
- name: surface_lw_fluxes_assuming_total_and_clear_sky_on_radiation_timestep
description: Surface lw fluxes assuming total and clear sky on radiation timestep
type: sfcflw_type
type: ddt
kind: null
units: W m-2
- name: diffuse_shortwave_albedo_on_radiation_timestep
Expand All @@ -6268,7 +6272,7 @@ section:
units: K
- name: surface_sw_fluxes_assuming_total_and_clear_sky_on_radiation_timestep
description: Surface sw fluxes assuming total and clear sky on radiation timestep
type: sfcfsw_type
type: ddt
kind: null
units: W m-2
- name: tendency_of_air_temperature_due_to_longwave_heating_assuming_clear_sky_on_radiation_timestep
Expand Down
Loading