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))
(GEOS-Chem Code structure (13.0.0 and later versions))
Line 9: Line 9:
 
!width="250px"|Code in GEOS-Chem 13.0.0
 
!width="250px"|Code in GEOS-Chem 13.0.0
 
!width="400px"|Description
 
!width="400px"|Description
!width="250px"|Location in prior versions
+
!width="225px"|Location in prior versions
!width="200px"|Notes
+
!width="225px"|Notes
  
 
|-valign="top"
 
|-valign="top"
Line 22: Line 22:
 
|Directory containing source code files for the [[Global_Terrestrial_Mercury_Model|Global Terrestrial Mercury Model (GTMM)]] simulation
 
|Directory containing source code files for the [[Global_Terrestrial_Mercury_Model|Global Terrestrial Mercury Model (GTMM)]] simulation
 
|<tt>GEOS-Chem/GTMM</tt>
 
|<tt>GEOS-Chem/GTMM</tt>
|GTMM simulation is currently broken
+
|
 +
*GTMM simulation is currently broken in GEOS-Chem 13.0.0
  
 
|-valign="top"
 
|-valign="top"
Line 63: Line 64:
 
|<tt>src/GEOS-Chem/KPP</tt>
 
|<tt>src/GEOS-Chem/KPP</tt>
 
|Main-level directory for the [[KPP_solvers_FAQ|KPP chemical solver]]
 
|Main-level directory for the [[KPP_solvers_FAQ|KPP chemical solver]]
|<tt>src/GEOS-Chem/KPP</tt>
+
|<tt>GEOS-Chem/KPP</tt>
 
|
 
|
  
Line 76: Line 77:
  
 
|-valign="top"
 
|-valign="top"
|<tt>Code/KPP/custom</tt>
+
|<tt>src/GEOS-Chem/KPP/custom</tt>
 
|Directory containing KPP source code files for creating custom mechanisms
 
|Directory containing KPP source code files for creating custom mechanisms
|<tt>Code/KPP/SOA_SVPOA</tt>
+
|<tt>GEOS-Chem/KPP/SOA_SVPOA</tt>
 
|
 
|
  
Line 84: Line 85:
 
|<tt>src/GEOS-Chem/KPP/int</tt>
 
|<tt>src/GEOS-Chem/KPP/int</tt>
 
|Directory containing the integrators (rosenbrock, runge-kutta, lsodes, etc.) for KPP
 
|Directory containing the integrators (rosenbrock, runge-kutta, lsodes, etc.) for KPP
|<tt>src/GEOS-Chem/KPP/int</tt>
+
|<tt>GEOS-Chem/KPP/int</tt>
 
|
 
|
  
Line 103: Line 104:
 
|Directory containing the [[ObsPack diagnostic]] code.
 
|Directory containing the [[ObsPack diagnostic]] code.
 
|<tt>GEOS-Chem/ObsPack</tt>
 
|<tt>GEOS-Chem/ObsPack</tt>
 +
|
 +
 +
|-valign="top"
 +
|<tt>src/GEOS-Chem/PKUCPL</tt>
 +
|Directory containing the PKU 2-way coupler code.
 +
|<tt>GEOS-Chem/PKUCPL</tt>
 
|
 
|
  

Revision as of 20:08, 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 GEOS-Chem 13.0.0 Description Location in prior versions
Code/HEMCO Main-level directory for HEMCO Yes, it calls down to the makefiles in the other HEMCO subdirectories.
Code/HEMCO/Core Directory containing HEMCO modules and routines for reading, storing, and updating data used for calculating emissions Yes, it compiles the code in HEMCO/Core and creates library file lib/libHCO.a.
Code/HEMCO/Extensions 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 HEMCO/Extensions and creates library file lib/libHCOX.a.
Code/HEMCO/Interfaces Directory containing HEMCO modules and routines that provide the link between HEMCO and the model environment Yes, it compiles the code in HEMCO/Interfaces and creates library file lib/libHCOI.a.