Quick Start Guide

From Geos-chem
Revision as of 16:55, 5 June 2022 by Daven (Talk | contribs)

Jump to: navigation, search

Getting Started with GEOS Chem Adjoint:

Recently our group migrated from cvs to git. This little guide will show the steps to create a new user on our new server and download the latest version of GEOS Chem Adjoint. We assume that you have installed git on your system. If you need information on how to install git on your system, please refer to the guide here.

  1. Sign up for the GEOS Chem Adjoint mailing list. This can be done by Send an email to geos-chem-adjoint+subscribe@g.harvard.edu or going to the Adjoint Google Group and hit apply for membership.
  2. Review our policy on Distribution and Use.
  3. Create a wiki account on GEOS-Chem wiki.
  4. Add yourself to the list of current users and projects.
  5. Request a GIT account by sending an email to GEOS Chem Adjoint mailing list. Please include your name, a desired username, organization and a brief description of how you plan to use the code. Note: If you don't request a username the default one will be NAME.LASTNAME
  6. You will receive an email letting you know that your GIT account has been created. This email will contain a random generated password, you will be asked to change it on your first login .
  7. Now you can log in our GIT server by going to http://adjoint.colorado.edu:8080 Note: You can login using your username or email.
  8. It's time to create your SSH Key, please note that without this key you won't be able to download the code. Go to My Profile (Top Right Corner Icon) -> SSH Keys and Add new. Please note that you are going to need one ssh key per computer where you donwload the code. Here you have more information about SSH Keys.
    How to create an SSH Key on GitLab.
    • In Title, put the name of the computer where you are creating the ssh key.
    • To check if you already have an SSH key, open your terminal and use the code below.
    cat ~/.ssh/id_rsa.pub
    • If you see something like this "cat: ~/.ssh/id_rsa.pub: No such file or directory" then you need to create one.
    • To generate a new SSH key use code below.
    ssh-keygen -t rsa -C "<your_email@your_server>"
    • Check if you successfully created your key as described before using
    cat ~/.ssh/id_rsa.pub
    • Copy the output of this command, and paste it into the Key section of the GIT ssh key web page.
  9. Now you are ready to download the code. Do so by typing this on a terminal.
git clone ssh://git@adjoint.colorado.edu/yanko.davila/gcadj_std.git

If you have any trouble or just need further assistance send an email to yanko.davila@colorado.edu. Now you should have a folder named gcadj_std. If you have it you are done. Now good luck with your work. We strongly encourage you to run the benchmarks following the GEOS Chem Adjoint Manual instructions. If you want to compare your result with our results please download our Benchmark Results.