View source for Downloading GCHP

__FORCETOC__
'''''[[GCHP_Hardware_and_Software_Requirements|Previous]] | [[Obtaining_a_GCHP_Run_Directory|Next]] | [[Getting_Started_With_GCHP|User Manual Home]] | [[GEOS-Chem_HP|GCHP Home]]'''''
#[[GCHP_Hardware_and_Software_Requirements|Hardware and Software Requirements]]
#<span style="color:blue">'''Downloading Source Code and Data Directories'''</span>
#[[Obtaining_a_GCHP_Run_Directory|Obtaining a Run Directory]]
#[[Setting_Up_the_GCHP_Environment|Setting Up the GCHP Environment]]
#[[Compiling_GCHP|Compiling]]
#[[GCHP_Basic_Example_Run|Basic Example Run]]
#[[Running_GCHP|Configuring a Run]]
#[[GEOS-Chem_HP_Output_Data|Output Data]]
#[[Developing_GCHP|Developing GCHP]]
#[[GCHP_Run_Configuration_Files|Run Configuration Files]]
<br>

== Overview ==

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. <tt>Code.12.0.0_gchp</tt> and <tt>Code.12.0.0_gcclassic</tt>. 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 <tt>main.F</tt> in the <tt>GeosCore</tt> directory; much of the functionality of this file is done instead in the <tt>GCHP/gigc_chunk_mod.F90</tt>.

==Step 1: Download GEOS-Chem==

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

 git clone https://github.com/geoschem/geos-chem.git Code.GCHP

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

<b>Note for advanced git users:</b> 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. See [[GEOS-Chem_coding_and_debugging#Submitting_updates_for_inclusion_into_GEOS-Chem|these instructions]] for more information.

==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 https://github.com/geoschem/gchp.git GCHP

==Step 3: Checkout GEOS-Chem version==

When you clone GEOS-Chem and GCHP you will always get the master branch. This is always the [[GEOS-Chem_12#Current_stable_version|current stable version of GEOS-Chem]]. You can determine the version label by typing "git log" within each repository and looking at the git tag string printed for the top-most commit. Always be sure that the versions you have in the two repositories are compatible. 

[[File:gchp Gittag.png|800px|thumb|Example output of git log. Notice tag name at top indicating what version this is.]]

If you would like an earlier version you can checkout the version tag for that specific version in both the <tt>GEOS-Chem</tt> and <tt>GCHP</tt> repositories. To see a list of available tags for a repository type "git tag". To checkout a tagged version type "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". However, we request that new updates always be built off of the master branch that is current at the time you begin work. We further recommend that you pull in future version updates as they are released.

If you are in doubt about how to use git with GEOS-Chem please contact the [[GEOS-Chem_Support_Team|GEOS-Chem Support Team]] for help. 

==Step 4: Download Shared Data Directories==

--------------------------------------

'''''[[GCHP_Hardware_and_Software_Requirements|Previous]] | [[Obtaining_a_GCHP_Run_Directory|Next]] | [[Getting_Started_With_GCHP|User Manual Home]] | [[GEOS-Chem_HP|GCHP Home]]'''''