Directory Structure

This section describes a typical directory structure the user will be working with when running the TIEGCM model. The working directory (workdir) is the “root” directory of the user’s project.

The model directory (modeldir) is typically a subdirectory under the working directory, and contains the model source code, supporting scripts, documentation, and scripts for running tests.

The data directory (datadir) may also be a subdirectory under the working directory, or it may be on a large temporary disk that is accessible from the working directory. The data directory contains start-up and input data files for running the model.

Working Directory (workdir)

The user’s working directory will typically look something like this (the datadir can be on a large separate disk system):

   |           |             |            |
*.inp       execdir/     modeldir/     datadir/
*.job          |
*.out        *.o

Here, \*.inp are namelist input files, \*.job are job script s, and \*.out are are stdout files from model runs. The execdir is the build/execution directory (created by the first build), with object code (\*.o, \*.mod), model output history files (\*.nc), make files (Make\*), and an executable file (exec). Various other files may also be in the execdir. The modeldir and datadir directories are described below.

The job script in your working directory contains a shell variable specifying the modeldir, so it knows where to find the source code and supporting scripts for the build process. The namelist input file also refers to the datadir for start-up and other data input files (e.g., SOURCE, GPI_NCFILE, IMF_NCFILE, etc). These namelist parameters can use the environment variable TGCMDATA to specify the datadir (see section on namelist input files).

Model Directory (modeldir)

The model root directory is what you get when you download the model source code tar file. The model directory contains subdirectories with the model source code, supporting scripts, documentation, and test scripts:

   |               |                |                 |
  src/          scripts/           doc/             tests/
   |               |                |                 |
                 Make.*         userguide/         control/
  *.F          linux.job       description/      climatology/
  *.h           ibm.job          release/          dec2006
              default.inp       diags.table        nov2003/
             tgcm_contents      whi2008/

src/ directory contents:

  • Fortran source code *.F, *.h. The source code is f90 compliant, and most source files are in fixed-format fortran. There is a single header file, defs.h, which contains grid definitions and dimensions.

scripts/ directory contents:

  • Make.*: Makefiles containing platform-dependent compiler flags, Make variables, and library locations. For example, Make.intel_hao64. These file can be copied, renamed, and customized for the user’s platform/machine environment.
  • tiegcm-linux.job: Default model build/execute script for Linux systems.
  • tiegcm-ibm.job: Default model build/execute script for IBM/AIX systems.
  • tiegcm_default.inp: Default namelist input file.
  • tgcm_contents: Utility script to print “contents” of netCDF output history files.
  • tgcm_ncdump: Utility script to print an “ncdump” of history files, including data for scalars and 1-d vectors.

doc/ directory contents:

  • userguide/: Directory containing source files for the User’s Guide (this document)
  • description/: Directory containing source files for the TIEGCM Model Description
  • release/: Directory containing source files for the Release Documentation
  • diags.table: Table of diagnostic fields that can be saved on secondary history files.
  • Instructions for how to make a quick-start default build and execution of the model after downloading the source code and data.

tests/ directory contents:

  • README.tests: Summary of benchmark test runs made with the current version of the model
  • Several directories (climatology, control, dec2006, nov2003, etc) containing namelist input files and job scripts that can be used to reproduce the benchmark runs for validation and testing, comparing results from code changes, etc.
  • For more information on benchmark runs made for the current release, please see Release Documentation

Data Directory (datadir)

The public TIEGCM data directory is what you get when you download the data tar file. This directory is typically referred to with the environment variable TGCMDATA. Subsequently, after the data download, you may obtain additional needed data files from the NCAR Community Data Portal. Here is a partial schematic of the datadir (where “tiegcmx.xx” is the desired model version):

           |                      |
       gpi*.nc                tiegcmx.xx/
       gswm*.nc                   |
       imf *.nc          TGCM.tiegcmx.xx.p*.nc
         etc                pcntr*smin*.nc

Files listed on the left side refer to data input files that may be needed when running the model in different modes. These are netCDF files, specifically prepared for import into the TIEGCM model (they are not model start-up SOURCE files). These files are version-independent (can be used by (almost) any version of the model). They are usually provided to the model as namelist input parameters:

  • gpi*.nc GeoPhysical Indices data files (3-hourly Kp and F10.7 cm solar flux). Namelist Input parameter: GPI_NCFILE
  • gswm*.nc Global Scale Wave Model data files, used to specify tidal perturbations for the lower boundary of the TIEGCM. There are 4 separate files for diurnal, semi-diurnal, migrating and non-migrating tides. For the namelist input parameters, please see GSWM.
  • imf*.nc Interplanetary Magnetic Field OMNI data files. Namelist read parameter is IMF_NCFILE. These files contain data for the BX,BY,BZ components of the IMF, solar wind velocity and solar wind density.

The “tiegcmx.xx/” subdirectory refers to the version of the model that was downloaded. This subdirectory contains start-up SOURCE files from benchmark runs executed by that version of the model (see Section on Benchmark Test Runs). These files can be used to remake the benchmark runs for testing and validation. Here is an example of start-up files provided for benchmark runs made by TIEGCM version 1.94:

Table Of Contents

Previous topic

QuickStart Procedure

Next topic

Run Control Parameters: The Namelist Input File

This Page