Downloading GCHP

From Geos-chem
Revision as of 17:37, 8 August 2018 by Lizzie Lundgren (Talk | contribs) (Overview)

Jump to: navigation, search

Previous | Next | Getting Started with GCHP

  1. Hardware and Software Requirements
  2. Downloading Source Code
  3. Obtaining a Run Directory
  4. Setting Up the GCHP Environment
  5. Compiling
  6. Basic Example Run
  7. Run Configuration Files
  8. Advanced Run Examples
  9. Output Data
  10. Developing GCHP


GCHP is built to wrap around a standard GEOS-Chem Classic installation. The first step to obtaining GCHP is therefore to clone the standard GEOS-Chem source code repository. Enabling GCHP functionality simply involves the added step of cloning the GCHP source code repository to store as a subdirectory within GEOS-Chem.

Acquiring the GCHP subdirectory does not change anything in the standard GEOS-Chem code; you can use the same source code to run regular non-GCHP GEOS-Chem simulations. However, we recommend that you keep separate GEOS-Chem source code directories for use with GCHP and GEOS-Chem Classic, e.g. Code.12.0.0_gchp and Code.12.0.0_gcclassic. This avoids confusion and extra work since each requires separate compilation. You also may want to develop and test them separately

Please note that certain files in GEOS-Chem Classic source code will be present but ignored when running GCHP. Most notably this includes main.F in the GeosCore directory; much of the functionality of this file is done instead in the GCHP/gigc_chunk_mod.F90.

Step 1: Download GEOS-Chem

Clone the GEOS-Chem repository on Github to a directory name of your choosing.

git clone Code.gchp

Take note of the path where the code was downloaded. In this example let's say the source code is stored at /mypath/GCHP/Code.gchp.

Note for advanced git users: If you plan on developing GEOS-Chem updates to submit for inclusion in the model we recommend that you fork the repository on Github and clone it from your own account. You can then make pull requests when you are ready to submit updates to the GEOS-Chem Support Team. If you have no idea what this means do not worry about it.

Step 2: Download GCHP within GEOS-Chem

Navigate to your GEOS-Chem code directory that you just downloaded and clone the GCHP repository on Github:

cd /mypath/GCHP/Code.gchp
git clone GCHP

Step 3: Know Your Version

GCHP is functional in all benchmarked versions of GEOS-Chem starting with v11-02b. When you clone the master branch of GEOS-Chem you always get the last benchmarked version. See the GCHP v11-02 and the primary GEOS-Chem v11-02 wiki pages for information on available versions and what updates they include. If you would like an earlier version you can checkout the version tag for that specific version in both the GEOS-Chem and GCHP repositories.

To see a list of available tags for a repository:

git tag

To checkout a tagged version:

git checkout tags/tagname

When you checkout a tag beware that you will be in what is called a detached HEAD status. This means you are not officially on a git branch. Committing in this state risks losing your changes since they are not associated with an actual git branch. If you plan on developing code in the version you checkout you should therefore create a branch to work in:

git checkout -b mybranch

Since GCHP includes two different repositories, GEOS-Chem and GCHP, be sure to do this in both of your repositories. Also always be sure that the versions you have in the two repositories are compatible. One way to quickly check if your versions are where you think they are is to use gitk, a graphical repository browser which shows tags on top of the version history. Beware that you must have X11 forwarding enabled if using ssh.

If you are still in doubt about what version you are using or if your two repository versions are compatible, please contact the GEOS-Chem Support Team for help.

Previous | Next | GCHP Home

--Lizzie Lundgren (talk) 16:20, 7 March 2018 (UTC)