Installation

To download the latest stable version of the cloud-slicing uptrop-py code, type:

$ git clone https://github.com/eamarais/erc-uptrop.git

This command clones the source code to a folder called erc-uptrop

To download GEOS-Chem Classic source code into a folder named something other than erc-uptrop, supply the name of the folder at the end of the git clone command. For example:

$ git clone https://github.com/eamarais/erc-uptrop.git my-code-dir

This will download the source code into my-code-dir instead of erc-uptrop.

Once the git clone process starts, you should see output similar to this:

Cloning into 'erc-uptrop'...
remote: Enumerating objects: 1568, done.
remote: Counting objects: 100% (485/485), done.
remote: Compressing objects: 100% (277/277), done.
remote: Total 1568 (delta 322), reused 297 (delta 195), pack-reused 1083
Receiving objects: 100% (1568/1568), 1.25 MiB | 10.35 MiB/s, done.
Resolving deltas: 100% (1086/1086), done.

When the git clone process has finished, get a directory listing:

$ ls -CF erc-uptrop/*

and you will see output similar to this:

docs/  environment.yml  LICENSE  README.md  tests/  uptrop/

Navigate into the erc-uptrop folder and confirm that the code is in the main branch:

$ cd erc-uptrop/
$ git branch

You will see output similar to this:

* main

If you plan to modify the code, either to add new features or fix bugs, create a branch to store these changes.

To do so, type:

$ git branch feature/my-git-updates
$ git checkout feature/my-git-updates

Instead of feature/my-git-updates, you may choose a name that reflects the nature of your updates (e.g. feature/fix_bug, feature/add_compound etc.) If you now type:

$ git branch

You will see that we are checked out onto the branch that you just created.

* feature/my-git-updates
main