Cloning (i.e. downloading for the first time): Difference between revisions

From Geos-chem
Jump to navigation Jump to search
(Created page with "== Overview == On this page, we describe how to download (aka "clone") the GEOS-Chem source code with Git. == Cloning the current GEOS-Chem version == The GEOS-Chem source...")
 
No edit summary
Line 1: Line 1:
__FORCETOC__
'''''[[First-time Git setup|Previous]] | [[Cloning (i.e. downloading for the first time)|Next]] | [[Guide to using Git with GEOS-Chem]] | [[Getting Started with GEOS-Chem]] | [[Main Page|GEOS-Chem Main Page]]'''''
== Overview ==
== Overview ==


Line 11: Line 15:
The first time that you will download a new GEOS-Chem version to your disk space, you must use the <tt>git clone</tt> command.  This will create an exact copy of the GEOS-Chem source code (including the complete version control history) to a folder on your disk.
The first time that you will download a new GEOS-Chem version to your disk space, you must use the <tt>git clone</tt> command.  This will create an exact copy of the GEOS-Chem source code (including the complete version control history) to a folder on your disk.


To download
To clone the current version of GEOS-Chem, type:


  git clone https://github.com/geoschem/geos-chem.git LOCAL_DIR_NAME
  git clone https://github.com/geoschem/geos-chem.git LOCAL_DIR_NAME
Line 17: Line 21:
where <tt>LOCAL-DIR-NAME</tt> is the name of the local directory on your disk into which the GEOS-Chem source code files will be placed.  It is up to you to pick <tt>LOCAL-DIR-NAME</tt>.
where <tt>LOCAL-DIR-NAME</tt> is the name of the local directory on your disk into which the GEOS-Chem source code files will be placed.  It is up to you to pick <tt>LOCAL-DIR-NAME</tt>.


This will  
The GEOS-Chem source code that you downloaded will be a copy of the '''master''' branch, which always points to the [[GEOS-Chem 12#current stable GEOS-Chem version|current stable GEOS-Chem version]].  (More about Git branches in a couple of chapters.)


== Cloning an older GEOS-Chem version ==
== Cloning an older GEOS-Chem version ==


You can also clone an older GEOS-Chem version by using the <tt>-b</tt> option with <tt>git clone</tt>.  This will copy the GEOS-Chem source code to your folder, and point the code to the '''branch''' or the '''tag'' that you specify.  (More about branches and tags in a few chapters).
For example, to clone a copy of the GEOS-Chem 12.0.0 code, type:
git clone -b 12.0.0 https://github.com/geoschem/geos-chem.git LOCAL_DIR_NAME
git checkout 12.0.0
This will download the GEOS-Chem source code and point you to the state of the code corresponding to the GEOS-Chem 12.0.0 release.


== Further reading ==
== Further reading ==
#[https://git-scm.com/docs/git-clone ''The git clone command'' (Official Git documentation)]
#[https://git-scm.com/book/en/v1/Git-Basics-Getting-a-Git-Repository ''Git basics: Getting a Git repository'' (Pro Git book)]
#[https://www.atlassian.com/git/tutorials/setting-up-a-repository/git-clone ''Git clone'' (Atlassian Git tutorial)]
----
'''''[[First-time Git setup|Previous]] | [[Cloning (i.e. downloading for the first time)|Next]] | [[Guide to using Git with GEOS-Chem]] | [[Getting Started with GEOS-Chem]] | [[Main Page|GEOS-Chem Main Page]]'''''

Revision as of 15:14, 19 June 2019

Previous | Next | Guide to using Git with GEOS-Chem | Getting Started with GEOS-Chem | GEOS-Chem Main Page


Overview

On this page, we describe how to download (aka "clone") the GEOS-Chem source code with Git.

Cloning the current GEOS-Chem version

The GEOS-Chem source code repository is available for remote download via Git, from our Github repository:

The first time that you will download a new GEOS-Chem version to your disk space, you must use the git clone command. This will create an exact copy of the GEOS-Chem source code (including the complete version control history) to a folder on your disk.

To clone the current version of GEOS-Chem, type:

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

where LOCAL-DIR-NAME is the name of the local directory on your disk into which the GEOS-Chem source code files will be placed. It is up to you to pick LOCAL-DIR-NAME.

The GEOS-Chem source code that you downloaded will be a copy of the master branch, which always points to the current stable GEOS-Chem version. (More about Git branches in a couple of chapters.)

Cloning an older GEOS-Chem version

You can also clone an older GEOS-Chem version by using the -b option with git clone. This will copy the GEOS-Chem source code to your folder, and point the code to the branch' or the tag that you specify. (More about branches and tags in a few chapters).

For example, to clone a copy of the GEOS-Chem 12.0.0 code, type:

git clone -b 12.0.0 https://github.com/geoschem/geos-chem.git LOCAL_DIR_NAME 
git checkout 12.0.0

This will download the GEOS-Chem source code and point you to the state of the code corresponding to the GEOS-Chem 12.0.0 release.

Further reading

  1. The git clone command (Official Git documentation)
  2. Git basics: Getting a Git repository (Pro Git book)
  3. Git clone (Atlassian Git tutorial)

Previous | Next | Guide to using Git with GEOS-Chem | Getting Started with GEOS-Chem | GEOS-Chem Main Page