Sample_ExtData_configuration_yaml_file - GEOS-ESM/MAPL GitHub Wiki
Introduction
We present here a sample ExtData YAML configuration file that has the settings for:
- Collections: Define the list of datasets (a file or files representing a time series of data) that can be used by the
ExtDatadata access rules. - Samplings: The rule consists of a key/value mapping where the key is a label referred to by the Export and the value is the list of options that relate to temporal handling of the data.
- Exports: The rule consists of a key/value mapping where the key is the name of the import to be filled (
variable_name_in_field)and the value is the list of options for that key.
To understand the above settings, let us consider the simple example:
Collections:
GMI_acetone_fixed_GMI.x288_y181_z72_t12.2001.nc:
template: ExtData/g5chem/L72/acetone_fixed_GMI.x288_y181_z72_t12.2001.nc
samplings:
GMI_sample_0:
extrapolation: clim
update_frequency: PT24H
update_offset: PT12H
update_reference_time: '0'
Exports:
ACET_FIXED:
collection: GMI_acetone_fixed_GMI.x288_y181_z72_t12.2001.nc
sample: GMI_sample_0
variable: ACET
ALD2_biof:
collection: /dev/null
There is a collection lebelled GMI_acetone_fixed_GMI.x288_y181_z72_t12.2001.nc which has the template file with full path ExtData/g5chem/L72/acetone_fixed_GMI.x288_y181_z72_t12.2001.nc (note that ExtData here is alias to a folder that is defined in the running script).
The Sampling rule GMI_sample_0 will apply for a climatology file (extrapolation: clim).
During the time integration, the code will fill the field ACET_FIXED by reading the climatology
file folloing the rule in GMI_sample_0.
The field ALD2_biof that is not linked to any collection will be set to zero.
Sample extdata.yaml Configuration File
Collections:
GMI_CMIP6_BB.emis.x1440_y720_t12.%y4.nc4:
template: ExtData/CMIP6/sfc/biomass_burning/CMIP6_BB.emis.x1440_y720_t12.%y4.nc4
GMI_CMIP6_CEDS.airNOemis.x720_y360_z72_t12.%y4.nc4:
template: ExtData/CMIP6/L72/aircraft/CMIP6_CEDS.airNOemis.x720_y360_z72_t12.%y4.nc4
GMI_CMIP6_CEDS.airSO2emis.x720_y360_z72_t12.%y4.nc4:
template: ExtData/CMIP6/L72/CMIP6_CEDS.airSO2emis.x720_y360_z72_t12.%y4.nc4
GMI_CMIP6_CEDS.emis.x720_y360_t12.%y4.nc4:
template: ExtData/CMIP6/sfc/fossil_fuels/CMIP6_CEDS.emis.x720_y360_t12.%y4.nc4
GMI_DMS_lana.geos.1x1.esmf.nc:
template: /discover/nobackup/cakelle2/data/OCEAN/DMS_lana.geos.1x1.esmf.nc
GMI_MEGAN_AEF_LAI_Heracles.x288_y181_t12.2008.nc:
template: ExtData/g5chem/sfc/MEGAN_AEF_LAI_Heracles.x288_y181_t12.2008.nc
GMI_OCS_vmr.x360_y181_z72.t12.2016.nc4:
template: ExtData/g5chem/L72/OCS_vmr.x360_y181_z72.t12.2016.nc4
GMI_SC.ODS.Emission.x360_y181.%y4.V1.nc:
template: /discover/nobackup/ssteenro/qing/SC.ODS.Emission.x360_y181.%y4.V1.nc
GMI_acetone_fixed_GMI.x288_y181_z72_t12.2001.nc:
template: ExtData/g5chem/L72/acetone_fixed_GMI.x288_y181_z72_t12.2001.nc
GMI_fertilizer_GMI.x288_y181_t12.2006.nc:
template: ExtData/g5chem/sfc/fertilizer_GMI.x288_y181_t12.2006.nc
GMI_lai_x720_y360_v72_t12_2008.nc:
template: ExtData/g5chem/sfc/LAI/lai_x720_y360_v72_t12_2008.nc
GMI_precipitation_GMI.x288_y181_t12.2006.nc:
template: ExtData/g5chem/sfc/precipitation_GMI.x288_y181_t12.2006.nc
GMI_sad_wt_CMIP6_288x181x72_%y4.nc:
template: ExtData/CMIP6/L72/SAD/sad_wt_CMIP6_288x181x72_%y4.nc
GMI_veg_fraction_x720_y360_t12_2008.nc:
template: ExtData/g5chem/sfc/LAI/veg_fraction_x720_y360_t12_2008.nc
Samplings:
GMI_sample_0:
extrapolation: clim
update_frequency: PT24H
update_offset: PT12H
update_reference_time: '0'
GMI_sample_1:
update_frequency: PT24H
update_offset: PT12H
update_reference_time: '0'
GMI_sample_2:
extrapolation: clim
update_frequency: P1M
update_reference_time: '0'
GMI_sample_3:
extrapolation: clim
Exports:
ACET_FIXED:
collection: GMI_acetone_fixed_GMI.x288_y181_z72_t12.2001.nc
sample: GMI_sample_0
variable: ACET
ALD2_biof:
collection: /dev/null
ALD2_biom:
collection: GMI_CMIP6_BB.emis.x1440_y720_t12.%y4.nc4
regrid: CONSERVE
sample: GMI_sample_1
variable: ALD2_bb
C2H6_fosf:
collection: GMI_CMIP6_CEDS.emis.x720_y360_t12.%y4.nc4
regrid: CONSERVE
sample: GMI_sample_1
variable: C2H6_ff
C3H8_biof:
collection: /dev/null
C3H8_biom:
collection: GMI_CMIP6_BB.emis.x1440_y720_t12.%y4.nc4
regrid: CONSERVE
sample: GMI_sample_1
variable: C3H8_bb
C3H8_fosf:
collection: GMI_CMIP6_CEDS.emis.x720_y360_t12.%y4.nc4
regrid: CONSERVE
sample: GMI_sample_1
variable: C3H8_ff
CCL4_FLUX:
collection: GMI_SC.ODS.Emission.x360_y181.%y4.V1.nc
regrid: CONSERVE
sample: GMI_sample_1
variable: CCL4_emission
CFC113_FLUX:
collection: GMI_SC.ODS.Emission.x360_y181.%y4.V1.nc
regrid: CONSERVE
sample: GMI_sample_1
variable: CFC113_emission
CFC11_FLUX:
collection: GMI_SC.ODS.Emission.x360_y181.%y4.V1.nc
regrid: CONSERVE
sample: GMI_sample_1
variable: CFC11_emission
CFC12_FLUX:
collection: GMI_SC.ODS.Emission.x360_y181.%y4.V1.nc
regrid: CONSERVE
sample: GMI_sample_1
variable: CFC12_emission
CH2BR2_FLUX:
collection: GMI_SC.ODS.Emission.x360_y181.%y4.V1.nc
regrid: CONSERVE
sample: GMI_sample_1
variable: CH2BR2_emission
CH2O_biof:
collection: /dev/null
CH2O_biom:
collection: GMI_CMIP6_BB.emis.x1440_y720_t12.%y4.nc4
regrid: CONSERVE
sample: GMI_sample_1
variable: CH2O_bb
CH3CCL3_FLUX:
collection: GMI_SC.ODS.Emission.x360_y181.%y4.V1.nc
regrid: CONSERVE
sample: GMI_sample_1
variable: CH3CCL3_emission
CH4_aggr:
collection: /dev/null
CH4_biom:
collection: /dev/null
CHBR3_FLUX:
collection: GMI_SC.ODS.Emission.x360_y181.%y4.V1.nc
regrid: CONSERVE
sample: GMI_sample_1
variable: CHBR3_emission
CO_biof:
collection: /dev/null
CO_biom:
collection: GMI_CMIP6_BB.emis.x1440_y720_t12.%y4.nc4
regrid: CONSERVE
sample: GMI_sample_1
variable: CO_bb
CO_fosf:
collection: GMI_CMIP6_CEDS.emis.x720_y360_t12.%y4.nc4
regrid: CONSERVE
sample: GMI_sample_1
variable: CO_ff
DMS_OCEAN:
collection: GMI_DMS_lana.geos.1x1.esmf.nc
regrid: CONSERVE
sample: GMI_sample_2
variable: DMS_OCEAN
HCFC22_FLUX:
collection: GMI_SC.ODS.Emission.x360_y181.%y4.V1.nc
regrid: CONSERVE
sample: GMI_sample_1
variable: HCFC22_emission
LAI_FRAC:
collection: GMI_lai_x720_y360_v72_t12_2008.nc
sample: GMI_sample_0
variable: LAI_FRAC
MEGAN_ISOP:
collection: GMI_MEGAN_AEF_LAI_Heracles.x288_y181_t12.2008.nc
regrid: CONSERVE
sample: GMI_sample_3
variable: BIOGSRCE_AEF_ISOP
MEGAN_LAI_001:
collection: GMI_MEGAN_AEF_LAI_Heracles.x288_y181_t12.2008.nc
sample: GMI_sample_3
variable: AVHRR_LAI_001
MEK_biom:
collection: GMI_CMIP6_BB.emis.x1440_y720_t12.%y4.nc4
regrid: CONSERVE
sample: GMI_sample_1
variable: MEK_bb
MEK_fosf:
collection: GMI_CMIP6_CEDS.emis.x720_y360_t12.%y4.nc4
regrid: CONSERVE
sample: GMI_sample_1
variable: MEK_ff
N2O_ANTHRO-FLUX:
collection: GMI_SC.ODS.Emission.x360_y181.%y4.V1.nc
regrid: CONSERVE
sample: GMI_sample_1
variable: N2OANTHRO_emission
N2O_LAND-FLUX:
collection: GMI_SC.ODS.Emission.x360_y181.%y4.V1.nc
regrid: CONSERVE
sample: GMI_sample_1
variable: N2OLAND_emission
N2O_OCEAN-FLUX:
collection: GMI_SC.ODS.Emission.x360_y181.%y4.V1.nc
regrid: CONSERVE
sample: GMI_sample_1
variable: N2OOCEAN_emission
NO_air:
collection: GMI_CMIP6_CEDS.airNOemis.x720_y360_z72_t12.%y4.nc4
regrid: CONSERVE
sample: GMI_sample_1
variable: NO_air
NO_biom:
collection: GMI_CMIP6_BB.emis.x1440_y720_t12.%y4.nc4
regrid: CONSERVE
sample: GMI_sample_1
variable: NO_bb
NO_fosf:
collection: GMI_CMIP6_CEDS.emis.x720_y360_t12.%y4.nc4
regrid: CONSERVE
sample: GMI_sample_1
variable: NO_ff
OCS_CLIMO:
collection: GMI_OCS_vmr.x360_y181_z72.t12.2016.nc4
sample: GMI_sample_0
variable: ocs
PRPE_biom:
collection: GMI_CMIP6_BB.emis.x1440_y720_t12.%y4.nc4
regrid: CONSERVE
sample: GMI_sample_1
variable: PRPE_bb
PRPE_fosf:
collection: GMI_CMIP6_CEDS.emis.x720_y360_t12.%y4.nc4
regrid: CONSERVE
sample: GMI_sample_1
variable: PRPE_ff
SAD:
collection: GMI_sad_wt_CMIP6_288x181x72_%y4.nc
sample: GMI_sample_1
variable: lbssad
SHIP_NO:
collection: GMI_CMIP6_CEDS.emis.x720_y360_t12.%y4.nc4
regrid: CONSERVE
sample: GMI_sample_1
variable: NO_shp
SO2_AIRCRAFT-FLUX:
collection: GMI_CMIP6_CEDS.airSO2emis.x720_y360_z72_t12.%y4.nc4
regrid: CONSERVE
sample: GMI_sample_1
variable: SO2_aviation
SOILFERT:
collection: GMI_fertilizer_GMI.x288_y181_t12.2006.nc
regrid: CONSERVE
sample: GMI_sample_0
variable: soilFert
SOILPRECIP:
collection: GMI_precipitation_GMI.x288_y181_t12.2006.nc
sample: GMI_sample_0
variable: soilPrecip
VEG_FRAC:
collection: GMI_veg_fraction_x720_y360_t12_2008.nc
sample: GMI_sample_0
variable: VEG_FRAC