Difference between revisions of "coupling esmf atm.yaml"
From WikiROMS
Jump to navigationJump to search (Created page with "<div class="title">coupling_esmf_atm.yaml</div> __TOC__ The '''coupling_esmf_<atm>.yaml''' (where <atm> is the model name) file specifies the ROMS Coupling ESMF/NUOPC System...") (change visibility) |
|||
| Line 5: | Line 5: | ||
The '''coupling_esmf_<atm>.yaml''' (where <atm> is the model name) file specifies the ROMS Coupling ESMF/NUOPC System Import/Export Metadata Dictionary. Starting '''svn''' revision '''-r 1902''' released on March 1, 2022, the ROMS coupling metadata is managed with a YAML file, and the regular text file '''coupling_esmf_<atm>.dat''' is deprecated. The YAML files are simple, easy to follow, elegant, portable, and expandable. ROMS can now process YAML files with its parser module, '''yaml_parser.F'''. Therefore, there is no need to use third-party YAML parsers. Basically, '''coupling_esmf_<atm>.yaml''' has the following structure: | The '''coupling_esmf_<atm>.yaml''' (where <atm> is the model name) file specifies the ROMS Coupling ESMF/NUOPC System Import/Export Metadata Dictionary. Starting '''svn''' revision '''-r 1902''' released on March 1, 2022, the ROMS coupling metadata is managed with a YAML file, and the regular text file '''coupling_esmf_<atm>.dat''' is deprecated. The YAML files are simple, easy to follow, elegant, portable, and expandable. ROMS can now process YAML files with its parser module, '''yaml_parser.F'''. Therefore, there is no need to use third-party YAML parsers. Basically, '''coupling_esmf_<atm>.yaml''' has the following structure: | ||
<div class="box"><span class="violet">ATM_component</span>: <span class="green">&ATM</span> <span class="twilightBlue">WRF</span><br /><br /><span class="violet">DATA_component</span>: <span class="twilightBlue">data.nc</span><br /><br /><span class="violet">ROMS_component</span>: <span class="green">&OCN</span> <span class="twilightBlue">ROMS</span><br /><br /><span class="violet">metadata</span>:<br /><br /> - <span class="violet">standard_name</span>: <span class="twilightBlue">sea_surface_temperature</span><br /> <span class="violet">long_name</span>: <span class="twilightBlue">sea surface | <div class="box"><span class="violet">ATM_component</span>: <span class="green">&ATM</span> <span class="twilightBlue">WRF</span><br /><br /><span class="violet">DATA_component</span>: <span class="twilightBlue">data.nc</span><br /><br /><span class="violet">ROMS_component</span>: <span class="green">&OCN</span> <span class="twilightBlue">ROMS</span><br /><br /><span class="violet">metadata</span>:<br /><br /> - <span class="violet">standard_name</span>: <span class="twilightBlue">sea_surface_temperature</span><br /> <span class="violet">long_name</span>: <span class="twilightBlue">sea surface temperature</span><br /> <span class="violet">short_name</span>: <span class="twilightBlue">SST</span><br /> <span class="violet">data_variables</span>: <span class="red">[<span class="twilightBlue">temperature</span>, <span class="twilightBlue">time</span>]</span><br /> <span class="violet">source_units</span>: <span class="twilightBlue">C</span><br /> <span class="violet">destination_units</span>: <span class="twilightBlue">K</span><br /> <span class="violet">source_grid</span>: <span class="twilightBlue">cell_center</span><br /> <span class="violet">destination_grid</span>: <span class="twilightBlue">cell_center</span><br /> <span class="violet">add_offset</span>: <span class="twilightBlue">273.15d0</span><br /> <span class="violet">scale</span>: <span class="twilightBlue">1.0d0</span><br /> <span class="violet">debug_write</span>: <span class="twilightBlue">false</span><br /> <span class="violet">connected_to</span>: <span class="salmon">*OCN</span><br /> <span class="violet">regrid_method</span>: <span class="twilightBlue">bilinear</span><br /> <span class="violet">extrapolate_method</span>: <span class="twilightBlue">nearest</span><br /><br /> - <span class="violet">standard_name</span>: <span class="twilightBlue">sea_surface_temperature_data</span><br /> <span class="violet">long_name</span>: <span class="twilightBlue">sea surface temperature data</span><br /> <span class="violet">short_name</span>: <span class="twilightBlue">dSST</span><br /> <span class="violet">data_variables</span>: <span class="red">[<span class="twilightBlue">temperature</span>, <span class="twilightBlue">time</span>]</span><br /> <span class="violet">source_units</span>: <span class="twilightBlue">C</span><br /> <span class="violet">destination_units</span>: <span class="twilightBlue">K</span><br /> <span class="violet">source_grid</span>: <span class="twilightBlue">cell_center</span><br /> <span class="violet">destination_grid</span>: <span class="twilightBlue">cell_center</span><br /> <span class="violet">add_offset</span>: <span class="twilightBlue">273.15d0</span><br /> <span class="violet">scale</span>: <span class="twilightBlue">1.0d0</span><br /> <span class="violet">debug_write</span>: <span class="twilightBlue">false</span><br /> <span class="violet">connected_to</span>: <span class="salmon">*ATM</span><br /> <span class="violet">regrid_method</span>: <span class="twilightBlue">bilinear</span><br /> <span class="violet">extrapolate_method</span>: <span class="twilightBlue">nearest</span></div> | ||
The field key and value pair in the YAML blocking list is as follows: | The field key and value pair in the YAML blocking list is as follows: | ||
| Line 62: | Line 62: | ||
:<span class="twilightBlue">field</span> (<span class="violet">destination_units</span>) = <span class="twilightBlue">field</span> (<span class="violet">source_units</span>) * <span class="violet">scale</span> + <span class="violet">add_offset</span> | :<span class="twilightBlue">field</span> (<span class="violet">destination_units</span>) = <span class="twilightBlue">field</span> (<span class="violet">source_units</span>) * <span class="violet">scale</span> + <span class="violet">add_offset</span> | ||
YAML allows '''alias''' and '''anchor''' to avoid repetition. In YAML, single or multiple line comments start with a hash <span class="twilightBlue">#</span>. Also, comment after a key/value pair is allowed. All comments are skipped during processing. | YAML allows '''alias''' and '''anchor''' to avoid repetition. In YAML, single or multiple line comments start with a hash <span class="twilightBlue">#</span>. Also, comment after a key/value pair is allowed. All comments are skipped during processing. | ||
=== Metadata: standard_name === | |||
The following table shows the '''standard_name''' attributes that are used in ROMS output NetCDF files. They follow CF conventions. However, we needed to create lots of them because are not available in the CF tables but followed their established syntax. | |||
{| border="1" cellspacing="0" cellpadding="5" align="left" | |||
| align="center" | '''Variable''' | |||
|style="width: 350px;" align="center" | '''standard_name''' | |||
|- | |||
| <span class="mediumOrchid">dLWrad</span> | |||
| <span class="twilightBlue">surface_net_downward_longwave_flux</span> | |||
|- | |||
| <span class="mediumOrchid">dSWrad</span> | |||
| <span class="twilightBlue">net_downward_shortwave_flux_at_sea_water_surface</span> | |||
|- | |||
| <span class="mediumOrchid">dSST</span> | |||
| sea_surface_temperature_data | |||
|- | |||
| <span class="mediumOrchid">Hair</span> | |||
| <span class="twilightBlue">surface_specific_humidity</span> | |||
|- | |||
| <span class="mediumOrchid">LHfx</span> | |||
| surface_latent_heat_flux | |||
|- | |||
| <span class="mediumOrchid">LWrad</span> | |||
| surface_net_downward_longwave_flux | |||
|- | |||
| <span class="mediumOrchid">Pair</span> | |||
| <span class="twilightBlue">surface_air_pressure</span> | |||
|- | |||
| <span class="mediumOrchid">Pmsl</span> | |||
| mean_sea_level_pressure | |||
|- | |||
| <span class="mediumOrchid">Qair</span> | |||
| surface_relative_humidity | |||
|- | |||
| <span class="mediumOrchid">rain</span> | |||
| <span class="twilightBlue">precipitation_flux</span> | |||
|- | |||
| <span class="mediumOrchid">shflux</span> | |||
| <span class="twilightBlue">surface_downward_heat_flux_in_sea_water</span> | |||
|- | |||
| <span class="mediumOrchid">SHfx</span> | |||
| surface_sensible_heat_flux | |||
|- | |||
| <span class="mediumOrchid">SST</span> | |||
| <span class="twilightBlue">sea_surface_temperature</span> | |||
|- | |||
| <span class="mediumOrchid">sustr</span> | |||
| <span class="twilightBlue">surface_downward_x_stress</span> | |||
|- | |||
| <span class="mediumOrchid">svstr</span> | |||
| <span class="twilightBlue">surface_downward_y_stress</span> | |||
|- | |||
| <span class="mediumOrchid">swflux</span> | |||
| <span class="twilightBlue">surface_upward_water_flux</span> | |||
|- | |||
| <span class="mediumOrchid">SWrad</span> | |||
| net_shortwave_flux_at_sea_water_surface | |||
|- | |||
| <span class="mediumOrchid">Tair</span> | |||
| surface_air_temperature | |||
|- | |||
| <span class="mediumOrchid">Uwind</span> | |||
| surface_eastward_wind | |||
|- | |||
| <span class="mediumOrchid">Vwind</span> | |||
| surface_northward_wind | |||
|- | |||
|} | |||
Revision as of 20:48, 27 April 2022
coupling_esmf_atm.yaml
The coupling_esmf_<atm>.yaml (where <atm> is the model name) file specifies the ROMS Coupling ESMF/NUOPC System Import/Export Metadata Dictionary. Starting svn revision -r 1902 released on March 1, 2022, the ROMS coupling metadata is managed with a YAML file, and the regular text file coupling_esmf_<atm>.dat is deprecated. The YAML files are simple, easy to follow, elegant, portable, and expandable. ROMS can now process YAML files with its parser module, yaml_parser.F. Therefore, there is no need to use third-party YAML parsers. Basically, coupling_esmf_<atm>.yaml has the following structure:
ATM_component: &ATM WRF
DATA_component: data.nc
ROMS_component: &OCN ROMS
metadata:
- standard_name: sea_surface_temperature
long_name: sea surface temperature
short_name: SST
data_variables: [temperature, time]
source_units: C
destination_units: K
source_grid: cell_center
destination_grid: cell_center
add_offset: 273.15d0
scale: 1.0d0
debug_write: false
connected_to: *OCN
regrid_method: bilinear
extrapolate_method: nearest
- standard_name: sea_surface_temperature_data
long_name: sea surface temperature data
short_name: dSST
data_variables: [temperature, time]
source_units: C
destination_units: K
source_grid: cell_center
destination_grid: cell_center
add_offset: 273.15d0
scale: 1.0d0
debug_write: false
connected_to: *ATM
regrid_method: bilinear
extrapolate_method: nearest
DATA_component: data.nc
ROMS_component: &OCN ROMS
metadata:
- standard_name: sea_surface_temperature
long_name: sea surface temperature
short_name: SST
data_variables: [temperature, time]
source_units: C
destination_units: K
source_grid: cell_center
destination_grid: cell_center
add_offset: 273.15d0
scale: 1.0d0
debug_write: false
connected_to: *OCN
regrid_method: bilinear
extrapolate_method: nearest
- standard_name: sea_surface_temperature_data
long_name: sea surface temperature data
short_name: dSST
data_variables: [temperature, time]
source_units: C
destination_units: K
source_grid: cell_center
destination_grid: cell_center
add_offset: 273.15d0
scale: 1.0d0
debug_write: false
connected_to: *ATM
regrid_method: bilinear
extrapolate_method: nearest
The field key and value pair in the YAML blocking list is as follows:
- standard_name: CF conventions standard name for variable. A list of applicable standard_name attributes are shown below.
- long_name: The field's long descriptive name.
- short_name: The field's short name private to the NUOPC cap module
- data_variables: The DATA component NetCDF field and time variable names.
- source_units: The field's source units.
- destination_units: The field's destination units.
- source_grid: The field's source grid-cell location.
- destination_grid: The field's destination grid-cell location.
- add_offset: The value to add to the exchanged field.
- scale: The scale to use to convert data from source to destination.
- debug_write: A switch indicating whether or not to write out exchanged field, if DebugLevel>2.
- connected_to: The source component to which the field is connected.
- regrid_method: The field regridding method from source to destination:
| bilinear | bilinear interpolation |
| patch | high-order patch recovery |
| conservative1 | first-order conservative |
| conservative2 | second-order conservative |
| nearest | nearest neighbor interpolation |
- extrapolate_method: The field extrapolation method for unmapped points:
| none | no extrapolation |
| nearest | nearest source to destination |
| idavg | nearest inverse distance average |
| creep | creep fill at specified level |
| 2steps | Turuncoglu's 2 steps extrapolation |
The ESM imported fields are processed as:
- field (destination_units) = field (source_units) * scale + add_offset
YAML allows alias and anchor to avoid repetition. In YAML, single or multiple line comments start with a hash #. Also, comment after a key/value pair is allowed. All comments are skipped during processing.
Metadata: standard_name
The following table shows the standard_name attributes that are used in ROMS output NetCDF files. They follow CF conventions. However, we needed to create lots of them because are not available in the CF tables but followed their established syntax.
| Variable | standard_name |
| dLWrad | surface_net_downward_longwave_flux |
| dSWrad | net_downward_shortwave_flux_at_sea_water_surface |
| dSST | sea_surface_temperature_data |
| Hair | surface_specific_humidity |
| LHfx | surface_latent_heat_flux |
| LWrad | surface_net_downward_longwave_flux |
| Pair | surface_air_pressure |
| Pmsl | mean_sea_level_pressure |
| Qair | surface_relative_humidity |
| rain | precipitation_flux |
| shflux | surface_downward_heat_flux_in_sea_water |
| SHfx | surface_sensible_heat_flux |
| SST | sea_surface_temperature |
| sustr | surface_downward_x_stress |
| svstr | surface_downward_y_stress |
| swflux | surface_upward_water_flux |
| SWrad | net_shortwave_flux_at_sea_water_surface |
| Tair | surface_air_temperature |
| Uwind | surface_eastward_wind |
| Vwind | surface_northward_wind |
