Make ExtData2G available as beta in transport tracers simulation

[lizziel]

Name and Institution (Required)

Name: Lizzie Lundgren
Institution: Harvard University

Describe the update

This PR, combined with geoschem/MAPL#41 and geoschem/geos-chem#3233, makes MAPL 2.59 module ExtData2G available for use with the transport tracer simulation in GCHP. ExtData2G is the next generation of MAPL ExtData, the software package from NASA GMAO that handles file data imports in GCHP. It is being released in this version as beta. Please read the list of caveats below before use. These messages are also communicated during transport tracer run directory creation.

By default ExtData2G is off. Users may turn it on within setCommonRunSettings.sh by setting Use_ExtData2G to true. The primary difference between ExtData and ExtData2G that affects users is the retirement of input configuration file ExtData.rc, replaced by new file extdata.yaml in yaml format. For transport tracer simulations both files are automatically copied to the run directory during run directory creation.

There are several caveats with this update:

1. extdata.yaml is only available for the transport tracers simulation, and it is pre-configured only for MERRA2. If using a different meteorology source then you will need to edit the file, or wait for a later GCHP version in which this is automatic during run directory creation.
2. Config file setCommonRunSettings.sh includes automatic update of several configuration entries in ExtData.rc based on other settings, and these updates are not yet ported to automatically update extdata.yaml. More specifically, you must manually edit the read frequency of pressure and temperature if using grid resolution above C180 due to the change in timesteps, and if you add mass fluxes and Courant numbers to the list of imports in extdata.yaml then you will need to manually change the scaling if the timestep changes. These changes will be automatic in a future version of GCHP.
3. NASA GMAO prepared an ExtData2G User Guide which details how to read and configure extdata.yaml. This resource will be referenced from GCHP ReadTheDocs.

Expected changes

This is a no diff update for GEOS-Chem benchmarking because ExtData2G is off by default and is released in GCHP only as beta.

Switching between ExtData and ExtData2G causes very small differences. Here is an example of differences for Rn222 in the restart file (REAL8) after a 1-day transport tracer simulation. We suspect the differences are due to one or more precision changes in MAPL ExtData code but this has not been verified. The diffs are so small that they are undetectable for nearly all diagnostics (REAL4) after a 1-day run.

Reference(s)

ExtData2G User Guide

Related Github Issues/PRs

Required pull requests:

• Enable use of ExtData2G in GCHP Transport Tracers simulation MAPL#41
• ExtData2G capability in GCHP transport tracer simulations geos-chem#3233

[yantosca]

Thanks @lizziel! Good to merge!

[yantosca]

@lizziel: Is this now ready for review or are you still testing?

[lizziel]

Now ready to merge!

[yantosca]

All GEOS-Chem Classic integration tests passed:

==============================================================================
GEOS-Chem Classic: Execution Test Results

CodeDir   : 1795f09 GEOS-Chem update: Merge PR #3233 (ExtData2G for TransportTracers)
GEOS-Chem : 92e2ab3f8 Merge PR #3233 (ExtData2G capability in GCHP TransportTracers sims)
HEMCO     : 9fbb78e Merge PR #355 (Update to latest GitHub Actions versions)
Cloud-J   : 1dff6fe Merge pull request #31 from geoschem/release/8.0.2
HETP      : 2a99b24 Merge pull request #2 from geoschem/bugfix/initialize_local_variables

Using 24 OpenMP threads
Number of execution tests: 38

Submitted as SLURM job: 3185792
==============================================================================

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%  All execution tests passed!  %%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

All GEOS-Chem Classic tests were zero-diff w/r/t gcc.5.42e86f2, except

• gc_4x5_merra2_fullchem_APM
  • Parallel error (known issue)

All GCHP integration tests passed:

==============================================================================
GCHP: Execution Test Results

CodeDir       : 5dcd1d3 GEOS-Chem and MAPL updates: Merge PR #3233 and PR #41 (ExtData2G)
MAPL          : 80d66d0a Merge PR #41 (ExtData2G in GCHP Transport Tracers simulation)
GMAO_Shared   : 4ddb3ec Merge pull request #2 from geoschem/feature/mapl-upgrade
ESMA_cmake    : 01bbf2f Merge pull request #9 from geoschem/feature/turn_off_f2py_builds_in_gchp
FMS           : 259759d1 Merge pull request #3 from geoschem/feature/update_gmao_libs
FVdycoreCubed : 348620f Merge PR #11 (Scale tracers by pressure ratio in first timestep)
geos-chem     : 92e2ab3f8 Merge PR #3233 (ExtData2G capability in GCHP TransportTracers sims)
HEMCO         : 9fbb78e Merge PR #355 (Update to latest GitHub Actions versions)
Cloud-J       : 1dff6fe Merge pull request #31 from geoschem/release/8.0.2
HETP          : 2a99b24 Merge pull request #2 from geoschem/bugfix/initialize_local_variables
GFE           : bac529f Merge pull request #40 from Goddard-Fortran-Ecosystem/feature/mathomp4/update-gftl-1.15.2

Number of execution tests: 12

Submitted as SLURM job: 3187620
==============================================================================

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%  All execution tests passed!  %%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

All GCHP tests were zero-diff w/r/t gchp.6.5dcd1d3.