Fixes for configuration sections

Signed-off-by: Lizzie Lundgren <elundgren@seas.harvard.edu>
geoschem · Jun 22, 2022 · 17da3ab · 17da3ab
1 parent 0d55a08
commit 17da3ab
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 20 deletions.
diff --git a/docs/source/user-guide/config-files/GCHP_rc.rst b/docs/source/user-guide/config-files/GCHP_rc.rst
@@ -1,9 +1,6 @@
 GCHP.rc
 =======
 
-GCHP.rc
-------------------
-
 :file:`GCHP.rc` is the resource configuration file for the ROOT component within GCHP. 
 The ROOT gridded component includes three children gridded components, including one each for GEOS-Chem, FV3 advection, and the data utility environment needed to support them.
 

diff --git a/docs/source/user-guide/configuration-files.rst b/docs/source/user-guide/configuration-files.rst
@@ -3,15 +3,8 @@
 Configuration files
 ===================
 
-All GCHP run directories have default simulation-specific run-time settings that are set in the configuration files. The many configuration files in GCHP can be overwhelming. However, you should be able to accomplish most if not all of what you wish to configure from one place in :file:`setCommonRunSettings.sh`.
-
-.. contents:: Table of contents
-    :depth: 4
-
----------------------------------------------------------------------------------------------------
-
-Configuration files
--------------------
+All GCHP run directories have default simulation-specific run-time settings that are set in the configuration files. The many configuration files in GCHP can be overwhelming.
+However, you should be able to accomplish most if not all of what you wish to configure from one place in :file:`setCommonRunSettings.sh`. That file is a bash script used to configure settings in other files from one place.
 
 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:
 
@@ -28,11 +21,6 @@ This section gives an overview of all run directory configuration files used at
    config-files/HISTORY_rc.rst
    config-files/HEMCO_Diagn_rc.rst
 
-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:
-
 :file:`setCommonRunSettings.sh`
 
    This file is 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.

diff --git a/docs/source/user-guide/rundir-config.rst b/docs/source/user-guide/rundir-config.rst
@@ -1,9 +1,7 @@
-
-
 Configure a run
 ===============
 
-All GCHP run directories have default simulation-specific run-time settings that are set in the configuration files. The many configuration files in GCHP can be overwhelming. However, you should be able to accomplish most if not all of what you wish to configure from one place in :file:`setCommonRunSettings.sh`. Use the rest of this guide to get acquainted with the configuration files and hone in on what to change based on what you would like to do.
+As noted earlier, the many configuration files in GCHP can be overwhelming but you should be able to accomplish most if not all of what you wish to configure from one place in :file:`setCommonRunSettings.sh`. Use this section to learn what to change in the run directory based on what you would like to do.
 
 .. contents:: Table of contents
     :depth: 4