- Hardware and Software Requirements
- Setting Up the GCHP Environment
- Downloading Source Code and Data Directories
- Obtaining a Run Directory
- Running GCHP: Basics
- Running GCHP: Configuration
- Output Data
- Developing GCHP
- Run Configuration Files
GCHP source code is downloadable from GitHub at https://github.com/geoschem/gchpctm. As with any repository on GitHub, you can fork the project to your own GitHub account and then clone your fork to your local machine, or you may clone directly from the GCHP GitHub page. Assuming you are doing the latter, clone GCHP with the following command:
git clone https://github.com/geoschem/gchpctm.git Code.GCHP
When cloning GCHP you will get the main branch by default.
Fill git submodules
GCHP includes many subdirectories that are themselves separate repositories on GitHub with their own version histories. These are stored in GCHP as git submodules and all of the git submodule folders will be empty when you first clone GCHP. To populate them you must enter a git command to update all submodules recursively, as follows:
cd Code.GCHP git submodule update --init --recursive
This command accesses the submodule repository and commit information stored in GCHP and then populates the submodule directories by accessing GitHub. See file .gitmodules within the top-level GCHP directory for a list of git submodules within GCHP.
Please note that each GCHP commit may point to a different collection of git submodule commits. If you change GCHP versions, therefore, you should always reapply the git submodule update command.
Download data directories
GCHP uses the same collection of input files as GEOS-Chem Classic. See the downloading GEOS-Chem data directories wiki page for more information.
Please be aware that new GEOS-Chem versions often require new input data as newer inventories become available. GEOS-Chem version wiki pages, e.g. GEOS-Chem 13.0.0, list new data directories in the version overview section at the top of the page. Pages for all versions can be accessed from the GEOS-Chem versions wiki page.