Merge remote-tracking branch 'origin/master' into horayzon

Author: Christian Steger

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,32 @@
+## Description
+
+*Add your description here.*
+
+## Workflow for merging PRs
+
+Please read these instructions carefully and follow the steps below before requesting a review by the maintainers. This way we can ensure a smoother review process and your changes will be merged sooner.
+
+Additionally, if this is the first PR you open in EXTPAR make sure to read the [*"Information for EXTPAR Developers"*](https://c2sm.github.io/extpar/development/) section in the documentation.
+
+### Checklist
+
+- [ ] Provide a detailed description of your changes in the "Description" section above.
+- [ ] If you implemented a new feature:
+  - [ ] Document it in the correct Markdown file(s) under the [`docs/`](https://github.com/C2SM/extpar/tree/master/docs) directory.
+  - [ ] [Add a new test](https://c2sm.github.io/extpar/testing/#add-a-new-test) or make sure your changes are already tested.
+- [ ] Your code follows the [style guidelines](https://c2sm.github.io/extpar/development/#coding-rules-and-best-practices).
+- [ ] Your changes only touch the files/lines relevant for you.
+- [ ] All four required checks pass (see [*"Testing and debugging"*](#testing-and-debugging) for more details).
+- [ ] No conflicts with the base branch.
+
+If all the points above are satisfied you can ask for a review by selecting `stelliom` as a reviewer.
+
+For any questions please ping `@stelliom` on this PR.
+
+### Testing and debugging
+
+The most important test for PRs is the one labeled *"EXTPAR Testsuite on Jenkins"*. This checks that the results of all testcases (described by the namelists in [`test/testsuite/data`](https://github.com/C2SM/extpar/tree/master/test/testsuite/data)) did not change compared to the references.
+
+You can launch the testsuite by writing `launch jenkins` as a comment in the PR that you want to test. Once completed, the result of the testsuite will be shown on the PR (failure or success).
+
+If you need more details on the testsuite results (e.g., if you are trying to debug an error or you are simply unsure why the tests fail) you can launch the testsuite with `launch jenkins(debug)`. This will run the tests as usual, but, once completed, you will be given a URL (via a comment on the PR) to access the logfiles and namelists of all tests that were run.

.github/PULL_REQUEST_TEMPLATE/default.md

@@ -1,3 +1,3 @@
 # EXTPAR
 
-Full documentation: [https://c2sm.github.io/extpar/](https://c2sm.github.io/extpar/)
+Full documentation: [https://c2sm.github.io/extpar/](https://c2sm.github.io/extpar/)

README.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,

docs/index.md

@@ -1,6 +1,6 @@
 # Release notes
 
-For the latest release notes, please see our [GitHub webpage :material-open-in-new:](https://github.com/C2SM-RCM/extpar/releases){:target="_blank"}.
+For the latest release notes `>=5.15`, please see our [GitHub webpage :material-open-in-new:](https://github.com/C2SM-RCM/extpar/releases){:target="_blank"}.
 
 ## 5.14
 
@@ -569,3 +569,74 @@ a new build-system, 2 additional landuse data sets, CDI-library for icon grids i
 
 #### DWD Extpar version 2.10 to Extpar version 5.0
   Comparisons of the COSMO D2 setup used operationally by DWD were carried out to compare the current operational Extpar code (DWD version 2.10) with the new release 5.0.  This comparison showed no significant differences in the generated external parameter fields.  Get more details of this comparison [here](doc/EXTPAR_CD2_comparison.pdf)
+
+## 4.0
+
+New features and changes in EXTPAR 4.0:
+
+- Support for MACv2 aerosol climatology for RG92 spectral bands added (Development of RosHyMet)
+- Support for subgrid-scale slope parameter added for a new soil moisture flux formulation in TERRA_ML developed by Linda Schlemmer (ETHZ)
+- Additional namelist parameters introduced for extpar_isa_to_buffer and extpar_ahf_to_buffer to enable choice of raw data sets by Burkhardt Rockel (HZG)
+- Correct bug in the calculation of SSO_THETA reported by Rolf Zentek (Uni Trier) and Jürgen Helmert (DWD)
+
+## 3.0 
+
+New features and changes in EXTPAR version 3.0:
+
+- An additional executables extpar_isa_to_buffer (contributed by Hendrik Wouters) is provided to create the external data fields fraction of impervious surface area (ISA) needed by the urban model TERRA_URB
+- A second additional executable extpar_ahf_to_buffer (also by Hendrik Wouters) generates the fields anthropogenic heat flux (AHF) also needed by TERRA_URB
+- Reduced the amount of memory used in extpar_soil_to_buffer when using HWSD soil data
+- Corrected problems with the coast line in the Caspian Sea area at high resolutions
+- Corrected problems appearing at the date line with lake and aerosol data
+- Corrected problems appearing at the south pole
+
+## 2.0
+
+ EXTPAR 2.0.0 officially released
+
+ -  start point is DWD release 1.6
+ -  added delta from DWD release 1.13
+ -  added support of ASTER topography (in domain [60S,60N])
+ -  support scale separation to compute SSO and z0 when using GLOBE topography
+ -  added namelist parameter to switch off computation of SSO (for performance reasons)
+ -  added support of lradtopo parameterization (topo corrected radiation)
+ -  support of HWSD (incl. preliminary support of deep soil)
+ -  support for mapping of HWSD soil data to classical TERRA soil types (isoil_type = 3)
+ -  corrected GLOBCOVER data set, updated input routines (GLOBCOVER is now delivered as a set of tiles)
+ -  modified consistency check related to soil type = ice (improved compatibility with GLOBCOVER data)
+ -  support for ECOCLIMAP landuse data set with seasonal cycle of LAI, PLCOV and Z0 (i_landuse_data = 4)
+ -  support for soil albedo values similar to what is used in the Community Land Model (ialb_type = 2)
+ -  support for additional aerosol climatologies: AEROCOM (iaot_type = 2) and MACC (iaot_type = 3)
+ -  many bug fixes and code cleanup
+ -  consolidated run scripts
+ -  modified Makefile
+
+### Quality control
+
+ -  software extensively tested during development by Martina Messmer (reports available in documentation)
+ -  software tested with COSMO-1, COSMO-2, COSMO-7, at MeteoSwiss, for different configurations (GLOBE / ASTER, GLC2000 / GLOBCOVER, FAO / HWSD)
+ -  software tested at ETHZ by Daniel Luethi
+ -  software tested at DWD by Juergen Helmert
+
+### Documentation
+
+ -  comprehensive documentation available at CSCS / Switzerland, in master installation
+ -  mailing list cosmo-extpar
+
+### Installation
+
+ -  full installation, including raw data, at CSCS / Switzerland
+ -  code controlled with SVN
+
+And here is what you do not get with release 2.0: 
+
+### Limitations
+
+ -  high resolution topo data at high latitude (> 60 deg) is missing
+ -  HWSD deep soil is preliminary and not tested
+ -  compatibility of GRIB 1 output with latest INT2LM release has not been tested
+ -  GRIB 2 output is not working (one may use fieldextra to convert from GRIB 1 to GRIB 2)
+ -  code not tested with OpenMP
+ -  code not tested for GME
+ -  code not tested for ICON
+ -  code performance in terms of time to solution is limited

docs/release_notes.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)

docs/user_manual/user_manual_04_python_modules.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 | 1 | | type of used CDNC data source <br> 1: MODIS Q06 <br> 2: MODIS G18 <br> 3: MODIS BR17 |
 
 ## Aerosol Optical Thickness Data
 
@@ -227,7 +228,7 @@ The COSMO grid is defined by a rotated latlon-grid.
 | `iaot_type`             | integer   |             |          | type of used AOT data source <br> 1: Tegen <br> 2: AeroCom |
 | `aot_buffer_file`       | character |             |          | name for AOT buffer file                             |
 
-## art Data
+## ART Data
 
 ### DICT `input_art` (namelist.py)
 

docs/user_manual/user_manual_06_namelist_input.md

@@ -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', 1)
     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