Difference between revisions of "GEOS-Chem directory structure"

From Geos-chem
Jump to: navigation, search
(Code directory structure)
(Code directory structure)
Line 21: Line 21:
  
 
== Code directory structure ==
 
== 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) ===
 
=== GEOS-Chem Code structure (13.0.0 and later versions) ===

Revision as of 20:37, 7 December 2020

Previous | Next | Getting Started with GEOS-Chem

  1. Minimum system requirements
  2. Installing required software
  3. Configuring your computational environment
  4. Downloading source code
  5. Downloading data directories
  6. Creating run directories
  7. Configuring runs
  8. Compiling
  9. Running
  10. Output files
  11. Visualizing and processing output
  12. Coding and debugging
  13. Further reading


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).

Code folder or routine 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
src/GEOS-Chem/Interfaces/main.F90 Main driver program for GEOS-Chem "Classic". GEOS-Chem/GeosCore/main.F90

HEMCO code structrure (version 3.0.0 and later)

Code folder or routine Description Location in prior versions Notes
src/HEMCO Main-level directory for HEMCO GEOS-Chem/HEMCO
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
src/HEMCO/src/Interfaces Directory containing HEMCO modules and routines that provide the link between HEMCO and the model environment GEOS-Chem/HEMCO/Interfaces
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



Previous | Next | Getting Started with GEOS-Chem