Difference between revisions of "Quick Start Guide"

From Geos-chem
Jump to: navigation, search
m
Line 3: Line 3:
 
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 [http://git-scm.com/book/en/Getting-Started-Installing-Git here].
 
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 [http://git-scm.com/book/en/Getting-Started-Installing-Git here].
  
#Request a GIT account by sending an email to our group. Please include your name, organization and a brief description of how you plan to use the code. Send your email to [mailto:daven.henze@colorado.edu daven.henze@colorado.edu]
+
# Request a GIT account by sending an email to our group. Please include your name, organization and a brief description of how you plan to use the code. Send your email to [mailto:daven.henze@colorado.edu daven.henze@colorado.edu]
 
# Sign up for the [mailto:geos-chem-adjoint-join@seas.harvard.edu GEOS Chem Adjoint mailing list].
 
# Sign up for the [mailto:geos-chem-adjoint-join@seas.harvard.edu GEOS Chem Adjoint mailing list].
#Review our policy on [[GEOS-Chem_Adjoint#Distribution_and_Use|Distribution and Use]].
+
# Review our policy on [[GEOS-Chem_Adjoint#Distribution_and_Use|Distribution and Use]].
 
# Create a wiki account on [[Special:RequestAccount|GEOS-Chem wiki]].
 
# Create a wiki account on [[Special:RequestAccount|GEOS-Chem wiki]].
 
# You will receive an email letting you know that your GIT account has been created. This email will contain a random generated password, please change it on your first log into the server.
 
# You will receive an email letting you know that your GIT account has been created. This email will contain a random generated password, please change it on your first log into the server.
 
# Now you can log in our GIT server by going to http://adjoint.colorado.edu:8080
 
# Now you can log in our GIT server by going to http://adjoint.colorado.edu:8080
 
# Once you login, go to '''My Profile (Top Right Corner Icon) -> Account'''  and change your password.
 
# Once you login, go to '''My Profile (Top Right Corner Icon) -> Account'''  and change your password.
# 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'''. In Title you should put the computers name where you are creating the ssh key. If you need more information on how to create your key  refer to [http://adjoint.colorado.edu:8080/help/ssh here.] Please note that you are going to need one ssh key per computer where yu donwload the code.  
+
# 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.
# Now you are ready to download the code. Do so by typing this on a terminal  
+
#:How to create an SSH Key on GitLab. More information about [[SSH Keys]]
 +
#* In Title you should put the computers name where you are creating the ssh key.
 +
#* To check if you already have an SSH key just open your terminal and use code below.
 +
#: cat ~/.ssh/id_rsa.pub
 +
#* Copy the output of this command and paste it on the Key section. 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>"
 +
#* Now check if you successfully created your key as described before.
 +
# Now you are ready to download the code. Do so by typing this on a terminal.
  
 
  git clone ssh://git@adjoint.colorado.edu:2222/gcadj_std.git
 
  git clone ssh://git@adjoint.colorado.edu:2222/gcadj_std.git
  
It will ask for your username (email that you used for registration) and your password, please note that if you have X11 session open it will popup a window asking for the username and password instead of asking it on the terminal. 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 [http://adjoint.colorado.edu/~yanko/gcadj_std/GC_adj_man.pdf GEOS Chem Adjoint Manual] instructions. If you want to compare your result with our results please download our [http://adjoint.colorado.edu/~yanko/benchmarks/ Benchmark Results].
+
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 [http://adjoint.colorado.edu/~yanko/gcadj_std/GC_adj_man.pdf GEOS Chem Adjoint Manual] instructions. If you want to compare your result with our results please download our [http://adjoint.colorado.edu/~yanko/benchmarks/ Benchmark Results].
  
  
 
[[GEOS-Chem_Adjoint#Quick_guide_to_GIT|GO BACK]]
 
[[GEOS-Chem_Adjoint#Quick_guide_to_GIT|GO BACK]]

Revision as of 19:59, 19 December 2012

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. Request a GIT account by sending an email to our group. Please include your name, organization and a brief description of how you plan to use the code. Send your email to daven.henze@colorado.edu
  2. Sign up for the GEOS Chem Adjoint mailing list.
  3. Review our policy on Distribution and Use.
  4. Create a wiki account on GEOS-Chem wiki.
  5. You will receive an email letting you know that your GIT account has been created. This email will contain a random generated password, please change it on your first log into the server.
  6. Now you can log in our GIT server by going to http://adjoint.colorado.edu:8080
  7. Once you login, go to My Profile (Top Right Corner Icon) -> Account and change your password.
  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.
    How to create an SSH Key on GitLab. More information about SSH Keys
    • In Title you should put the computers name where you are creating the ssh key.
    • To check if you already have an SSH key just open your terminal and use code below.
    cat ~/.ssh/id_rsa.pub
    • Copy the output of this command and paste it on the Key section. 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>"
    • Now check if you successfully created your key as described before.
  9. Now you are ready to download the code. Do so by typing this on a terminal.
git clone ssh://git@adjoint.colorado.edu:2222/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.


GO BACK