The GEOS-Chem Support Team has created this page to assist new GEOS-Chem users to download and run GEOS-Chem on their computer systems.
- 1 Overview
- 2 Unix resources
- 3 The GNU Make utility
- 4 The Git source code management system
- 5 Fortran resources
- 6 The netCDF library
- 7 The GEOS-Chem source code
- 8 The GEOS-Chem Unit Tester
- 9 The GEOS-Chem shared data directories
- 10 Restart files
- 11 Visualization packages
- 12 The GEOS-Chem website
- 13 The GEOS-Chem wiki
- 14 GEOS-Chem tutorials
- 15 For more information
Before you can run GEOS-Chem, you will need to have the following items. Some of these will be already pre-installed on your computer system.
an account on the Amazon Web Services cloud
|You will need a Unix operating system environment in order to run GEOS-Chem. Any flavor of Unix (e.g. CentOS, Ubuntu, Fedora, etc.) should work just fine.
If your institution has computational resources (e.g. a shared computer cluster with many cores, sufficient disk storage and memory), then you can run GEOS-Chem there. Contact your IT staff for assistance.
If your institution lacks computational resources (or if you need additional computational resources beyond what is available), then you should consider signing up for access to the Amazon Web Services cloud. Using the cloud has the following advantages:
We will post more information about how to get set up on the Amazon Web Services cloud shortly.
|GNU Make||GNU Make directs the compilation sequence. It tells the compiler the order in which files should be compiled, which compilation options to use.
You probably won't have to install GNU Make, since it comes with most Unix distributions by default. GNU Make will also be available for you on the Amazon cloud.
|Git (a source code management system)||The Git source-code management software is a free and open-source package that we use to enforce strict version control. You will also Git to download the GEOS-Chem source code and the GEOS-Chem Unit Teseter.
Git is usually installed by default with most Unix distributions. It will also be available for you on the Amazon cloud.
|A Fortran compiler||GEOS-Chem is written in the Fortran language. A Fortran compiler is used to create an executable file from the GEOS-Chem source code. You can use either the GNU Fortran Compiler (aka gfortran) or the Intel Fortran Compiler (aka ifort) to compile GEOS-Chem.
If you have an account on a shared computer cluster at your institution, chances are that you will at least have a GNU Fortran Compiler version installed, and maybe a version of Intel Fortran installed as well. Ask your IT staff for more information.
You will need the GNU Fortran Compiler to compile GEOS-Chem on the Amazon cloud. This will already be available for you, so you won't have to install it manually.
|A netCDF library installation||GEOS-Chem uses the netCDF file format for I/O. Many GEOS-Chem restart and diagnostic output files are written to netCDF format.
If you are using GEOS-Chem on a local computer cluster, then you (or your IT staff) will need to install a version of netCDF. Chances are there might be one or more netCDF versions pre-installed for you. Ask your IT staff for assistance.
If you are using GEOS-Chem on the Amazon cloud, then a netCDF library will already be available for you to use.
|A GEOS-Chem source code directory||This directory contains the GEOS-Chem source code, which the compiler will assemble into an executable file.
The GEOS-Chem source code can be downloaded via Git from our repository on Bitbucket.org.
|The GEOS-Chem Unit Tester||The GEOS-Chem Unit Tester is used to error-check all of the GEOS-Chem simulations. It is also needed to construct GEOS-Chem run directories, in which the compiled executable file will run.|
|The GEOS-Chem shared data directories||Directory structure containing the meteorology and emissions data that GEOS-Chem reads as input.
If you are using GEOS-Chem on a local computational cluster, then you will need to download these data manually. We recommend to:
The shared data directories for GEOS-Chem v11-02 and higher versions will be available on the Amazon cloud, so you won't have to download them. You may need to tell your login environment where to find these data. We will post more information on this shortly.
|Restart files for GEOS-Chem||These are the files containing the initial conditions for a GEOS-Chem simulation. They can be downloaded from our data archive via FTP.
|A visualization package||This is software that is used to read and plot output from GEOS-Chem simulations.
Traditionally, the IDL-based GAMAP has been used for plotting GEOS-Chem-generated data. Starting with GEOS-Chem v11-02, you will have the option to save diagnostic output directly to netCDF data. This will give you the option to open-source plotting packages based in the Python language.
Please also see our GEOS-Chem User's Guide for complete information about how to set up a GEOS-Chem simulation.
GEOS-Chem documentation and support
We have compiled a list of online GEOS-Chem documentation.
|The GEOS-Chem Support Team (aka GCST)||
|The GEOS-Chem website (geos-chem.org)||
|The GEOS-Chem wiki (wiki.geos-chem.org)||
|The GEOS-Chem User's Guide
|The GEOS-Chem FAQ||
|GEOS-Chem tutorial presentations||
|Coding and debugging tips||
GEOS-Chem is designed to run on computers with the Unix operating system. There is no single version of Unix; rather, Unix comes packaged in several different distributions. Many modern computer clusters use CentOS, which is an open-source Unix implementation. Other systems may use a proprietary Unix distribution, such as Red Hat Enterprise. GEOS-Chem will perform in the same way regardless of the specific Unix implementation on your system.
If you require assistance setting up or customizing your Unix login environment, please contact your local IT staff. The GEOS-Chem Support Team can only provide support for GEOS-Chem-related issues.
Very soon you will also have the opportunity to run GEOS-Chem on the Amazon Web Services cloud infrastructure. We will post more information about that shortly.
IMPORTANT! Please make sure that your computer system meets the minimum system requirements for memory and disk space in order to run GEOS-Chem.
Common Unix commands
The resources below cover many common Unix commands. You will find these useful, particularly if you have never worked on a Unix machine before.
- Thirty useful Unix commands (U. Cambridge)
- Summary of Unix commands (PDF doc)
- A Brief Introduction to Unix (by Corey Satten)
- The 15 Essential Unix commands (by Pete Freitag)
Unix shells and shell scripting
One of the nice features of Unix is that you can highly customize your environment. You can also write scripts to perform several commands (such as copying files or running programs) sequentially. This will save you the trouble of having to type the same commands over and over at the command-line prompt.
There are several Unix shells that you can use, but we recommend using bash. Here are some resources that you can use to learn more about the bash shell:
- What is the .bashrc file on SuperUser
- The Bash Shell Startup Files from Beyond Linux from Scratch
- LinuxCommand.org—interactive tutorial
- How to use the Unix alias command
- Bash Guide for Beginners
- Advanced Bash scripting
- Bash programming—Introduction How-To
Perl is a language that is often used for writing scripts. A Perl parser comes pre-installed with your Unix distribution. Perl provides many of the same features as do Unix shell scripts, but also make it very easy to do text comparison and manipulations.
For more information about writing Perl scripts, please see:
- Perl in 20 pages
- Beginning Perl by Simon Cozens (free online book)
- Robert's Perl Tutorial
- Comprehensive Perl Archive Network (CPAN.org)
The GNU Make utility
The GNU Make utility is used to compile GEOS-Chem—that is, to create an executable file from source code. GNU Make usually comes pre-packaged with your Unix distribution (e.g. CentOS, Linux, Ubuntu, Fedora, etc.), so you will probably not need to install it yourself.
GEOS-Chem contains several Makefiles. A Makefile contains several commands in the GNU Make language direct how the Fortran compiler will build GEOS-Chem. Makefiles determine the sequence in which individual files are compiled, as well as the options that will be activated.
Unless you are going to be adding a significant amount of new code into GEOS-Chem, you will probably not need to know the nitty-gritty details of how to create or modify Makefiles. But if you do have to change an existing Makefile, you can contact the GEOS-Chem Support Team, who will be happy to assist you.
If you are interested in learning more about the GNU Make utility, we invite you to consult the following resources:
- The GNU Make manual
- GNU Make in detail for beginners at OpenSource.com
- Using Make and writing makefiles at Swarthmore U.
- Make at wikibooks.org
- Managing projects with GNU Make by O'Reilly
For specific information about compiling GEOS-Chem, see:
The Git source code management system
Given the large number of user code submissions, robust source code management techniques must be employed in order to ensure the integrity of the GEOS–Chem code. The GEOS-Chem Support Team has selected the Git version control software for GEOS–Chem source code management.
There are several useful online resources for Git. We recommend starting with:
- GEOS-Chem wiki: Version control with Git
- GEOS-Chem wiki: Using Git with GEOS-Chem
- Our list of tutorials about Git
- git-scm.com—The official Git site
GEOS-Chem is written in the Fortran computer language, and relies upon of the new features that were introduced with the Fortran-90 standard. We list below several useful resources for your reference. Please also see our list of supported compiler versions.
If you are new to Fortran (or are familiar with the older Fortran-77 standard but not Fortran-90), then we invite you to take one or more of these tutorials:
- Introduction to Modern Fortran (Cambridge Univ, UK)
- Victor Decyk (UCLA) Fortran tutorial
- Fortran 90 for the Fortran 77 programmer
- Using OpenMP parallelization with Fortran
The GNU Fortran compiler
GEOS-Chem v11-01 and newer versions are compatible with the GNU Fortran compiler, aka gfortran. This is a free and open-source compiler that comes pre-installed on many modern computer systems. This will be our recommended compiler, starting with GEOS-Chem v11-02.
If you will be running GEOS-Chem on the Amazon Web Services cloud computing environment, we recommend that you use GNU Fortran.
The Intel Fortran compiler
Many users compile GEOS-Chem with the Intel Fortran compiler (aka ifort).
- Intel Fortran compiler page on the GEOS-Chem wiki
- Intel Fortran Compiler manual (Version 11.1)
- Intel Fortran Compiler manual (Version 12.1)
- Intel Fortran Compiler manual (Version 15.0)
The netCDF library
GEOS-Chem reads and writes data in the netCDF file format. NetCDF is a self-describing format, which means that it can keep data fields together with "metadata"—the information describing each data field— in the same file. This makes it very easy to share GEOS-Chem output with other researchers.
netCDF on Amazon cloud
If you are running GEOS-Chem on the Amazon Web Services cloud, then you will initialize your Unix environment with a machine image that contains a pre-built netCDF library. So you will not need to build the netCDF library yourself.
The GEOS-Chem Support Team is currently preparing the Amazon cloud environment for GEOS-Chem. We will post more information about this shortly.
netCDF on your system
Ask your IT staff if a version of netCDF has already been pre-built on your system. On many systems, the IT staff will create several different builds of netCDF to accommodate different compilers (and sometimes MPI versions). You may be able to load a netCDF library version with the module command, i.e.
module load netcdf
Your system might also permit the use of Docker containers, which will allow you to load a pre-built Unix environment with all necessary libraries, including netCDF.
We have also collated the following references about netCDF, which you might find useful.
- Our Preparing data files for use with HEMCO page on the GEOS-Chem wiki
- netCDF Home Page
- netCDF Documentation
- NCL (NCAR Command Language) (useful for netCDF and other file I/O)
The GEOS-Chem source code
The GEOS-Chem model source code is kept in a publicly-accessible Git repository. You must compile the source code into an executable file with one of the supported Fortran compilers. The compilation is managed by the GNU Make utility, which reads the various GEOS-Chem makefiles to produce the executable with the desired options.
You can download the source code for the latest GEOS-Chem version if you have Git installed on your system. For more information and detailed downloading instructions, please see:
- GEOS-Chem User's Guide: Chapter 2: Requirements for installing GEOS-Chem
- GEOS-Chem User's Guide: Chapter 5: The GEOS-Chem source code directory
- GEOS-Chem User's Guide: Chapter 7: Compiling GEOS-Chem
- GEOS-Chem wiki: Setting Unix environment variables for GEOS-Chem
- GEOS-Chem wiki: Downloading GEOS-Chem source code and data
The GEOS-Chem Unit Tester
The GEOS-Chem Unit Tester is a package of scripts and Makefiles that will compile and run several GEOS-Chem with a set of standard debugging flags. The Unit Tester is one of our best GEOS-Chem debugging tools. For more information, please see:
- GEOS-Chem wiki: GEOS-Chem Unit Tester
Creating run directories with the Unit Tester
You can use the GEOS-Chem Unit Tester to create a run directory specific to the GEOS-Chem simulation that you want to perform. A run directory is where the GEOS-Chem executable file will be placed. You will normally keep GEOS-Chem run directories in your own disk space. The run directories contain several input files which are used to "customize" the GEOS-Chem simulation as follows:
- To specify start and end dates of simulation
- To specify which GEOS-Chem options to turn on/off
- To specify the species/reactions/cross-sections in the photolysis mechanism
- To specify diagnostic output options
For more information, please see the following resources:
- GEOS-Chem wiki: Creating GEOS-Chem run directories
- GEOS-Chem wiki: Downloading GEOS-Chem source code and data
- GEOS-Chem wiki: HEMCO data directories
- GEOS-Chem wiki: Setting up the ExtData directory
In addition to the files contained in the run directories, GEOS-Chem also needs to access data directories containing:
- Meteorological data (a.k.a. the "met fields) used to drive GEOS–Chem
- Emissions inventories used by GEOS-Chem
- Scale factors used to scale emissions from a base year to a given year
- Oxidant (OH, O3) concentrations for both full-chemistry and offline simulations
- IPCC future scenarios (for GCAP simulatons)
- Other GEOS–Chem specific data files.
These files are often too large to store in a single user's disk space. Therefore, they are meant to be stored in shared disk space where all GEOS-Chem users in your group can have access to them.
The GEOS-Chem shared data directories can be downloaded from archives at Harvard University and Dalhousie University. Unlike the source code and run directories, the data directory download can be done either by anonymous FTP or by the freely-available GNU wget utility. (We recommend wget because it is much more flexible and can be used to download several directories recursively.)
For more information and detailed downloading instructions, please see:
- GEOS-Chem wiki: Downloading GEOS-Chem source code and data
- GEOS-Chem wiki: HEMCO data directories
- GEOS-Chem wiki: Setting up the ExtData directory
- GEOS-Chem wiki: Restart files
You will need a restart file before you can start your GEOS-Chem simulation. A restart file contains the initial conditions for a GEOS-Chem simulation. There are two restart files for GEOS-Chem:
- GEOS-Chem restart file containing instantaneous species concentrations (Required)
- HEMCO restart file containing values needed for some of the HEMCO extensions (Optional)
When you run a GEOS-Chem simulation, it will write new GEOS-Chem restart files at the intervals you specify in input.geos. New HEMCO restart files are written with frequency configured in HEMCO_Config.rc if HEMCO is used in your simulation.
CAVEAT: The initial restart files do not reflect the actual atmospheric state and should only be used to "spin up" the model. In other words, they should be used as initial values in an initialization simulation to generate more accurate initial conditions for your production runs.
Doing a one year spin up is usually sufficient; however, we recommend ten years for ozone, carbon dioxide, and methane simulations, and four years for radon-lead-beryllium simulations. If you are in doubt about how long your spin up should be for your simulation, we recommend contacting the GEOS-Chem Working Group that specializes in your area of research.
You may spin up the model starting at any year for which there is met data, but you should always start your simulations at the month and day corresponding to the restart file to more accurately capture seasonal variation. If you want to start your production run at a specific date, we recommend doing a spin up for the appropriate number of years plus the number of days needed to reach your ultimate start date. For example, if you want to do a production simulation starting on 12/1/13, you could spin up the model for one year using the initial GEOS-FP restart file dated 7/1/13 and then use the new restart file to spin up the model for five additional months, from 7/1/13 to 12/1/13.
To determine the date of a netCDF restart file, you may use ncdump For example:
ncdump -v time -t initial_GEOSChem_rst.4x5_standard.nc
The -t option will return the time value in human-readable date-time strings rather than numerical values in unit such as "hours since 1985-1-1 00:00:0.0." The date of a binary punch restart file can be determined by opening the file in GAMAP.
Using a HEMCO restart file for your initial spin up run is optional. The HEMCO restart file contains fields for initializing variables required for Soil NOx emissions, MEGAN biogenic emissions, and the UCX chemistry mechanism. The HEMCO restart file that comes with a run directory may only be used for the date and time indicated in the filename. HEMCO will automatically recognize when a restart file is not available for the date and time required, and in that case HEMCO will use default values to initialize those fields. You can also force HEMCO to use the default initialization values by setting "HEMCO_RESTART" to false in HEMCO_Config.rc. For more information, see the HEMCO User's Guide.
You can read more about restart files at the GEOS-Chem output files wiki page.
In this section we provide information about software packages that you can use to analyze and plot GEOS-Chem output.
GAMAP and other IDL software
NOTE: IDL, which is proprietary software, can be very expensive. For this reason, the GEOS-Chem Support Team and other GEOS-Chem developers are currently developing several open-source software packages (mostly based on Python) for GEOS-Chem data analysis and visualization. Please see our Python software section below.
The traditional GEOS-Chem visualization software is GAMAP. This package was customized to GEOS-Chem and is still heavily used today. GAMAP requires the Interactive Data Language (a proprietary package). For more information about GAMAP, please see:
- GAMAP web page
- GAMAP online manual
- Documentation for individual GAMAP routines
- GEOS-Chem wiki: GAMAP tips and tricks
We have also compiled a list of other useful IDL software sites.
Several developers have started creating Python-based visualization software for GEOS-Chem. Please see the following page for more information:
- GEOS-Chem wiki: Python code for GEOS-Chem
- GCPy: Python powered GEOS-Chem data analysis/visualization (Currently under development)
If you are new to programming in Python, you may find these tutorials useful:
The GEOS-Chem website
The GEOS-Chem website is located at http://www.geos-chem.org.
From this website you may:
- Read a welcome letter which outlines user responsibilities
- Read the online GEOS-Chem User's Guide
- Access GEOS-Chem-related publications
- View online presentations from GEOS-Chem user meetings
- See a list of who is using GEOS-Chem at other institutions
- Obtain information about the GAMAP visualization package
Also, please take a minute to read the GEOS-Chem overview page. This document outlines the responsibilities for all GEOS-Chem users.
PLEASE NOTE: At this time, the GEOS-Chem User's Guide is only viewable in HTML.
The GEOS-Chem wiki
The wiki has many features that are designed to facilitate communication between GEOS-Chem users and developers. The following informaton is posted on the wiki:
- The latest public version and current version in development
- Getting started with GEOS-Chem
- Technical Information
- Information about the specifics of:
- Chemistry mechanisms and specialty simulations
- A list of bugs and when they were fixed
- Information about meteorology used as input to GEOS-Chem
- Information about data visualization and analysis
The Main Page of the wiki contains links to several commonly-read pages. If you can't find your desired topic, the best way to search for information on the wiki is by using the Search Box located in the upper right corner of each wiki page.
We encourage all GEOS-Chem code developers and users to check the wiki frequently, as this is the place where the latest information about GEOS-Chem will be posted. The wiki is designed to be a two-way street of communication. Users should feel free to add content to the wiki pages that are most closely related to their research.
In particular, the GEOS-Chem Support Team has begun an effort to make sure that all 3rd-party code and data that is submitted into GEOS-Chem has a corresponding wiki page. This will ensure that all information can be shared transparently.
The best way to find information on the GEOS-Chem wiki is to use the Search Box located in the upper right corner of each wiki page. The Main Page has links to several topics on the wiki but it does not link to every single page.
You can let the GEOS-Chem wiki inform you of recent updates to the site via RSS. Click here to find out how. You will never miss a discussion!
All GEOS-Chem wiki posts can be read by anyone. However, to add or modify wiki pages, you will need to register for a wiki account. Simply click on the "Log In/Create Account" link at the top right of your browser window. The GEOS-Chem support team will confirm your account request (this is an anti-spamming measure).
We invite all GEOS-Chem users to read our post about wiki user culture.
Please see the following GEOS-Chem tutorials, mostly taken from previous GEOS-Chem meetings:
- GEOS-Chem for beginners (IGC8 model clinic)
- GEOS-Chem for advanced users (IGC8 model clinic)
- GEOS-Chem adjoint (IGC8 model clinic)
- GEOS-Chem in massively parallel and ESM environments (IGC7 model clinic)
For more information
You can find much more information about GEOS-Chem on our website and wiki. We invite you to consult the following resources:
- GEOS-Chem User's Guide
- The HEMCO User's Guide
- Frequently asked questions about GEOS-Chem
- What should I do if my GEOS-Chem simulation dies with an error?
- Where can I find information about GEOS-Chem performance and GEOS-Chem Scalability?
- Is there a comprehensive list of bugs and when they were fixed?