Changes between Initial Version and Version 1 of Ticket #910


Ignore:
Timestamp:
02/27/22 22:05:32 (3 years ago)
Author:
arango
Comment:

Legend:

Unmodified
Added
Removed
Modified

  • Ticket #910

    • Property Resolution → Done
    • Property Status new → closed

  • Ticket #910 – Description

    initial v1  
    11This update is a modernization of the ROMS metadata structure. The files **varinfo.dat** and **coupling_*.dat** are deprecated and replaced with **YAML** files **varinfo.yaml** and **coupling_*.yaml**, respectively.  The **YAML** files are simple, easy to follow, elegant, portable, and expandable.
    22
    3 As a transition, the new metadata design still works with the old **varinfo.dat**. However, if you update to the latest version of ROMS, which now starts at version **4.1**, I strongly recommend updating your application **roms.in** to use a **varinfo.yaml** instead:
     3As a transition, the new metadata design still works with the old **varinfo.dat**. However, if you update to the latest version of ROMS, which now starts at **4.1**, I strongly recommend updating your application **roms.in** to use a **varinfo.yaml** instead:
    44
    55 {{{
    … …  
    4141
    4242The **field attribute** in output NetCDF files can be used for creating labels during post-processing for plotting, visualization, and so on. It can be in any language represented by the 255 ASCII sets of characters, letters, symbols, and signs).
     43
     44Notice that an **alias** and **anchor** are added to the processing of surface shortwave radiation in **varinfo.yaml**:
     45 {{{
     46#  The surface shortwave radiation flux is handled with a YAML "alias"
     47#  and "anchor" to facilitate instantaneous or daily-averaged values. If
     48#  daily-averaged values, you need to activate the DIURNAL_SRFLUX option
     49#  in ROMS to modulate the shortwave radiation by the local daily cycle
     50#  at each timestep.
     51
     52#shortwave:     &SWRAD swrad_daily
     53shortwave:      &SWRAD swrad
     54
     55metadata:
     56
     57# ...
     58
     59  - variable:       *SWRAD                                           # Input/Output
     60    standard_name:  net_downward_shortwave_flux_at_sea_water_surface
     61    long_name:      solar shortwave radiation flux
     62    units:          watt meter-2                                     # Input:  [Watt/m2]
     63    field:          shortwave radiation                              # [Celsius m/s]
     64    time:           srf_time                                         # Output: [Watt/m2]
     65    index_code:     idSrad
     66    type:           r2dvar
     67    add_offset:     0.0d0
     68    scale:          1.0d0
     69}}}
     70 In the **test** repository, we have both **varinfo.yaml** and **varinfo_daily.yaml** to allow both modes of processing the surface shortwave radiation. In this case, the parser will substitute the anchor **SWRAD** with the desired alias **swrad**.
     71
     72A new CPP option **METADATA_REPORT** can be used to debug the YAML metadata. It writes the processed YAML dictionary to standard output.
    4373
    4474Many thanks to Zafer Defne (USGS) for patiently looking at the **standard_name** metadata and his suggestions for CF compliance.