Difference between revisions of "Creating GEOS-Chem run directories"

From Geos-chem
Jump to: navigation, search
(Editing the CopyRunDirs.input file)
 
(52 intermediate revisions by 3 users not shown)
Line 1: Line 1:
On this page we show you how to use the [[GEOS-Chem Unit Tester]] to generate and use fresh copies of run directories for your GEOS-Chem simulations. 
+
__FORCETOC__
 +
'''''[[Downloading_GEOS-Chem_data_directories|Previous]] | [[GEOS-Chem configuration files|Next]] | [[Getting Started with GEOS-Chem]]'''''
 +
#[[Minimum system requirements for GEOS-Chem|Minimum system requirements (and software installation)]]
 +
#[[Configuring your computational environment]]
 +
#[[Downloading GEOS-Chem source code|Downloading source code]]
 +
#[[Downloading GEOS-Chem data directories|Downloading data directories]]
 +
#<span style="color:blue">'''Creating run directories'''</span>
 +
#[[GEOS-Chem configuration files|Configuring runs]]
 +
#[[Compiling GEOS-Chem|Compiling]]
 +
#[[Running GEOS-Chem|Running]]
 +
#[[GEOS-Chem output files|Output files]]
 +
#[[Python tools for use with GEOS-Chem]]
 +
#[[GEOS-Chem_coding_and_debugging|Coding and debugging]]
 +
#[[GEOS-Chem_overview#Further_reading|Further reading]]
  
