Difference between revisions of "GEOS-Chem required software"

From Geos-chem
Jump to: navigation, search
(Supported compilers for GEOS-Chem Classic)
(Recommended software packages)
Line 90: Line 90:
 
|}
 
|}
  
=== Recommended software packages ===
+
=== Optional but recommended software packages ===
  
 
{| border=1 cellspacing=0 cellpadding=5  
 
{| border=1 cellspacing=0 cellpadding=5  
Line 100: Line 100:
 
|[https://gcpy.readthedocs.io GCPy]
 
|[https://gcpy.readthedocs.io GCPy]
 
|GCPy is our recommended python companion software to GEOS-Chem.  While this is not a general-purpose plotting package, it does contain many useful functions for creating zonal mean and horizontal plots from GEOS-Chem output.  It also contains scripts to generate plots and tables from GEOS-Chem benchmark simulations.
 
|GCPy is our recommended python companion software to GEOS-Chem.  While this is not a general-purpose plotting package, it does contain many useful functions for creating zonal mean and horizontal plots from GEOS-Chem output.  It also contains scripts to generate plots and tables from GEOS-Chem benchmark simulations.
 +
 +
|-valign="top"
 +
|[https://www.gnu.org/software/gdb gdb] and [https://cgdb.github.io/ cgdb]
 +
|The GNU debugger (gdb) and its graphical interface (cgdb) are very useful tools for tracking down the source of GEOS-Chem errors, such as segmentation faults, out-of-bounds errors, etc.
 +
 +
|-valign="top"
 +
|[http://meteora.ucsd.edu/~pierce/ncview_home_page.html ncview]
 +
|ncview is a netCDF file viewer.  While it does not produce publication-quality output, ncview can let you easily examine the contents of a netCDF data file (such as those which are input and output by GEOS-Chem).  Ncview is very useful for debugging and development.
 +
  
 
|}
 
|}

Revision as of 15:15, 23 November 2020

Previous | Next | Getting Started with GEOS-Chem

  1. Minimum system requirements for GEOS-Chem
  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


GEOS-Chem Classic software environment

Supported compilers for GEOS-Chem Classic

The table below lists the supported compilers for GEOS-Chem.

GEOS-Chem is written in the Fortran programming language. However, you will also need C and C++ compilers to install certain libraries (like netCDF) on your system.

Item Description Versions
Intel Compiler Suite (icc, icpc, ifort) The Intel Compiler Suite is our recommended proprietary compiler collection.

Intel compilers produce well-optimized code that runs extremely efficiency on machines with Intel CPUs. Many universities and institutions will have an Intel site license that allows you to use these compilers.

The GCST has tested with these versions
(but others may work as well):
  • 19.0.5.281
  • 18.0.5
  • 17.0.4
  • 15.0.0
  • 13.0.079
  • 11.1.069
GNU Compiler Collection (gcc, g++, gfortran) The GNU Compiler Collection is our recommended open-source compiler collection.

Because the GNU Compiler Collection is free and open source, this is a good choice if your institution lacks an Intel site license, or if you are running GEOS-Chem on the Amazon EC2 cloud environment.

The GCST has tested with these versions
(but others may work as well):
  • 6.2.0
  • 7.1.0
  • 7.3.0
  • 7.4.0
  • 8.2.0
  • 9.2.0
  • 9.3.0

For more specific information about GCHP, please see:

Required software packages for GEOS-Chem Classic

Item Description
Git (a source code management system) GEOS-Chem source code can be downloaded using the Git source code management system. GEOS-Chem software repositories are stored at the https://github.com/geoschem organization page. Please see our Guide to using Git with GEOS-Chem for more information about how to use Git with GEOS-Chem.


CMake CMake is software that directs how the GEOS-Chem source code is compiled into an executable.
  • CMake is optional for GEOS-Chem versions 12.6.0 through 12.9.3.
  • CMake is REQUIRED for GEOS-Chem versions 13.0.0 and later.


netCDF and netCDF-Fortran
  • plus dependencies (e.g. HDF5, zlib, etc)
GEOS-Chem input and output data files use the netCDF file format. This is a self-describing file format that allows metadata (descriptive text) to be stored alongside data values. Please see our Guide to netCDF in GEOS-Chem for more information about the netCDF file format and software library.

Optional but recommended software packages

Item Description
GCPy GCPy is our recommended python companion software to GEOS-Chem. While this is not a general-purpose plotting package, it does contain many useful functions for creating zonal mean and horizontal plots from GEOS-Chem output. It also contains scripts to generate plots and tables from GEOS-Chem benchmark simulations.
gdb and cgdb The GNU debugger (gdb) and its graphical interface (cgdb) are very useful tools for tracking down the source of GEOS-Chem errors, such as segmentation faults, out-of-bounds errors, etc.
ncview ncview is a netCDF file viewer. While it does not produce publication-quality output, ncview can let you easily examine the contents of a netCDF data file (such as those which are input and output by GEOS-Chem). Ncview is very useful for debugging and development.


Required source code and data for GEOS-Chem Classic

Item Description
A clone of the geoschem/GCClassic repository The GCClassic repository is the "Superproject" for GEOS-Chem Classic. It is a lightweight wrapper for the geoschem/GEOS-Chem and geoschem/HEMCO repositories, in which the GEOS-Chem science codebase and HEMCO (Harmonized Emissions Component) codebase are stored.
The GEOS-Chem shared data directories This is the directory structure containing the meteorology and emissions data that GEOS-Chem reads as input. For more information, please see our Downloading GEOS-Chem data directories wiki page.
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.

GCHP software environment

Please see our GCHP Hardware and Software Requirements page for a list of GCHP software requirements.



Previous | Next | Getting Started with GEOS-Chem