Skip to content

Commit

Permalink
Edits to config files section of GCHP user guide
Browse files Browse the repository at this point in the history
Signed-off-by: Lizzie Lundgren <elundgren@seas.harvard.edu>
  • Loading branch information
lizziel committed Jun 21, 2022
1 parent ffd5025 commit 19f4dc8
Showing 1 changed file with 22 additions and 33 deletions.
55 changes: 22 additions & 33 deletions docs/source/user-guide/rundir-config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ All GCHP run directories have default simulation-specific run-time settings that
Configuration files
-------------------

GCHP is controlled using a set of configuration files that are included in the GCHP run directory. Files include:
This section gives an overview of all run directory configuration files used at run-time in GCHP. More information about each file can be found in the below list of links for core configuration files:

.. toctree::
:maxdepth: 1
Expand All @@ -28,53 +28,42 @@ GCHP is controlled using a set of configuration files that are included in the G
config-files/HISTORY_rc.rst
config-files/HEMCO_Diagn_rc.rst

In addition to these core configuration files are a helpful bash script, :file:`setCommonRunningSetting.sh`, to edit commonly changed settings in other files from one place. This section lists the core functions of all of these files.
The run directory also includes bash script :file:`setCommonRunningSetting.sh` to edit commonly changed run-time settings from one place, making the run configuration process for GCHP more manageable..

setCommonRunSettings.sh
^^^^^^^^^^^^^^^^^^^^^^^

This file is actually a bash script that includes commonly changed run settings. It makes it easier to manage configuring GCHP since settings can be changed from one file rather than across multiple configuration files. When this file is executed it updates settings in other configuration files, overwriting what is there. Please get very familiar with the options in :file:`setCommonRunSettings.sh` and be conscientious about not updating the same setting elsewhere.

CAP.rc
^^^^^^

Controls parameters used by the highest level gridded component (CAP). This includes simulation run time information, name of the Root gridded component (GCHP), config filenames for Root and History, and toggles for certain MAPL logging utilities (timers, memory, and import/export name printing).

ExtData.rc
^^^^^^^^^^

Config file for the MAPL ExtData component. Specifies input variable information, including name, regridding method, read frequency, offset, scaling, and file path. All GCHP imports must be specified in this file. Toggles at the top of the file enable MAPL ExtData debug prints and using most recent year if current year of data is unavailable. Default values may be used by specifying file path :file:`/dev/null`.

GCHP.rc
^^^^^^^

Controls high-level aspects of the simulation, including grid type and resolution, core distribution, stretched-grid parameters, timesteps, and restart filename.

geoschem_config.yml
^^^^^^^^^^^^^^^^^^^
Other configuration files
^^^^^^^^^^^^^^^^^^^^^^^^^

Primary config file for GEOS-Chem. Same file format as in GEOS-Chem Classic but containing only options relevant to GCHP.
:file:`GCHP.rc`
Controls high-level aspects of the simulation, including grid type and resolution, core distribution, stretched-grid parameters, timesteps, and restart filename.

HEMCO_Config.rc
^^^^^^^^^^^^^^^
:file:`CAP.rc`
Controls parameters used by the highest level gridded component (CAP). This includes simulation run time information, name of the Root gridded component (GCHP), config filenames for Root and History, and toggles for certain MAPL logging utilities (timers, memory, and import/export name printing).

Contains emissions information used by HEMCO. Same function as in GEOS-Chem Classic except only HEMCO name, species, scale IDs, category, and hierarchy are used. Diagnostic frequency, file path, read frequency, and units are ignored, and are instead stored in GCHP config file :file:`ExtData.rc`. All HEMCO variables listed in :file:`HEMCO_Config.rc` for enabled emissions must also have an entry in :file:`ExtData.rc`.
:file:`ExtData.rc`
Config file for the MAPL ExtData component. Specifies input variable information, including name, regridding method, read frequency, offset, scaling, and file path. All GCHP imports must be specified in this file. Toggles at the top of the file enable MAPL ExtData debug prints and using most recent year if current year of data is unavailable. Default values may be used by specifying file path :file:`/dev/null`.

HEMCO_Diagn.rc
^^^^^^^^^^^^^^
:file:`geoschem_config.yml`
Primary config file for GEOS-Chem. Same file format as in GEOS-Chem Classic but containing only options relevant to GCHP.

Contains information mapping :file:`HISTORY.rc` diagnostic names to HEMCO containers. Same function as in GEOS-Chem Classic except that not all items in :file:`HEMCO_Diagn.rc` will be output; only emissions listed in :file:`HISTORY.rc` will be included in diagnostics. All GCHP diagnostics listed in :file:`HISTORY.rc` that start with Emis, Hco, or Inv must have a corresponding entry in :file:`HEMCO_Diagn.rc`.

input.nml
^^^^^^^^^
:file:`HEMCO_Config.rc`
Contains emissions information used by HEMCO. Same function as in GEOS-Chem Classic except only HEMCO name, species, scale IDs, category, and hierarchy are used. Diagnostic frequency, file path, read frequency, and units are ignored, and are instead stored in GCHP config file :file:`ExtData.rc`. All HEMCO variables listed in :file:`HEMCO_Config.rc` for enabled emissions must also have an entry in :file:`ExtData.rc`.

Namelist used in advection for domain stack size and stretched grid parameters.
:file:`input.nml`
Namelist used in advection for domain stack size and stretched grid parameters.

HISTORY.rc
^^^^^^^^^^
:file:`logging.yml`
Config file for the NASA pFlogger package included in GCHP for logging. This package uses a hierarchy of loggers, such as info, warnings, error, and debug, to extract non-GEOS-Chem information about GCHP runs and print it to log file :file:`allPEs.log`.

Config file for the MAPL History component. Configures diagnostic output from GCHP.
:file:`HISTORY.rc`
Config file for the MAPL History component. Configures diagnostic output from GCHP.

:file:`HEMCO_Diagn.rc`
Contains information mapping :file:`HISTORY.rc` diagnostic names to HEMCO containers. Same function as in GEOS-Chem Classic except that not all items in :file:`HEMCO_Diagn.rc` will be output; only emissions listed in :file:`HISTORY.rc` will be included in diagnostics. All GCHP diagnostics listed in :file:`HISTORY.rc` that start with Emis, Hco, or Inv must have a corresponding entry in :file:`HEMCO_Diagn.rc`.

---------------------------------------------------------------------------------------------------

Expand Down

0 comments on commit 19f4dc8

Please sign in to comment.