Difference between revisions of "GEOS-Chem directory structure"

From Geos-chem
Jump to: navigation, search
(GEOS-Chem Code structure (13.0.0 and later versions))
(HEMCO code structrure (version 3.0.0 and later))
Line 118: Line 118:
 
{| border=1 cellspacing=0 cellpadding=5  
 
{| border=1 cellspacing=0 cellpadding=5  
 
|- bgcolor="#CCCCCC"
 
|- bgcolor="#CCCCCC"
!width="300px"|Code in GEOS-Chem 13.0.0
+
!width="250px"|Code in HEMCO 3.0.0
 
!width="400px"|Description
 
!width="400px"|Description
!width="300px"|Location in prior versions
+
!width="225px"|Location in prior versions
 +
!width="225px"|Notes
  
 
|-valign="top"
 
|-valign="top"
Line 128: Line 129:
  
 
|-valign="top"
 
|-valign="top"
|<tt>Code/HEMCO/Core</tt>
+
|<tt>src/HEMCO/src/Core</tt>
 
|Directory containing HEMCO modules and routines for reading, storing, and updating data used for calculating emissions
 
|Directory containing HEMCO modules and routines for reading, storing, and updating data used for calculating emissions
|Yes, it compiles the code in <tt>HEMCO/Core</tt> and creates library file <tt>lib/libHCO.a</tt>.
+
|<tt>GEOS-Chem/HEMCO/Core</tt>
 +
|
  
 
|-valign="top"
 
|-valign="top"
|<tt>Code/HEMCO/Extensions</tt>
+
|<tt>src/HEMCO/src/Extensions</tt>
 
|Directory containing HEMCO modules and routines for calculating emissions that depend on meteorological input variables and/or non-linear parameterizations
 
|Directory containing HEMCO modules and routines for calculating emissions that depend on meteorological input variables and/or non-linear parameterizations
|Yes, it compiles the code in <tt>HEMCO/Extensions</tt> and creates library file <tt>lib/libHCOX.a</tt>.
+
|<tt>GEOS-Chem/HEMCO/Extensions/tt>
 +
|
  
 
|-valign="top"
 
|-valign="top"
|<tt>Code/HEMCO/Interfaces</tt>
+
|<tt>src/HEMCO/src/Interfaces</tt>
 
|Directory containing HEMCO modules and routines that provide the link between HEMCO and the model environment
 
|Directory containing HEMCO modules and routines that provide the link between HEMCO and the model environment
|Yes, it compiles the code in <tt>HEMCO/Interfaces</tt> and creates library file <tt>lib/libHCOI.a</tt>.
+
|<tt>GEOS-Chem/HEMCO/Interfaces/tt>
 +
 
 +
|-valign="top"
 +
|<tt>src/HEMCO/src/Shared</tt>
 +
|Directory containing HEMCO modules and routines that provide the link between HEMCO and the model environment
 +
| -
 +
|Not present in earlier versions
  
 
|}
 
|}

Revision as of 20:11, 7 December 2020

Code directory structure

GEOS-Chem Code structure (13.0.0 and later versions)

The table below lists the directory structure in GEOS-Chem 12 along with descriptions of each subdirectory and its Makefile (if one is present).

Code in GEOS-Chem 13.0.0 Description Location in prior versions Notes
src/GEOS-Chem Main-level directory for GEOS-Chem GEOS-Chem
src/GEOS-Chem/GTMM Directory containing source code files for the Global Terrestrial Mercury Model (GTMM) simulation GEOS-Chem/GTMM
  • GTMM simulation is currently broken in GEOS-Chem 13.0.0
src/GEOS-Chem/GeosCore Directory containing most GEOS-Chem modules and routines GEOS-Chem/GeosCore
src/GEOS-Chem/GeosRad Directory containing source code files for the RRTMG radiative transfer model GEOS-Chem/GeosRad
src/GEOS-Chem/GeosUtil Directory containing GEOS-Chem utility modules GEOS-Chem/GeosUtil
src/GEOS-Chem/Headers Directory containing module files with fixed parameters and derived-type definitions GEOS-Chem/Headers
src/GEOS-Chem/History Directory containing module files to archive diagnostics from GEOS-Chem "Classic" simulations to netCDF file format GEOS-Chem/History
src/GEOS-Chem/ISORROPIA Directory containing the ISORROPIA II source code files GEOS-Chem/ISORROPIA
src/GEOS-Chem/KPP Main-level directory for the KPP chemical solver GEOS-Chem/KPP
src/GEOS-Chem/KPP/fullchem Directory containing KPP source code files for the GEOS-Chem "full-chemistry" mechanism Prior versions used these code folders:
  • GEOS-Chem/KPP/Standard
  • GEOS-Chem/KPP/Tropchem
  • GEOS-Chem/KPP/SOA_SVPOA
src/GEOS-Chem/KPP/custom Directory containing KPP source code files for creating custom mechanisms GEOS-Chem/KPP/SOA_SVPOA
src/GEOS-Chem/KPP/int Directory containing the integrators (rosenbrock, runge-kutta, lsodes, etc.) for KPP GEOS-Chem/KPP/int
src/GEOS-Chem/NcdfUtil Directory containing source code files for netCDF I/O. This code is from Bob Yantosca's NcdfUtilities package GEOS-Chem/NcdfUtil
src/GEOS-Chem/NcdfUtil/perl Directory containing perl scripts from the NcdfUtilities package that can be used to generate Fortran code for defining, writing, and reading a netCDF file GEOS-Chem/NcdfUtil/perl
src/GEOS-Chem/ObsPack Directory containing the ObsPack diagnostic code. GEOS-Chem/ObsPack
src/GEOS-Chem/PKUCPL Directory containing the PKU 2-way coupler code. GEOS-Chem/PKUCPL

HEMCO code structrure (version 3.0.0 and later)

Code in HEMCO 3.0.0 Description Location in prior versions Notes
Code/HEMCO Main-level directory for HEMCO Yes, it calls down to the makefiles in the other HEMCO subdirectories.
src/HEMCO/src/Core Directory containing HEMCO modules and routines for reading, storing, and updating data used for calculating emissions GEOS-Chem/HEMCO/Core
src/HEMCO/src/Extensions Directory containing HEMCO modules and routines for calculating emissions that depend on meteorological input variables and/or non-linear parameterizations GEOS-Chem/HEMCO/Extensions/tt>
<tt>src/HEMCO/src/Interfaces Directory containing HEMCO modules and routines that provide the link between HEMCO and the model environment GEOS-Chem/HEMCO/Interfaces/tt>
<tt>src/HEMCO/src/Shared Directory containing HEMCO modules and routines that provide the link between HEMCO and the model environment - Not present in earlier versions