Difference between revisions of "GEOS-Chem directory structure"

From Geos-chem
Jump to: navigation, search
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
__FORCETOC__
 
__FORCETOC__
'''''[[Downloading GEOS-Chem source code (12.9.3 and earlier versions)|Previous]] | [[Downloading GEOS-Chem data directories|Next]] | [[Getting Started with GEOS-Chem]]'''''
+
'''''[[Downloading GEOS-Chem source code|Previous]] | [[Downloading GEOS-Chem data directories|Next]] | [[Getting Started with GEOS-Chem]]'''''
#[[Minimum system requirements for GEOS-Chem|Minimum system requirements]]
+
#[[Minimum system requirements for GEOS-Chem|Minimum system requirements )]]
#[[Installing required software]]
+
 
#[[Configuring your computational environment]]
 
#[[Configuring your computational environment]]
 
#[[Downloading GEOS-Chem source code|Downloading source code]]
 
#[[Downloading GEOS-Chem source code|Downloading source code]]
#*[[Downloading GEOS-Chem source code (13.0.0 and later versions)|... for GEOS-Chem 13.0.0 and later versions]]
 
#*[[Downloading GEOS-Chem source code (12.9.3 and earlier versions)|... for GEOS-Chem 12.9.3 and earlier versions]]
 
 
#*<span style="color:blue">'''GEOS-Chem directory structure'''</span>
 
#*<span style="color:blue">'''GEOS-Chem directory structure'''</span>
 
#[[Downloading GEOS-Chem data directories|Downloading data directories]]
 
#[[Downloading GEOS-Chem data directories|Downloading data directories]]
Line 19: Line 16:
  
  
 
+
This content has been migrated to the [https://geos-chem.readthedocs.io/en/latest/gcclassic_supplement/directory-structure.html '''GEOS-Chem Classic folder tree''' chapter of <tt>geos-chem.readthedocs.io</tt>].
== Code directory structure ==
+
 
+
The tables below list the folders in which various components of GEOS-Chem and HEMCO reside.
+
 
+
=== 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).
+
 
+
{| border=1 cellspacing=0 cellpadding=5
+
|- bgcolor="#CCCCCC"
+
!width="375px"|Code folder or routine
+
!width="375px"|Description
+
!width="225px"|Location in prior versions
+
!width="225px"|Notes
+
 
+
|-valign="top"
+
|<tt>GCClassic/src/GEOS-Chem</tt>
+
|Main-level directory for the GEOS-Chem "science codebase".
+
|<tt>GEOS-Chem</tt>
+
|
+
 
+
|-valign="top"
+
|<tt>GCClassic/src/GEOS-Chem/GTMM</tt>
+
|Directory containing source code files for the [[Global_Terrestrial_Mercury_Model|Global Terrestrial Mercury Model (GTMM)]] simulation
+
|<tt>GEOS-Chem/GTMM</tt>
+
|
+
*GTMM simulation is currently broken in GEOS-Chem 13.0.0
+
 
+
|-valign="top"
+
|<tt>GCClassic/src/GEOS-Chem/GeosCore</tt>
+
|Directory containing most GEOS-Chem modules and routines
+
|<tt>GEOS-Chem/GeosCore</tt>
+
|
+
 
+
|-valign="top"
+
|<tt>GCClassic/src/GEOS-Chem/GeosRad</tt>
+
|Directory containing source code files for the [[Coupling_GEOS-Chem_with_RRTMG|RRTMG radiative transfer model]]
+
|<tt>GEOS-Chem/GeosRad</tt>
+
|
+
 
+
|-valign="top"
+
|<tt>GCClassicsrc/GEOS-Chem/GeosUtil</tt>
+
|Directory containing GEOS-Chem utility modules
+
|<tt>GEOS-Chem/GeosUtil</tt>
+
|
+
 
+
|-valign="top"
+
|<tt>GCClassic/src/GEOS-Chem/Headers</tt>
+
|Directory containing module files with fixed parameters and derived-type definitions
+
|<tt>GEOS-Chem/Headers</tt>
+
|
+
 
+
|-valign="top"
+
|<tt>GCClassic/src/GEOS-Chem/History</tt>
+
|Directory containing module files to archive diagnostics from GEOS-Chem "Classic" simulations to netCDF file format
+
|<tt>GEOS-Chem/History</tt>
+
|
+
 
+
|-valign="top"
+
|<tt>GCClasic/src/GEOS-Chem/ISORROPIA</tt>
+
|Directory containing the [[ISORROPIA_II|ISORROPIA II]] source code files
+
|<tt>GEOS-Chem/ISORROPIA</tt>
+
|
+
 
+
|-valign="top"
+
|<tt>GCClassic/src/GEOS-Chem/KPP</tt>
+
|Main-level directory for the [[KPP_solvers_FAQ|KPP chemical solver]]
+
|<tt>GEOS-Chem/KPP</tt>
+
|
+
 
+
|-valign="top"
+
|<tt>GCClassic/src/GEOS-Chem/KPP/fullchem</tt>
+
|Directory containing KPP source code files for the GEOS-Chem "full-chemistry" mechanism
+
|
+
|Prior versions used these code folders:
+
*<tt>GEOS-Chem/KPP/Standard</tt>
+
*<tt>GEOS-Chem/KPP/Tropchem</tt>
+
*<tt>GEOS-Chem/KPP/SOA_SVPOA</tt>
+
 
+
|-valign="top"
+
|<tt>GCClassic/src/GEOS-Chem/KPP/custom</tt>
+
|Directory containing KPP source code files for creating custom mechanisms
+
|<tt>GEOS-Chem/KPP/SOA_SVPOA</tt>
+
|
+
 
+
|-valign="top"
+
|<tt>GCClassic/src/GEOS-Chem/KPP/int</tt>
+
|Directory containing the integrators (rosenbrock, runge-kutta, lsodes, etc.) for KPP
+
|<tt>GEOS-Chem/KPP/int</tt>
+
|
+
 
+
|-valign="top"
+
|<tt>GCClassic/src/GEOS-Chem/NcdfUtil</tt>
+
|Directory containing source code files for netCDF I/O. This code is from Bob Yantosca's NcdfUtilities package
+
|<tt>GEOS-Chem/NcdfUtil</tt>
+
|
+
 
+
|-valign="top"
+
|<tt>GCClassic/src/GEOS-Chem/NcdfUtil/perl</tt>
+
|Directory containing perl scripts from the NcdfUtilities package that can be used to generate Fortran code for defining, writing, and reading a netCDF file
+
|<tt>GEOS-Chem/NcdfUtil/perl</tt>
+
|
+
 
+
|-valign="top"
+
|<tt>GCClassic/src/GEOS-Chem/ObsPack</tt>
+
|Directory containing the [[ObsPack diagnostic]] code.
+
|<tt>GEOS-Chem/ObsPack</tt>
+
|
+
 
+
|-valign="top"
+
|<tt>GCClassic/src/GEOS-Chem/PKUCPL</tt>
+
|Directory containing the PKU 2-way coupler code.
+
|<tt>GEOS-Chem/PKUCPL</tt>
+
|
+
 
+
|-valign="top"
+
|<tt>GCClassic/src/GEOS-Chem/Interfaces/main.F90</tt>
+
|Main driver program for GEOS-Chem "Classic".
+
|<tt>GEOS-Chem/GeosCore/main.F90</tt>
+
|
+
 
+
|}
+
 