== Downloading the GEOS-Chem Unit Tester ==
 
  
First, make sure that your system [[Debugging_with_the_GEOS-Chem_unit_tester#Requirements|has these software packages installed]].  (Most of these come standard with your Unix-based operating system.)
+
The method that you will use to download run directories changed in [[GEOS-Chem 13.0.0]].   
  
Next, clone the [[GEOS-Chem Unit Tester]] package with the command:
+
== For GEOS-Chem 13.0.0 and later versions ==
  
git clone <nowiki>https://bitbucket.org/gcst/geos-chem-unittest</nowiki> UT
+
This content has been migrated to the [https://geos-chem.readthedocs.io/en/latest/gcc-guide/02-build/create-rundir.html '''Create a run directory''' chapter of <tt>geos-chem.readthedocs.io</tt>.]
  
This will create a copy of the GEOS-Chem Unit Tester package in a directory named <tt>UT</tt> for short.
+
== For GEOS-Chem 12.9.3 and prior versions ==
  
''NOTE: The Git clone process may take a few minutes to complete depending on your connection speed.''
+
<span style="color:red"><big><strong>NOTE: The GEOS-Chem Unit Tester was retired for GEOS-Chem 13.0.0 and later versions.<br>
 +
This content is now outdated, but we will preserve it here for reference.</strong></big></span>
 +
----
  
--[[User:Bmy|Bob Yantosca]] ([[User talk:Bmy|talk]]) 15:12, 20 December 2016 (UTC)
+
First, make sure that your system [[Unit_Tester_for_GEOS-Chem_12#Requirements|has these software packages installed]](Most of these come standard with your Unix-based operating system.)
  
== Available run directories ==
+
Next, clone the [[GEOS-Chem Unit Tester]] package with these commands:
  
=== Benchmark run directory ===
+
git clone <nowiki>https://github.com/geoschem/geos-chem-unittest</nowiki> UT
 +
cd UT
 +
git checkout master
  
The [[GEOS-Chem Unit Tester]] includes a run directory called '''4x5_standard''' (GEOS-Chem v11-01 and later) or '''geosfp_4x5_benchmark''' (GEOS-Chem v10-01). The standard [http://acmg.seas.harvard.edu/geos/geos_benchmark.html GEOS-Chem benchmark simulation] utilizes the [[GEOS-FP]] met fields ([[GEOS-Chem_horizontal_grids#GMAO_4_x_5_grid|4&deg; x 5 &deg;]], [[GEOS-Chem_vertical_grids#72-layer_vertical_grid|72 levels]]) with the [[#UCX chemistry mechanism|UCX tropospheric-stratospheric chemistry mechanism]] and [[Secondary organic aerosols|secondary organic aerosols]] included.  
+
This will download a fresh copy of the <tt>GEOS-Chem-UnitTest</tt> repository into a directory named <tt>UT</tt>, and place you in the '''master''' branch.  The '''master''' branch always corresponds to the last benchmarked GEOS-Chem version.  
  
To reproduce our latest [[GEOS-Chem_v11-01_benchmark_history#v11-01k|1-month benchmark simulation for v11-01]], you can edit the <tt>CopyRunDirs.input</tt> file so that the following line is uncommented under <tt>RUNS</tt>:
+
If you would like to check out the Unit Tester that corresponds to a specific numbered GEOS-Chem version you can type one of the following commands:
  
  geosfp  4x5        -     standard    2013070100  2013080100  -
+
git checkout 12.0.0
 +
git checkout v11-02-rc
 +
git checkout v11-02e
  
Make sure to check the start and end date so that your simulation will run for July 2013. You can then create the GEOS-Chem benchmark run directory by typing <tt>./gcCopyRunDirs</tt>. Navigate to your the newly created <tt>geosfp_4x5_benchmark</tt> run directory. To compile and run your benchmark simulation, type:
+
etc.
  
make -j4 mp
+
''NOTE: The Git clone process may take a few minutes to complete depending on your connection speed.''
  
To compile only, type:
+
--[[User:Bmy|Bob Yantosca]] ([[User talk:Bmy|talk]]) 21:10, 21 June 2018 (UTC)
  
make -j4 mpbuild
+
== Available run directories ==
  
That will create a <tt>geos.mp</tt> executable file that you can use to submit your GEOS-Chem benchmark simulation to a queue system.
+
=== Benchmark run directory ===
  
<span style="color:darkorange">'''''NOTE: If you are compiling GEOS-Chem within the code directory, and not within a run directory created from the GEOS-Chem Unit Tester, you will need to pass the <tt>UCX=y</tt> option in your <tt>make</tt> command.'''''</span>
+
The [[GEOS-Chem Unit Tester]] includes a run directory called '''4x5_standard''' (GEOS-Chem v11-01 and later) or '''4x5_benchmark''' (GEOS-Chem v10-01). The standard [http://acmg.seas.harvard.edu/geos/geos_benchmark.html GEOS-Chem benchmark simulation] utilizes the [[GEOS-FP]] met fields ([[GEOS-Chem_horizontal_grids#GMAO_4_x_5_grid|4&deg; x 5 &deg;]], [[GEOS-Chem_vertical_grids#72-layer_vertical_grid|72 levels]]) with the [[#UCX chemistry mechanism|UCX tropospheric-stratospheric chemistry mechanism]] and [[Secondary organic aerosols|secondary organic aerosols]] included.
  
--[[User:Melissa Payer|Melissa Sulprizio]] ([[User talk:Melissa Payer|talk]]) 19:38, 23 June 2015 (UTC)
+
To reproduce our latest 1-month benchmark simulation, you can edit the <tt>CopyRunDirs.input</tt> file so that the following line is uncommented under <tt>RUNS</tt>:
  
=== Other run directories ===
+
  geosfp  4x5        -      benchmark    2016070100  2016080100  -
  
Run directories are provided for a combination of met field, grid, and simulation type and are named accordingly. For more details on the simulation types, please see our [[GEOS-Chem chemistry mechanisms|''GEOS-Chem chemistry mechanism'' wiki page]].
+
Make sure to check the start and end date so that your simulation will run for July 2016. You can then create the GEOS-Chem benchmark run directory by typing <tt>./gcCopyRunDirs</tt>. Navigate to your the newly created <tt>geosfp_4x5_benchmark</tt> run directory. To compile the GEOS-Chem source code, type:
  
The following table summarizes the run directories that are available in the [[GEOS-Chem Unit Tester]]. Please choose the run directories that are most relevant for your research.
+
make -j4 build
  
{| border=1 cellspacing=0 cellpadding=5
+
That will create a <tt>geos.mp</tt> executable file that you can use to submit your GEOS-Chem benchmark simulation to a queue system.
|-bgcolor="#CCCCCC"
+
!width="100px"|Met field(s)
+
!width="200px"|Grid
+
!width="100px"|[[GEOS-Chem_chemistry_mechanisms#Mechanisms_in_GEOS-Chem_v10-01_and_later_versions|Standard]]
+
!width="100px"|[[NOx-Ox-HC-aerosol|Tropchem]]
+
!width="100px"|[[UCX chemistry mechanism|UCX]]
+
!width="100px"|[[Secondary organic aerosols|SOA]]
+
!width="100px"|[[Secondary organic aerosols#SOA simulation with semi-volatile POA|SOA-SVPOA]]
+
!width="100px"|[[Mineral_dust_aerosols#Surface_chemistry_on_dust|AcidUptake]]
+
!width="100px"|[[Aerosol_emissions#Online_emission_of_marine_primary_organic_aerosol_.28POA.29|MarinePOA]]
+
!width="100px"|[[Coupling GEOS-Chem with RRTMG|RRTMG]]
+
!width="100px"|[[Rn-Pb-Be simulation|RnPbBe]]
+
!width="100px"|[[Mercury|Hg]]
+
!width="100px"|[[Mercury|tagHg]]
+
!width="100px"|[[POPs simulation|POPs]]
+
!width="100px"|[[Tagged CO simulation|tagCO]]
+
!width="100px"|[[Tagged O3 simulation|tagO3]]
+
!width="100px"|[[CH4 simulation|CH4]]
+
!width="100px"|[[CO2 simulation|CO2]]
+
!width="100px"|[[Aerosol-only simulation|aerosol]]
+
!width="100px"|[[TOMAS aerosol microphysics|TOMAS15]]
+
!width="100px"|[[TOMAS aerosol microphysics|TOMAS40]]
+
  
|-valign="top"
+
For older versions of GEOS-Chem, the compile command was formerly
|[[GEOS-FP]]<br>[[GEOS-5]]<br>[[MERRA]]<br>[[MERRA-2]]
+
|[[GEOS-Chem_horizontal_grids#GMAO_4_x_5_grid|4x5]]
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
  
|-valign="top"
+
make -j4 mpbuild
|[[GEOS-FP]]<br>[[GEOS-5]]<br>[[MERRA]]<br>[[MERRA-2]]
+
|[[GEOS-Chem_horizontal_grids#GMAO_2_x_2.5_grid|2x2.5]]
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|
+
|
+
  
|-bgcolor="#cccccc"
+
=== Other run directories ===
!colspan="21"|Nested grid simulations:
+
  
|-valign="top"
+
Run directories are provided for a combination of met field, grid, and simulation type and are named accordingly. For more details on the simulation types, please see our [[GEOS-Chem chemistry mechanisms|''GEOS-Chem chemistry mechanism'' wiki page]].
|[[GEOS-FP]]
+
|[[GEOS-Chem_horizontal_grids#0.25_x_0.3125_CH_nested_grid|025x03125<br>CH]]
+
|
+
|bgcolor="#00FF00"|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
 
+
|-valign="top"
+
|[[GEOS-FP]]
+
|[[GEOS-Chem_horizontal_grids#0.25_x_0.3125_NA_nested_grid|025x03125<br>NA]]
+
|
+
|bgcolor="#00FF00"|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
 
+
|-valign="top"
+
|[[GEOS-5]]
+
|[[GEOS-Chem_horizontal_grids#0.5_x_0.666_CH_nested_grid|05x0666<br>CH]]
+
|
+
|bgcolor="#00FF00"|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
 
+
|-valign="top"
+
|[[GEOS-5]]
+
|[[GEOS-Chem_horizontal_grids#0.5_x_0.666_NA_nested_grid|05x0666<br>NA]]
+
|
+
|bgcolor="#00FF00"|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|bgcolor="#00FF00"|
+
|
+
|
+
|
+
|
+
|bgcolor="#00FF00"|
+
|
+
|
+
|
+
|
+
 
+
|-bgcolor="#cccccc"
+
!colspan="21"|Other:
+
 
+
|-valign="top"
+
|[[GMAO_GEOS-4|GEOS-4]]
+
|[[GEOS-Chem_horizontal_grids#GMAO_4_x_5_grid|4x5]]
+
|
+
|bgcolor="#00FF00"|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|bgcolor="#00FF00"|
+
|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|bgcolor="#00FF00"|
+
|
+
|bgcolor="#00FF00"|
+
|
+
|
+
 
+
|-valign="top"
+
|[[GCAP]]
+
|[[GEOS-Chem_horizontal_grids#GMAO_4_x_5_grid|4x5]]
+
|
+
|bgcolor="#00FF00"|
+
|
+
|
+
|
+
|
+
|
+
|
+
|bgcolor="#00FF00"|
+
|
+
|
+
|bgcolor="#00FF00"|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
 
+
|}
+
 
+
'''LEGEND'''
+
{| border=1 cellspacing=0 cellpadding=5
+
|-valign="top"
+
|width="75px" bgcolor="#00FF00"|
+
|width="250px"|Run directory is available
+
 
+
|-valign="top"
+
|bgcolor="#FFFF00"|
+
|Run directory is in need of updating
+
 
+
|-valign="top"
+
|bgcolor="#FF0000"|
+
|Run directory is obsolete 
+
 
+
|-valign="top"
+
|
+
|Run directory is not available
+
 
+
|}
+
 
+
--[[User:Melissa Payer|Melissa Sulprizio]] ([[User talk:Melissa Payer|talk]]) 20:10, 8 December 2016 (UTC)
+
  
 
== Editing the CopyRunDirs.input file ==
 
== Editing the CopyRunDirs.input file ==
Line 489: Line 279:
 
  cp CopyRunDirs.input CopyRunDirs.fullchem  # Input file set up to only copy the full-chemistry run directories
 
  cp CopyRunDirs.input CopyRunDirs.fullchem  # Input file set up to only copy the full-chemistry run directories
 
    
 
    
  gcCopyRunDirs CopyRunDirs.Hg               
+
  ./gcCopyRunDirs CopyRunDirs.fullchem           
  
 
Executing <tt>gcCopyRunDirs</tt> will create a new GEOS-Chem run directory corresponding to each entry that you specified in the input file <tt>RUNS</tt> section.  Each run directory will be created as a subdirectory of <tt>COPY_PATH</tt> that you specified in the input file <tt>INPUTS</tt> section.
 
Executing <tt>gcCopyRunDirs</tt> will create a new GEOS-Chem run directory corresponding to each entry that you specified in the input file <tt>RUNS</tt> section.  Each run directory will be created as a subdirectory of <tt>COPY_PATH</tt> that you specified in the input file <tt>INPUTS</tt> section.
Line 501: Line 291:
 
And you will see this directory listing:
 
And you will see this directory listing:
  
  brc.dat
+
  benchmark.run
  dust.dat
+
  GEOSChem.Restart.20160701_0000z.nc4
FJX_j2j.dat
+
FJX_spec.dat
+
 
  getRunInfo
 
  getRunInfo
h2so4.dat
 
 
  HEMCO_Config.rc
 
  HEMCO_Config.rc
  HEMCO_restart.201307010000.nc
+
  HEMCO_Diagn.rc
 +
HISTORY.rc
 
  input.geos
 
  input.geos
jv_spec_mie.dat
 
 
  Makefile
 
  Makefile
org.dat
 
 
  output/
 
  output/
 
  README
 
  README
so4.dat
 
soot.dat
 
ssa.dat
 
ssc.dat
 
v11-01.run
 
 
  validate
 
  validate
  
Line 526: Line 307:
 
The <tt>input.geos</tt> and <tt>HEMCO_Config.rc</tt> files have been customized for this particular simulation.  They were created from the corresponding template files <tt>input.geos.template</tt> and <tt>HEMCO_Config.template</tt> in the Unit Tester. The Perl script <tt>getRunInfo</tt> is used by the Makefile to extract information about the simulation from <tt>input.geos</tt>. HEMCO and tracer restart files are also included in every run directory but care must be taken when using them. See the section below for more information about restart files.
 
The <tt>input.geos</tt> and <tt>HEMCO_Config.rc</tt> files have been customized for this particular simulation.  They were created from the corresponding template files <tt>input.geos.template</tt> and <tt>HEMCO_Config.template</tt> in the Unit Tester. The Perl script <tt>getRunInfo</tt> is used by the Makefile to extract information about the simulation from <tt>input.geos</tt>. HEMCO and tracer restart files are also included in every run directory but care must be taken when using them. See the section below for more information about restart files.
  
== Important Notes About Restart Files ==
 
 
Please see [[GEOS-Chem_basics#Restart_files|this post on the ''GEOS-Chem basics'' wiki page]] for more information about how to obtain sample restart files for your simulations.
 
 
== Tips and tricks for creating run directories ==
 
 
* You can create a run directory for the [[GEOS-Chem_nested_grid_simulations|nested grid simulations]] from a 4&deg; x 5&deg; or 2&deg; x 2.5&deg; run directory by following these steps:
 
*# Modify the <tt>input.geos</tt> file for the nested grid simulation. Complete instructions can be found on [[Setting_up_GEOS-Chem_nested_grid_simulations|this wiki page]].
 
*# Regrid the restart file(s) using the [http://acmg.seas.harvard.edu/gamap/doc/by_category/Regridding.html GAMAP regridding routines]. For example, [http://acmg.seas.harvard.edu/gamap/doc/by_category/Regridding.html#REGRIDH_RESTART REGRIDH_RESTART] can be used to regrid the tracer restart file from one horizontal resolution to another. You can then use [http://acmg.seas.harvard.edu/gamap/doc/by_alphabet/gamap_c.html#CREATE_NESTED CREATE_NESTED] to crop the restart file to your nested domain (CH, EU, or NA).
 
 
* If you would like to run a simulation and the run directory is not available in the Unit Tester, you can follow these steps:
 
*# Modify the <tt>input.geos</tt> file for your simulation type following the relevant checklist in [http://acmg.seas.harvard.edu/geos/doc/man/contents.html# Chapter 6 of the GEOS-Chem Manual].
 
*# Create a "fake" restart file using GAMAP routine [http://acmg.seas.harvard.edu/gamap/doc/by_alphabet/gamap_m.html#MAKE_RESTART MAKE_RESTART].
 
*# Alternatively, you can send an email to the relevant [http://acmg.seas.harvard.edu/geos/geos_working_groups.html Working Group] to see if another member can provide you with a run directory or restart file.
 
 
*The [[GEOS-Chem Unit Tester]] can be used to create run directories for [[GEOS-Chem v10-01]] and later versions. If you wish to download a run directory for an older version of GEOS-Chem, you can follow [http://acmg.seas.harvard.edu/geos/doc/archive/man.v9-02/chapter_2.html#DownRun these instructions].
 
 
--[[User:Melissa Payer|Melissa Sulprizio]] ([[User talk:Melissa Payer|talk]]) 18:42, 26 August 2015 (UTC)
 
 
== Compiling GEOS-Chem ==
 
 
Starting in v11-01, you can now compile GEOS-Chem directory from the run directory. See the[[GEOS-Chem_Makefile_Structure|GEOS-Chem Makefile Structure wiki page]] wiki page for more information about compiling GEOS-Chem and using the run directory Makefile.
 
 
--[[User:Lizzie Lundgren|Lizzie Lundgren]] ([[User talk:Lizzie Lundgren|talk]]) 15:07, 1 February 2017 (UTC)
 
 
== GEOS-Chem Output Files ==
 
 
Once the GEOS-Chem simulation is complete, you will see several new files in the run directory. Some of these are generated for all simulations while others may be simulation-dependent. For more information, see our [[GEOS-Chem Output Files|''GEOS-Chem Output Files'' wiki page]].
 
  
--[[User:Melissa Payer|Melissa Sulprizio]] ([[User talk:Melissa Payer|talk]]) 22:25, 5 February 2016 (UTC)
+
----
 +
'''''[[/Downloading_GEOS-Chem_data_directories|Previous]] | [[GEOS-Chem configuration files|Next]] | [[Getting Started with GEOS-Chem]]'''''

Latest revision as of 19:17, 16 September 2022

Previous | Next | Getting Started with GEOS-Chem

  1. Minimum system requirements (and software installation)
  2. Configuring your computational environment
  3. Downloading source code
  4. Downloading data directories
  5. Creating run directories
  6. Configuring runs
  7. Compiling
  8. Running
  9. Output files
  10. Python tools for use with GEOS-Chem
  11. Coding and debugging
  12. Further reading


The method that you will use to download run directories changed in GEOS-Chem 13.0.0.

For GEOS-Chem 13.0.0 and later versions

This content has been migrated to the Create a run directory chapter of geos-chem.readthedocs.io.

For GEOS-Chem 12.9.3 and prior versions

NOTE: The GEOS-Chem Unit Tester was retired for GEOS-Chem 13.0.0 and later versions.
This content is now outdated, but we will preserve it here for reference.


First, make sure that your system has these software packages installed. (Most of these come standard with your Unix-based operating system.)

Next, clone the GEOS-Chem Unit Tester package with these commands:

git clone https://github.com/geoschem/geos-chem-unittest UT
cd UT
git checkout master

This will download a fresh copy of the GEOS-Chem-UnitTest repository into a directory named UT, and place you in the master branch. The master branch always corresponds to the last benchmarked GEOS-Chem version.

If you would like to check out the Unit Tester that corresponds to a specific numbered GEOS-Chem version you can type one of the following commands:

git checkout 12.0.0
git checkout v11-02-rc
git checkout v11-02e

etc.

NOTE: The Git clone process may take a few minutes to complete depending on your connection speed.

--Bob Yantosca (talk) 21:10, 21 June 2018 (UTC)

Available run directories

Benchmark run directory

The GEOS-Chem Unit Tester includes a run directory called 4x5_standard (GEOS-Chem v11-01 and later) or 4x5_benchmark (GEOS-Chem v10-01). The standard GEOS-Chem benchmark simulation utilizes the GEOS-FP met fields (4° x 5 °, 72 levels) with the UCX tropospheric-stratospheric chemistry mechanism and secondary organic aerosols included.

To reproduce our latest 1-month benchmark simulation, you can edit the CopyRunDirs.input file so that the following line is uncommented under RUNS:

 geosfp   4x5         -      benchmark     2016070100   2016080100   -

Make sure to check the start and end date so that your simulation will run for July 2016. You can then create the GEOS-Chem benchmark run directory by typing ./gcCopyRunDirs. Navigate to your the newly created geosfp_4x5_benchmark run directory. To compile the GEOS-Chem source code, type:

make -j4 build

That will create a geos.mp executable file that you can use to submit your GEOS-Chem benchmark simulation to a queue system.

For older versions of GEOS-Chem, the compile command was formerly

make -j4 mpbuild

Other run directories

Run directories are provided for a combination of met field, grid, and simulation type and are named accordingly. For more details on the simulation types, please see our GEOS-Chem chemistry mechanism wiki page.

Editing the CopyRunDirs.input file

Once you have downloaded the GEOS-Chem Unit Tester to your disk space, switch to the perl/ directory:

cd UT/perl

In this directory there is a Perl script named gcCopyRunDirs that you will use to generate fresh copies of GEOS-Chem run directories. This script uses an input file named CopyRunDirs.input, which is also located in the perl directory.

IMPORTANT: The CopyRunDirs.input file that comes with the Unit Tester provides only a small sample of the possible run directories that you can create. You can add as many entries to the RUNS section as you wish. See the UnitTest.input file for a complete list of all possible run directories that you can add to CopyRunDirs.input.

Your CopyRunDirs.input file will look something like this:

#------------------------------------------------------------------------------
#                  GEOS-Chem Global Chemical Transport Model                  !
#------------------------------------------------------------------------------
#BOP
#
# !DESCRIPTION: Input file that specifies configuration for creating and
#  copying a run directory from the UnitTester. 
#\\
#\\
# !REMARKS:
#  For a complete description of how to customize the settings in the
#  INPUTS and RUNS sections, see the following wiki posts:
#
#   wiki.geos-chem.org/Creating_GEOS-Chem_run_directories#Section_1:_INPUTS
#   wiki.geos-chem.org/Creating_GEOS-Chem_run_directories#Section_2:_RUNS
#
# !REVISION HISTORY: 
#  18 Mar 2015 - R. Yantosca - Initial version
#  19 Mar 2015 - E. Lundgren - Simplify content for only copying run dirs
#  19 May 2015 - R. Yantosca - Now can specify VERBOSE and WARNINGS options
#EOP
#------------------------------------------------------------------------------
#
# !INPUTS:
#
# %%% ID tags %%%
#
   VERSION        : v11-01
   DESCRIPTION    : Create run directory from UnitTest
#
# %%% Data path and HEMCO settings %%%
#
   DATA_ROOT      : /n/holylfs/EXTERNAL_REPOS/GEOS-CHEM/gcgrid/data/ExtData
   HEMCO_ROOT     : {DATAROOT}/HEMCO
   VERBOSE        : 0
   WARNINGS       : 1
#
# %%% Unit tester path names %%%
#
   UNIT_TEST_ROOT : {HOME}/UT
   RUN_ROOT       : {UTROOT}/runs
   RUN_DIR        : {RUNROOT}/{RUNDIR}
   PERL_DIR       : {UTROOT}/perl
#
# %%% Target directory and copy command %%%
# 
   COPY_PATH      : {HOME}/GC/rundirs
   COPY_CMD       : cp -rfL
#
# !RUNS:
#  Specify the runs directories that you want to copy below.
#  Here we provide a few examples, but you may copy additional entries from
#  UnitTest.input and modify the dates as needed. You can deactivate copying
#  run certain directories by commenting them out with "#".
#
#--------|-----------|------|------------|------------|------------|---------|
# MET    | GRID      | NEST | SIMULATION | START DATE | END DATE   | EXTRA?  |
#--------|-----------|------|------------|------------|------------|---------|
  geosfp   4x5         -      standard     2013070100   2013080100   -
# geosfp   4x5         -      gc_timing    2013070100   2013070800   -
# geosfp   4x5         -      tropchem     2013070100   2013070101   -
# geosfp   4x5         -      soa          2013070100   2013070101   -
# geosfp   4x5         -      soa_svpoa    2013070100   2013070101   -
# geosfp   4x5         -      aciduptake   2013070100   2013070101   -
# geosfp   4x5         -      UCX          2013070100   2013070101   -
# geosfp   4x5         -      RRTMG        2013070100   2013070101   -
# geosfp   4x5         -      RnPbBe       2013070100   2013070101   -
# geosfp   4x5         -      Hg           2013010100   2013010101   -
# geosfp   4x5         -      POPs         2013070100   2013070101   -
# geosfp   4x5         -      TOMAS40      2013070100   2013070101   -
# geosfp   4x5         -      CH4          2013070100   2013070101   -
# geosfp   4x5         -      tagO3        2013070100   2013070101   -
# geosfp   4x5         -      tagCO        2013070100   2013070101   -
# geosfp   2x25        -      CO2          2013070100   201307010030 -
# geosfp   4x5         -      aerosol      2013070100   2013070101   - 
# geosfp   025x03125   ch     tropchem     2013070100   201307010010 -
# geosfp   025x03125   na     tropchem     2013070100   201307010010 -
# gchp     4x5         -      tropchem     2013070100   2013070101   -
!END OF RUNS:
#EOP
#------------------------------------------------------------------------------

NOTE: Lines starting with a # character will be treated as comments.

The CopyRunDirs.input file has a layout that is very similar to the GEOS-Chem Unit Tester input files (UnitTest.input located within this directory). Like the GEOS-Chem Unit Tester input files, CopyRunDirs.input is composed of an INPUTS section and a RUNS section, which are described below.

Section 1: INPUTS

Under the INPUTS section, you can customize the directory paths and other options for your system. Each configurable input is described in the table below.

Option Description
VERSION An ID tag that will be added to all log files and output files.
DESCRIPTION A short (1-sentence) description of the purpose of this specific file (optional). This may be used to differentiate different input files, such as if you pre-configure several for future re-use.
DATA_ROOT Specifies the path for your root-level data directory.
HEMCO_ROOT Specifies the top-level path for the HEMCO data directory tree.
  • The {DATAROOT} token in HEMCO_ROOT will be replaced with the value you specify for RUN_ROOT option.

Leave this as-is.

VERBOSE Specifies the level of debug output that will be sent to the HEMCO log file. (0=no debug output; 3=max debug output)
  • Recommended setting: 0
WARNINGS Specifies the level of warning messages that will be sent to the HEMCO log file. (0=no warnings; 3=max warnings)
  • Recommended setting: 1
UNIT_TEST_ROOT Specifies the path to the GEOS-Chem Unit Tester.
RUN_ROOT Specifies the top-level unit test run directories.

Leave this as-is.

RUN_DIR Specifies the run directory subdirectory.

Leave this as-is.

PERL_DIR Specifies the directory where the unit test Perl scripts are found.

Leave this as-is.

COPY_PATH Specifies the directory on your disk server where copies of the GEOS-Chem run directories will be created.
COPY_CMD Specifies the command used to copy run directories from the GEOS-Chem Unit Tester to COPY_PATH.
  • The default setting is cp -rfL. This will create a new copy of the directory, even if the prior copy exists.
  • The -L option to the cp will create "hard" copies of files that are symbolic links. This command may differ slightly depending on the flavor of your Unix-based Operating system.

Section 2: RUNS

The layout of the RUNS section is identical to the RUNS section in the GEOS-Chem Unit Tester input file. This enables copying and pasting simulation settings text from UnitTest.input into CopyRunDirs.input.

For example, the following line:

#
# !RUNS:
#  Specify the debugging runs that you want to perform below.
#  You can deactivate runs by commenting them out with "#".
#
#--------|-----------|------|------------|------------|------------|---------|
# MET    | GRID      | NEST | SIMULATION | START DATE | END DATE   | EXTRA?  |
#--------|-----------|------|------------|------------|------------|---------|
  geosfp   4x5         -      standard     2013070100   2013080100   -

will tell the gcCopyRunDirs script to create a run directory for a GEOS-Chem simulation with the following settings:

The date range will be used to initialize the input.geos file that is read during a GEOS-Chem simulation. Once the run directory is created, you may edit these dates within the input.geos file. Note, however, that time ranges must remain within the time range covered by the MET field you are using. You can check the MET field temporal coverage on the GMAO met data products wiki page. Also note that we recommend using the restart files to spin up GEOS-Chem for at least one year prior to your simulation start date. You may use the resulting output restart files as initial values for your simulation.

You can add as many entries to the RUNS section as you wish. See the UnitTest.input file for a complete list of all possible run directories entries that you can add to CopyRunDirs.input.

Generating a GEOS-Chem Run Directory

Once you have edited the CopyRunDirs.input script to your liking, you can use that to generate fresh copies of GEOS-Chem run directories. Make sure you are in the perl directory, and then type:

./gcCopyRunDirs

If you do not pass a file name to gcCopyRunDirs, then the gcCopyRunDirs script will use the CopyRunDirs.input file that you just modified.

If you wish, you can create many customized copies of CopyRunDirs.input. For example, suppose you edit CopyRunDirs.input to generate a full-chemistry run directory. You can then save it as a separate file and use it explicitly with gcCopyRunDirs.

cp CopyRunDirs.input CopyRunDirs.fullchem   # Input file set up to only copy the full-chemistry run directories
 
./gcCopyRunDirs CopyRunDirs.fullchem            

Executing gcCopyRunDirs will create a new GEOS-Chem run directory corresponding to each entry that you specified in the input file RUNS section. Each run directory will be created as a subdirectory of COPY_PATH that you specified in the input file INPUTS section.

Let's examine the contents of a sample geosfp_4x5_standard run directory. Navigate to your newly created run directory and tssue the following commands:

make fileclean                       # Remove any files left over from previous unit test runs

ls -1                                # Get directory listing

And you will see this directory listing:

benchmark.run
GEOSChem.Restart.20160701_0000z.nc4
getRunInfo
HEMCO_Config.rc
HEMCO_Diagn.rc
HISTORY.rc
input.geos
Makefile
output/
README
validate

NOTE: Run directories for other simulations may contain other files not pictured here.

The input.geos and HEMCO_Config.rc files have been customized for this particular simulation. They were created from the corresponding template files input.geos.template and HEMCO_Config.template in the Unit Tester. The Perl script getRunInfo is used by the Makefile to extract information about the simulation from input.geos. HEMCO and tracer restart files are also included in every run directory but care must be taken when using them. See the section below for more information about restart files.



Previous | Next | Getting Started with GEOS-Chem