|
1 | 1 | --- |
2 | | -title: Setup |
| 2 | +title: Preparing for participating in the tutorial |
3 | 3 | --- |
| 4 | + |
| 5 | +This page includes some basic information on how to prepare to participate in this tutorial. |
| 6 | + |
| 7 | +> ## Prerequisites |
| 8 | +> The prerequisites for the tutorial are listed here: |
| 9 | +> Basic understanding of git (optional - but useful) |
| 10 | +> Basic understanding of your preferred command line interface (ie a bash terminal) |
| 11 | +> Access to CMIP data |
| 12 | +> Access to a suitable computing system (egie jasmin) |
| 13 | +> Github account (optional, but useful!) |
| 14 | +{: .prereq} |
| 15 | + |
| 16 | + |
| 17 | +## Optional tutorials |
| 18 | + |
| 19 | +Where available, we include links to other software carpentry courses. |
| 20 | + |
| 21 | +### Command line |
| 22 | + |
| 23 | +We typically use the command line to interact with ESMValTool. Here’s a software carpentry tutorial on the unix shell: |
| 24 | +https://swcarpentry.github.io/shell-novice/ |
| 25 | + |
| 26 | + |
| 27 | +### Basic understanding of git |
| 28 | + |
| 29 | +Git is a distributed version-control system for tracking changes in source code during software development. It’s how we distribute, share, and manage the ESMValTool code. |
| 30 | + |
| 31 | +There are many basic introductions to git available. |
| 32 | + |
| 33 | +Here’s a software carpentry tutorial on git: |
| 34 | +https://swcarpentry.github.io/git-novice/ |
| 35 | + |
| 36 | + |
| 37 | + |
| 38 | +## Access to CMIP data and a suitable computing system |
| 39 | + |
| 40 | +There are multiple ways to use the |
| 41 | +We typically recommend using the one of the following systems: |
| 42 | +- JASMIN computing system (UK) |
| 43 | +- Something in DLR (Germany) |
| 44 | +- Local installation on your machine |
| 45 | + |
| 46 | + |
| 47 | +### JASMIN |
| 48 | + |
| 49 | +If you do not already have an account on JASMIN, then request an account as |
| 50 | +soon as possible. The instructions on how to create a jasmin account are here: https://help.jasmin.ac.uk/article/4435-get-a-jasmin-account-portal |
| 51 | + |
| 52 | +During the account creation, you will need an SSH key, which can be generated following these instructions: https://help.jasmin.ac.uk/article/185-generate-ssh-key-pair |
| 53 | + |
| 54 | +More instructions on how to get started: |
| 55 | +https://help.jasmin.ac.uk/article/189-get-started-with-jasmin |
| 56 | + |
| 57 | +Also note that if you are working from home, JASMIN may not be directly |
| 58 | +accessible from your home. You may need to use ssh to connect to a machine |
| 59 | +in your institute and then on to JASMIN. Please test your connection before |
| 60 | +the tutorial. |
| 61 | + |
| 62 | +#### Jasmin-login |
| 63 | + |
| 64 | +Note that you have only created an account for the web-interface. To log into the jasmin machine and do work, you'll need to create a login account too: https://help.jasmin.ac.uk/article/161-get-login-account |
| 65 | + |
| 66 | +#### Access to data on JASMIN |
| 67 | + |
| 68 | +Please request access to the working groups: |
| 69 | +● https://accounts.jasmin.ac.uk/services/group_workspaces/esmeval |
| 70 | +●https://services.ceda.ac.uk/cedasite/resreg/application?attributeid=cmip5_research |
| 71 | + |
| 72 | +Once you have access to the data archive on CEDA, make sure to link your |
| 73 | +CEDA and JASMIN accounts. This can be done by checking the link to CEDA box on your JASMIN profile page: |
| 74 | +https://accounts.jasmin.ac.uk/account/profile/ |
| 75 | + |
| 76 | +The linking may take a few hours to take effect and is necessary for you to |
| 77 | +access the BADC archives via JASMIN. Some CMIP5 data sets such as MIROC |
| 78 | +are not accessible by default and special permission has to be requested to |
| 79 | +access them via the CEDA catalogue page https://catalogue.ceda.ac.uk/ |
| 80 | + |
| 81 | +#### Test your Setup |
| 82 | +Log into jasmin-login: |
| 83 | + |
| 84 | + |
| 85 | +Then log into the sci1 machine: |
| 86 | +ssh -X jasmin-sci1 |
| 87 | + |
| 88 | +Can you see the following locations: |
| 89 | +- ls /group_workspaces/jasmin4/esmeval/obsdata/Tier2 |
| 90 | +- ls /badc/cmip5/data/cmip5/output1/MOHC/HadGEM2-ES |
| 91 | +- ls /badc/cmip6/data/CMIP6/CMIP/*/*/historical/r1i1p1f?/Omon/[ts]os/gn/latest/*.nc |
| 92 | + |
| 93 | +Note that the JASMIN is only open to certain locations (mostly universities, and research centres). You may need a VPN if you wish to connect from your home network. |
| 94 | + |
| 95 | +### DLR |
| 96 | +FIXME |
| 97 | + |
| 98 | +### Other computing systems |
4 | 99 | FIXME |
5 | 100 |
|
| 101 | +### Your own machine |
| 102 | + |
| 103 | +If you are planning on running ESMValTool on your own machine, please make sure that you are able to download CMIP data and that you have several GB of space available to install conda & ESMVAlTool, but also enough to make a copy of some data. |
| 104 | + |
| 105 | +You will also need to able to use: |
| 106 | +- git |
| 107 | +- conda |
| 108 | + |
| 109 | +#### Linux/unix |
| 110 | + |
| 111 | +#### Mac OSx |
| 112 | + |
| 113 | +#### Windows |
| 114 | + |
| 115 | +ESMValTool does not directly support Windows, But successful usage has been reported through the [Windows Subsystem for Linux(WSL)](https://docs.microsoft.com/en-us/windows/wsl/), available in Windows 10. |
| 116 | + |
| 117 | + |
| 118 | + |
| 119 | +## Github account (Advanced) |
| 120 | + |
| 121 | +You don’t need a github account to participate in the tutorial. However, if you want to raise an issue, contribute to the discussions, or share your code, please create a github account, here: https://github.com/ |
| 122 | + |
| 123 | +To learn how to use github, please have a look at this page: |
| 124 | +https://lab.github.com/githubtraining/introduction-to-github |
| 125 | + |
| 126 | +You may hear a few of the following phrases during the tutorial. Don’t be alarmed, they will make sense eventually. |
| 127 | + |
| 128 | +### github issues |
| 129 | +Issues are github’s ticketing system. They allow users and developers to discuss problems, identify bugs, or to make suggestions. Each issue is assigned a number and will have it’s own page on github. |
| 130 | + |
| 131 | +Here’s an explanation of the github issues: https://guides.github.com/features/issues/ |
| 132 | + |
| 133 | +Raising an issue is the act of creating a new issue. If you are asked to raise an issue, please follow any instructions that you are given, and also make sure that you read the default issue text. |
| 134 | + |
| 135 | +### pull request |
| 136 | + |
| 137 | +A github pull request is the act of requesting that a branch is merged with another branch. |
| 138 | + |
| 139 | +This is an advanced feature of ESMValTool, and will generally be performed by the Core development team. |
| 140 | + |
| 141 | + |
| 142 | + |
| 143 | + |
| 144 | +## Install conda |
| 145 | + |
| 146 | +The python package manager Conda (anaconda or miniconda) needs to be installed on your system before the tutorial starts. In some cases, your system may have a central version installed already. |
| 147 | + |
| 148 | +More details on this process are available in the Installation episode. |
| 149 | + |
| 150 | + |
6 | 151 |
|
7 | 152 | {% include links.md %} |
| 153 | + |
0 commit comments