NCL tools for GEOS-Chem

From Geos-chem
Jump to: navigation, search

NCL4GC, the NCL tools for GEOS-Chem, are in the initial phase of development, and are therefore very incomplete.
We will be developing NCL4GC as time allows. Check back here for further updates.

On this page we describe NCL4GC, which is a package of NCL routines designed for use with GEOS-Chem.

Overview

Text to be added

Installation

You can download NCL4GC via Git:

git clone https://bitbucket.org/gcst/ncl4gc NCL4GC

If you use csh or tcsh, make the following updates to your ~/.cshrc file:

# For NCL (NCAR command language)
setenv   NCARG_ROOT  "/opt/ncl-6.1.2"   # i.e. where you have installed NCL
unsetenv NCARG_LIB
unsetenv NCARG_DATABASE
unsetenv NCARG_FONTCAPS
unsetenv NCARG_GRAPHCAPS
unsetenv NCARG_NCARG
unsetenv NCARG_INCLUDE

# For NCL4GC (local NCL routines)
setenv   NCL4GC  "$HOME/NCL4GC"     # i.e. where you have installed NCL4GC

If you use bash, then add these updates to your ~/.bashrc file:

# For NCL (NCAR command language)
export NCARG_ROOT="/opt/ncl-6.1.2"   # i.e. where you have installed NCL
unset  NCARG_LIB
unset  NCARG_DATABASE
unset  NCARG_FONTCAPS
unset  NCARG_GRAPHCAPS
unset  NCARG_NCARG
unset  NCARG_INCLUDE

# For NCL4GC (local NCL routines)
export NCL4GC="$HOME/NCL4GC"    

You can use GNU Make to build the shared object libraries and documentation.

make all      # Builds both shared obj libs and doc
make help     # Displays help screen w/ other options

--Bob Y. 16:39, 6 December 2013 (EST)

Documentation

When you type either

make all

or

make doc

the documentation will be built in the doc/ subdirectory. There are 2 volumes:

NCL4GC_Reference_Vol1.pdf
NCL4GC Reference Guide Vol 1: NCL scripts for use with GEOS-Chem
NCL4GC_Reference_Vol2.pdf
Fortran code used to create NCL4GC shared object libraries

You can refer to these files for more information about a particular routine (how to call it, what inputs it takes, etc.)

Categories

The NCL4GC routines are subdivided into the following categories. Each of these categories is a subdirectory of the NCL4GC main directory:

file_io
NCL routines for manipulating netCDF files.
fortran
Fortran code used to build the shared object libraries
gc_manual
NCL routines used to create plots for the GEOS-Chem User's Guide.
gigc
NCL routines used to create and/or regrid files for the Grid-Independent GEOS-Chem code.
inputs
netCDF files (and the NCL routines used to create them) with the longitude & latitude definitions for the various horizontal grids used by GEOS-Chem.
regrid
NCL routines for regridding variables from netCDF files.

--Bob Y. 17:16, 7 April 2014 (EDT)