+
=== HEMCO code structrure (version 3.0.0 and later) ===
+
 
+
{| border=1 cellspacing=0 cellpadding=5
+
|- bgcolor="#CCCCCC"
+
!width="375px"|Code folder or routine
+
!width="375px"|Description
+
!width="225px"|Location in prior versions
+
!width="225px"|Notes
+
 
+
|-valign="top"
+
|<tt>GCClassic/src/HEMCO</tt>
+
|Main-level directory for [[HEMCO]]
+
|<tt>GEOS-Chem/HEMCO</tt>
+
|
+
 
+
|-valign="top"
+
|<tt>GCClassic/src/HEMCO/src/Core</tt>
+
|Directory containing HEMCO modules and routines for reading, storing, and updating data used for calculating emissions
+
|<tt>GEOS-Chem/HEMCO/Core</tt>
+
|
+
 
+
|-valign="top"
+
|<tt>GCClassic/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
+
|<tt>GEOS-Chem/HEMCO/Extensions</tt>
+
|
+
 
+
|-valign="top"
+
|<tt>GCClassic/src/HEMCO/src/Interfaces</tt>
+
|Directory containing HEMCO modules and routines that provide the link between HEMCO and the model environment
+
|<tt>GEOS-Chem/HEMCO/Interfaces</tt>
+
|
+
 
+
|-valign="top"
+
|<tt>GCClassic/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
+
 
+
|}
+
  
  
 
----
 
----
'''''[[Downloading GEOS-Chem source code (12.9.3 and earlier versions)|Previous]] | [[Downloading GEOS-Chem data directories|Next]] | [[Getting Started with GEOS-Chem]]'''''
+
'''''[[Downloading GEOS-Chem source code|Previous]] | [[Downloading GEOS-Chem data directories|Next]] | [[Getting Started with GEOS-Chem]]'''''

Revision as of 14:54, 4 August 2022

Previous | Next | Getting Started with GEOS-Chem

  1. Minimum system requirements )
  2. Configuring your computational environment
  3. Downloading source code
    • GEOS-Chem directory structure
  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


This content has been migrated to the GEOS-Chem Classic folder tree chapter of geos-chem.readthedocs.io.



Previous | Next | Getting Started with GEOS-Chem