Difference between revisions of "Downloading GEOS-Chem source code"

From Geos-chem
Jump to: navigation, search
(Overview)
Line 4: Line 4:
 
#[[Configuring your computational environment]]
 
#[[Configuring your computational environment]]
 
#<span style="color:blue">'''Downloading source code'''</span>
 
#<span style="color:blue">'''Downloading source code'''</span>
#*[[Downloading GEOS-Chem source code (13.0.0 and later versions)|... for GEOS-Chem 13.0.0 and later versions]]
 
#*[[Downloading GEOS-Chem source code (12.9.3 and earlier versions)|... for GEOS-Chem 12.9.3 and earlier versions]]
 
 
#*[[GEOS-Chem directory structure]]
 
#*[[GEOS-Chem directory structure]]
 
#[[Downloading GEOS-Chem data directories|Downloading data directories]]
 
#[[Downloading GEOS-Chem data directories|Downloading data directories]]
Line 16: Line 14:
 
#[[GEOS-Chem_coding_and_debugging|Coding and debugging]]
 
#[[GEOS-Chem_coding_and_debugging|Coding and debugging]]
 
#[[GEOS-Chem_overview#Further_reading|Further reading]]
 
#[[GEOS-Chem_overview#Further_reading|Further reading]]
 
 
  
  
Line 24: Line 20:
 
== For GEOS-Chem 13.0.0 and later versions ==
 
== For GEOS-Chem 13.0.0 and later versions ==
  
This content has been migrated to  [https://geos-chem.readthedocs.io/en/latest/gcc-guide/02-build/get-code.html The '''Download source code''' chapter of <tt>geos-chem.readthedocs.io</tt>]
+
Detailed instructions may be found at the [https://geos-chem.readthedocs.io/en/latest/gcc-guide/02-build/get-code.html '''Download source code''' chapter of <tt>geos-chem.readthedocs.io</tt>]
 
+
== For GEOS-Chem 12.9.3 and earlier versions ===
+
  
=== Overview ===
+
== For GEOS-Chem 12.9.3 and earlier versions ==
  
The GEOS-Chem source code is maintained on Github.com at '''https://github.com/geoschem/geos-chem'''. All [https://github.com/geoschem/geos-chem/releases official GEOS-Chem releases] shall originate from that Git repository.
+
The GEOS-Chem source code is maintained on Github.com at '''https://github.com/geoschem/geos-chem'''. All [https://github.com/geoschem/geos-chem/releases official GEOS-Chem releases] prior to 13.0.0 originated from that Git repository.
  
 
We also recommend that you view this video tutorial, which is posted at our GEOS_Chem Youtube channel: [http://youtube.geos-chem.org '''youtube.geos-chem.org''']:
 
We also recommend that you view this video tutorial, which is posted at our GEOS_Chem Youtube channel: [http://youtube.geos-chem.org '''youtube.geos-chem.org''']:

Revision as of 14:52, 4 August 2022

Previous | Next | Getting Started with GEOS-Chem

  1. Minimum system requirements (and installing software)
  2. Configuring your computational environment
  3. Downloading source code
  4. Downloading data directories
  5. Creating run directories
  6. Configuring runs
  7. Compiling
  8. Running
  9. Output files
  10. Python tools for use with GEOS-Chem
  11. Coding and debugging
  12. Further reading


You can download the GEOS-Chem source code to your computer system using Git. But the way in which you will download GEOS-Chem source code changed starting with GEOS-Chem 13.0.0. This was necessary due to structural modifications that were introduced in GEOS-Chem 13.0.0.

For GEOS-Chem 13.0.0 and later versions

Detailed instructions may be found at the Download source code chapter of geos-chem.readthedocs.io

For GEOS-Chem 12.9.3 and earlier versions

The GEOS-Chem source code is maintained on Github.com at https://github.com/geoschem/geos-chem. All official GEOS-Chem releases prior to 13.0.0 originated from that Git repository.

We also recommend that you view this video tutorial, which is posted at our GEOS_Chem Youtube channel: youtube.geos-chem.org:

Getting Started with GC Thumbnail.png
Click HERE to view!

You can download the latest stable version of GEOS-Chem by typing the following at the command line:

 git clone https://github.com/geoschem/geos-chem Code.X.Y.Z

This will create an exact copy (or clone) of the official GEOS-Chem repository to your local disk space in a directory named Code.X.Y.Z. You may name the code directory whatever you like, but we recommend using the version number (i.e. X.Y.Z) in the code directory name. For more information on the meaning of X.Y.Z, see our GEOS-Chem version numbering system page. Note that although you've named your code directory Code.X.Y.Z, this code will be the latest stable version of GEOS-Chem by default (which may or may not be version X.Y.Z). If you want to change GEOS-Chem versions, see the instructions below.

Note for advanced users

If you plan on developing GEOS-Chem updates to submit for inclusion in the standard model we recommend that you fork the repository on Github and clone it from your own account. You can then make a pull request when you are ready to submit updates to the GEOS-Chem Support Team. See these instructions for more information.

Choosing a different version

When you clone GEOS-Chem you will always get the master branch. This is the current stable version of GEOS-Chem. You can determine the version label by typing git log --decorate within each repository and looking at the git tag string printed for the top-most commit.

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. To see a list of available tags for a repository type git tag. To checkout a tagged version type git checkout -b NewBranch tags/tagname, where NewBranch can be a name of your choosing.

You can download as many copies of the GEOS-Chem source code as you wish. For example, you might want to keep a clean source code directory and then have one or more source code directories that you use for development or debugging. Alternatively, you may use Git version control to keep all of your work in different branches of a single clone of the repository.



Previous | Next | Getting Started with GEOS-Chem