Add switch for CDNC datasets (#431)

stelliom · github-actions · web-flow · commit 8bbe9fb6cedc · 2025-08-22T14:09:35.000+02:00
Co-authored-by: github-actions &lt;github-actions@github.com&gt;
diff --git a/docs/index.md b/docs/index.md
@@ -47,6 +47,7 @@ _1. EXTPAR settings as JSON, see official docs_
     "it_cl_type": 1,
     "iera_type": 1,
     "iemiss_type": 1,
+    "icdnc_type": 1,
     "ilookup_table_lu": 1,
     "enable_cdnc": false,
     "enable_edgar": false,
diff --git a/docs/user_manual/user_manual_04_python_modules.md b/docs/user_manual/user_manual_04_python_modules.md
@@ -383,8 +383,10 @@ The executable *extpar_cdnc_to_buffer* allows the interpolation of
 climatology data for cloud droplet number needed for the Cloud-Aerosol
 in ICON to the target grid.
 
-The namelist contains only the path to the raw data, the raw data file
-names and the name of the buffer file.
+The namelist contains the path to the raw data, the raw data file
+names and the name of the buffer file. The integer switch (*icdnc_type*) informs
+EXTPAR about which of the 3 available datasets has been chosen: 1 (MODIS Q06),
+2 (MODIS G18), 3 (MODIS BR17).
 
 The remapping to the target grid uses the *first order conservative*
 interpolation. No other processing steps take place.
@@ -396,7 +398,9 @@ interpolation. No other processing steps take place.
 
 -   generate namelist: INPUT_cdnc
 
--   data input: cdnc_climatology_Q06.nc
+-   data input: modis_cdnc_climatology_Q06.nc (icdnc_type=1),
+    modis_cdnc_climatology_G18.nc (icdnc_type=2),
+    modis_cdnc_climatology_BR17_37mu_adjusted.nc (icdnc_type=3)
 
 -   Output: buffer file with cloud droplet number data (input_cdnc:
     cdnc_buffer_file)
diff --git a/docs/user_manual/user_manual_06_namelist_input.md b/docs/user_manual/user_manual_06_namelist_input.md
@@ -215,6 +215,7 @@ The COSMO grid is defined by a rotated latlon-grid.
 |-----------|------|---------|------|-------------|
 | `raw_data_cdnc_path` | character | | | Path to CDNC raw data |
 | `raw_data_cdnc_filename` | character | | | Filename of CDNC raw data |
+| `icdnc_type` | integer | | | type of used CDNC data source <br> 1: MODIS Q06 <br> 2: MODIS G18 <br> 3: MODIS BR17 |
 
 ## Aerosol Optical Thickness Data
 
diff --git a/python/WrapExtpar.py b/python/WrapExtpar.py
@@ -73,6 +73,7 @@ def main():
     it_cl_type = config.get('it_cl_type')
     iera_type = config.get('iera_type')
     iemiss_type = config.get('iemiss_type')
+    icdnc_type = config.get('icdnc_type')
     ilookup_table_lu = config.get('ilookup_table_lu')
     enable_cdnc = config.get('enable_cdnc', False)
     enable_edgar = config.get('enable_edgar', False)
@@ -90,7 +91,7 @@ def main():
 
     generate_external_parameters(
         igrid_type, args.input_grid, iaot_type, ilu_type, ialb_type,
-        isoil_type, itopo_type, it_cl_type, iera_type, iemiss_type,
+        isoil_type, itopo_type, it_cl_type, iera_type, iemiss_type, icdnc_type,
         ilookup_table_lu, enable_cdnc, enable_edgar, enable_art,
         use_array_cache, nhori, radtopo_radius, tcorr_lapse_rate, tcorr_offset,
         args.raw_data_path, args.run_dir, args.account, args.host,
@@ -107,6 +108,7 @@ def generate_external_parameters(igrid_type,
                                  it_cl_type,
                                  iera_type,
                                  iemiss_type,
+                                 icdnc_type,
                                  ilookup_table_lu,
                                  enable_cdnc,
                                  enable_edgar,
@@ -146,6 +148,7 @@ def generate_external_parameters(igrid_type,
         'it_cl_type': it_cl_type,
         'iera_type': iera_type,
         'iemiss_type': iemiss_type,
+        'icdnc_type': icdnc_type,
         'ilookup_table_lu': ilookup_table_lu,
         'enable_cdnc': enable_cdnc,
         'enable_edgar': enable_edgar,
@@ -717,10 +720,21 @@ def setup_urban_namelist(args):
 
 def setup_cdnc_namelist(args):
     namelist = {}
+    icdnc_type = args['icdnc_type']
 
+    namelist['icdnc_type'] = icdnc_type
     namelist['raw_data_cdnc_path'] = args['raw_data_path']
     namelist['cdnc_buffer_file'] = 'cdnc_buffer.nc'
-    namelist['raw_data_cdnc_filename'] = 'modis_cdnc_climatology_Q06.nc'
+    if icdnc_type == 1:
+        namelist['raw_data_cdnc_filename'] = 'modis_cdnc_climatology_Q06.nc'
+    elif icdnc_type == 2:
+        namelist['raw_data_cdnc_filename'] = 'modis_cdnc_climatology_G18.nc'
+    elif icdnc_type == 3:
+        namelist[
+            'raw_data_cdnc_filename'] = 'modis_cdnc_climatology_BR17_37mu_adjusted.nc'
+    else:
+        logging.error(f'Unknown icdnc_type {args["icdnc_type"]}')
+        raise ValueError(f'Unknown icdnc_type {args["icdnc_type"]}')
 
     return namelist
 
diff --git a/python/extpar_cdnc_to_buffer.py b/python/extpar_cdnc_to_buffer.py
@@ -89,6 +89,8 @@
 elif (igrid_type == 2):
     raise exception("cdnc data only works with ICON")
 
+cdnc_type = utils.check_cdnctype(icdnc['icdnc_type'])
+
 raw_data_cdnc = utils.clean_path(icdnc['raw_data_cdnc_path'],
                                  icdnc['raw_data_cdnc_filename'])
 
@@ -101,7 +103,12 @@
 lat_meta = metadata.Lat()
 lon_meta = metadata.Lon()
 
-cdnc_meta = metadata.Cdnc()
+if (cdnc_type == 1):
+    cdnc_meta = metadata.CdncQ06()
+elif (cdnc_type == 2):
+    cdnc_meta = metadata.CdncG18()
+elif (cdnc_type == 3):
+    cdnc_meta = metadata.CdncBR17()
 
 #--------------------------------------------------------------------------
 #--------------------------------------------------------------------------
diff --git a/python/lib/fortran_namelist.py b/python/lib/fortran_namelist.py
@@ -202,8 +202,9 @@ class InputCdnc:
     '''
 
     def __init__(self):
+        self.variables = {'&cdnc_raw_data': {'icdnc_type'}}
 
-        self.variables = ({'&cdnc_io_extpar': {'cdnc_buffer_file'}})
+        self.variables.update({'&cdnc_io_extpar': {'cdnc_buffer_file'}})
 
 
 class InputEmiss:
diff --git a/python/lib/metadata.py b/python/lib/metadata.py
@@ -264,13 +264,31 @@ def __init__(self):
         self.short = '_'
 
 
-class Cdnc(CdncMeta):
+class CdncQ06(CdncMeta):
 
     def __init__(self):
         super().__init__()
         self.dim = {0: 'time', 1: 'ke', 2: 'je', 3: 'ie'}
         self.name = 'cdnc'
-        self.long = 'cloud droplet number density (characteristic value for atmospheric column). Source: National Aeronautics and Space Administration (NASA). MODerate resolution Imaging Spectroradiometer (MODIS), https://modis.gsfc.nasa.gov/data/'
+        self.long = 'cloud droplet number density (characteristic value for atmospheric column). Source: National Aeronautics and Space Administration (NASA). MODerate resolution Imaging Spectroradiometer (MODIS) Q06, https://modis.gsfc.nasa.gov/data/'
+
+
+class CdncG18(CdncMeta):
+
+    def __init__(self):
+        super().__init__()
+        self.dim = {0: 'time', 1: 'ke', 2: 'je', 3: 'ie'}
+        self.name = 'cdnc'
+        self.long = 'cloud droplet number density (characteristic value for atmospheric column). Source: National Aeronautics and Space Administration (NASA). MODerate resolution Imaging Spectroradiometer (MODIS) G18, https://modis.gsfc.nasa.gov/data/'
+
+
+class CdncBR17(CdncMeta):
+
+    def __init__(self):
+        super().__init__()
+        self.dim = {0: 'time', 1: 'ke', 2: 'je', 3: 'ie'}
+        self.name = 'cdnc'
+        self.long = 'cloud droplet number density (characteristic value for atmospheric column). Source: National Aeronautics and Space Administration (NASA). MODerate resolution Imaging Spectroradiometer (MODIS) BR17, https://modis.gsfc.nasa.gov/data/'
 
 
 #--------------------------------------------------------------------------
diff --git a/python/lib/utilities.py b/python/lib/utilities.py
@@ -234,6 +234,25 @@ def check_emisstype(emiss_type):
     return emiss_type
 
 
+def check_cdnctype(cdnc_type):
+    '''
+    check cdnc_type for correctness and return value,
+    if not exit programme
+    '''
+
+    if (cdnc_type == 1):
+        logging.info('process cdnc data from sampling method Q06')
+    elif (cdnc_type == 2):
+        logging.info('process cdnc data from sampling method G18')
+    elif (cdnc_type == 3):
+        logging.info('process cdnc data from sampling method BR17')
+    else:
+        logging.error(f'cdnc_type {cdnc_type} does not exist.')
+        raise ValueError(f'cdnc_type {cdnc_type} does not exist.')
+
+    return cdnc_type
+
+
 def check_gridtype(input_grid_org):
     '''
     check gridtype read from input_grid_org
diff --git a/src/extpar_consistency_check.f90 b/src/extpar_consistency_check.f90
@@ -220,6 +220,7 @@ PROGRAM extpar_consistency_check
        &                              undef_ndvi, minimal_ndvi, &
   ! cdnc
        &                              ntime_cdnc, &
+       &                              icdnc_type, &
   ! albedo
        &                              ntime_alb, &
        &                              wso_min,wso_max,csalb,csalbw,zalso, &
@@ -580,6 +581,7 @@ PROGRAM extpar_consistency_check
   INQUIRE(file=TRIM(namelist_file),exist=l_use_cdnc)
   IF (l_use_cdnc) THEN
     CALL read_namelists_extpar_cdnc(namelist_file,      &
+         &                          icdnc_type,         &
          &                          cdnc_buffer_file,   &
          &                          cdnc_output_file    )
   ENDIF
diff --git a/src/mo_python_data.f90 b/src/mo_python_data.f90
@@ -10,6 +10,7 @@ MODULE mo_python_data
   ! ndvi
        &    undef_ndvi, minimal_ndvi, ntime_ndvi, &                    
   ! cdnc
+       &    icdnc_type, &
        &    ntime_cdnc, &
   !albedo
        &    ntime_alb, &
@@ -47,6 +48,7 @@ MODULE mo_python_data
   ! ndvi
        &                          ntime_ndvi = 12, &  !< number of timesteps (12 for monthly mean values)
   ! cdnc
+       &                          icdnc_type = 1, &
        &                          ntime_cdnc = 12, &  !< number of timesteps (12 for monthly mean values)
   ! albedo
        &                          ntime_alb = 12, &   !< number of timesteps (12 for monthly mean values)
diff --git a/src/mo_python_routines.f90 b/src/mo_python_routines.f90
@@ -263,14 +263,18 @@ END SUBROUTINE read_namelists_extpar_edgar
 
   !> subroutine to read namelist for cdnc data settings for EXTPAR 
   SUBROUTINE read_namelists_extpar_cdnc(namelist_file,          &
+       &                                icdnc_type,             &
        &                                cdnc_buffer_file,       &
        &                                cdnc_output_file        )
 
     CHARACTER (len=*), INTENT(IN)             :: namelist_file          !< filename with namelists
     CHARACTER (len=filename_max)              :: cdnc_buffer_file,   &  !< name for cdnc buffer file
          &                                       cdnc_output_file       !< name for cdnc output file
 
-    INTEGER (KIND=i4)                         :: ierr, nuin
+    INTEGER (KIND=i4)                         :: icdnc_type, ierr, nuin
+
+    !> namelist with filenames for cdnc data input
+    NAMELIST /cdnc_raw_data/ icdnc_type
 
     !> namelist with filenames for cdnc data output
     NAMELIST /cdnc_io_extpar/ cdnc_buffer_file, cdnc_output_file
@@ -282,6 +286,12 @@ SUBROUTINE read_namelists_extpar_cdnc(namelist_file,          &
       CALL logging%error(message_text,__FILE__, __LINE__) 
     ENDIF
 
+    READ(nuin, NML=cdnc_raw_data, IOSTAT=ierr)
+    IF (ierr /= 0) THEN
+      WRITE(message_text,*)'Cannot read in namelist cdnc_raw_data - reason: ', ierr
+      CALL logging%error(message_text,__FILE__, __LINE__) 
+    ENDIF
+
     READ(nuin, NML=cdnc_io_extpar, IOSTAT=ierr)
     IF (ierr /= 0) THEN
       WRITE(message_text,*)'Cannot read in namelist cdnc_io_extpar - reason: ', ierr
diff --git a/src/mo_var_meta_data.f90 b/src/mo_var_meta_data.f90
@@ -54,7 +54,8 @@ MODULE mo_var_meta_data
        &                              icosahedral_triangular_grid
 
   USE mo_topo_data,             ONLY: itype_scaling
-  USE mo_python_data,           ONLY: iera_type, isa_type, iahf_type, iaot_type
+  USE mo_python_data,           ONLY: iera_type, isa_type, iahf_type, &
+       &                              iaot_type, icdnc_type
 
   USE mo_terra_urb,             ONLY: l_terra_urb, terra_urb_def_fields_meta
 
@@ -1414,6 +1415,7 @@ SUBROUTINE def_cdnc_meta(ntime,diminfo,coordinates,grid_mapping)
     INTEGER            :: n_dim      !< number of dimensions
     CHARACTER (len=80) :: gridmp
     CHARACTER (len=80) :: coord
+    CHARACTER (len=4)  :: sampling_method
 
     gridmp = c_undef
     coord  = c_undef
@@ -1461,7 +1463,16 @@ SUBROUTINE def_cdnc_meta(ntime,diminfo,coordinates,grid_mapping)
     cdnc_meta%units         =  'cm-3'
     cdnc_meta%grid_mapping  =   gridmp
     cdnc_meta%coordinates   =   coord
-    cdnc_meta%data_set      =  'MODerate resolution Imaging Spectroradiometer (MODIS), https://modis.gsfc.nasa.gov/data/'
+
+    IF (icdnc_type == 1) THEN
+      sampling_method = 'Q06'
+    ELSEIF (icdnc_type == 2) THEN
+      sampling_method = 'G18'
+    ELSEIF (icdnc_type == 3) THEN
+      sampling_method = 'BR17'
+    END IF
+
+    cdnc_meta%data_set = 'MODerate resolution Imaging Spectroradiometer (MODIS) '//TRIM(sampling_method)//', https://modis.gsfc.nasa.gov/data/'
 
   END SUBROUTINE def_cdnc_meta
 
diff --git a/templates/namelist b/templates/namelist
@@ -55,6 +55,7 @@ input_emiss = {
 
 }
 input_cdnc = {
+    'icdnc_type': @ICDNC_TYPE@,
     'raw_data_cdnc_path': '@RAW_DATA_CDNC_PATH@',
     'raw_data_cdnc_filename': '@RAW_DATA_CDNC_FILENAME@',
     'cdnc_buffer_file': '@CDNC_BUFFER_FILE@',
diff --git a/test/pytest/test_wrap_extpar.py b/test/pytest/test_wrap_extpar.py
@@ -952,16 +952,46 @@ def test_setup_oro_namelist_icon_invalid():
         setup_oro_namelist_icon(args, lonmax, lonmin, latmax, latmin)
 
 
-def test_setup_cdnc_namelist():
-    args = {'raw_data_path': '/path/to/raw/data'}
+def test_setup_cdnc_namelist_Q06():
+    args = {'icdnc_type': 1, 'raw_data_path': '/path/to/raw/data'}
     expected_namelist = {
+        'icdnc_type': 1,
         'raw_data_cdnc_path': '/path/to/raw/data',
         'cdnc_buffer_file': 'cdnc_buffer.nc',
         'raw_data_cdnc_filename': 'modis_cdnc_climatology_Q06.nc'
     }
     assert setup_cdnc_namelist(args) == expected_namelist
 
 
+def test_setup_cdnc_namelist_G18():
+    args = {'icdnc_type': 2, 'raw_data_path': '/path/to/raw/data'}
+    expected_namelist = {
+        'icdnc_type': 2,
+        'raw_data_cdnc_path': '/path/to/raw/data',
+        'cdnc_buffer_file': 'cdnc_buffer.nc',
+        'raw_data_cdnc_filename': 'modis_cdnc_climatology_G18.nc'
+    }
+    assert setup_cdnc_namelist(args) == expected_namelist
+
+
+def test_setup_cdnc_namelist_BR17():
+    args = {'icdnc_type': 3, 'raw_data_path': '/path/to/raw/data'}
+    expected_namelist = {
+        'icdnc_type': 3,
+        'raw_data_cdnc_path': '/path/to/raw/data',
+        'cdnc_buffer_file': 'cdnc_buffer.nc',
+        'raw_data_cdnc_filename':
+        'modis_cdnc_climatology_BR17_37mu_adjusted.nc'
+    }
+    assert setup_cdnc_namelist(args) == expected_namelist
+
+
+def test_setup_cdnc_namelist_invalid():
+    args = {'icdnc_type': 99, 'raw_data_path': '/path/to/raw/data'}
+    with pytest.raises(ValueError, match='Unknown icdnc_type 99'):
+        setup_cdnc_namelist(args)
+
+
 def test_setup_edgar_namelist():
     args = {'raw_data_path': '/path/to/raw/data'}
     expected_namelist = {
@@ -988,6 +1018,7 @@ def test_all_placeholders_replaced_cosmo(tmp_dir):
         "it_cl_type": 1,
         "iera_type": 1,
         "iemiss_type": 1,
+        "icdnc_type": 1,
         'ilookup_table_lu': 1,
         "enable_cdnc": False,
         "enable_edgar": False,
@@ -1029,6 +1060,7 @@ def test_all_placeholders_replaced_icon(tmp_dir, icon_grid):
         "it_cl_type": 1,
         "iera_type": 1,
         "iemiss_type": 1,
+        "icdnc_type": 1,
         'ilookup_table_lu': 1,
         "enable_cdnc": False,
         "enable_edgar": False,
diff --git a/test/testsuite/data/dwd/icon_ecci/namelist.py b/test/testsuite/data/dwd/icon_ecci/namelist.py
@@ -22,6 +22,7 @@
 }
 
 input_cdnc = {
+    'icdnc_type': 1,
     'raw_data_cdnc_path': '',
     'raw_data_cdnc_filename': 'modis_cdnc_climatology_Q06.nc',
     'cdnc_buffer_file': 'cdnc_buffer.nc',
