Skip to content

Commit c94980a

Browse files
committed
fixed the links
1 parent 89d2ec1 commit c94980a

1 file changed

Lines changed: 56 additions & 24 deletions

File tree

setup.md

Lines changed: 56 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@ Here’s a software carpentry tutorial on git:
4545
## Access to CMIP and Observational data and a suitable compute cluster
4646

4747
To complete this tutorial and use ESMValTool, you will need access to data in a reasonable format.
48-
Some data will be provided, but there is too much CMIP data available for your tutors to make it all available directly.
48+
Some data will be provided, but there is simply too much data available
49+
for your tutors to make it all available directly.
4950

5051
ESMValTool may be run on multiple platforms, from your local machine to
5152
large computing clusters.
@@ -78,12 +79,13 @@ If neccesairy, data can be downloaded using the
7879
### CEDA-Jasmin
7980

8081
If you do not already have an account on JASMIN, then request an account as
81-
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
82+
soon as possible.
83+
Please follow [these instructions on how to create a Jasmin account](https://help.jasmin.ac.uk/article/4435-get-a-jasmin-account-portal)
8284

83-
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
85+
During the account creation, you will need an SSH key, which can be generated following
86+
[these instructions](https://help.jasmin.ac.uk/article/185-generate-ssh-key-pair)
8487

85-
More instructions on how to get started:
86-
https://help.jasmin.ac.uk/article/189-get-started-with-jasmin
88+
Here are some more [instructions on how to get started with jasmin](https://help.jasmin.ac.uk/article/189-get-started-with-jasmin).
8789

8890
Also note that if you are working from home, JASMIN may not be directly
8991
accessible from your home. You may need to use ssh to connect to a machine
@@ -92,36 +94,53 @@ the tutorial.
9294

9395
#### Jasmin-login
9496

95-
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
97+
Note that you have only created an account for the web-interface.
98+
To log into the jasmin machine and do work, you'll need to create a
99+
login account too using [this page](https://help.jasmin.ac.uk/article/161-get-login-account).
100+
96101

97102
#### Access to data on JASMIN
98103

99104
Please request access to the working groups:
100-
- https://accounts.jasmin.ac.uk/services/group_workspaces/esmeval
101-
- https://services.ceda.ac.uk/cedasite/resreg/application?attributeid=cmip5_research
105+
- [esmeval working group](https://accounts.jasmin.ac.uk/services/group_workspaces/esmeval)
106+
- [CMIP5 data](https://services.ceda.ac.uk/cedasite/resreg/application?attributeid=cmip5_research)
102107

103108
Once you have access to the data archive on CEDA, make sure to link your
104-
CEDA and JASMIN accounts. This can be done by checking the link to CEDA box on your JASMIN profile page:
105-
https://accounts.jasmin.ac.uk/account/profile/
109+
CEDA and JASMIN accounts.
110+
This can be done by checking the link to CEDA box on
111+
[your JASMIN profile page](https://accounts.jasmin.ac.uk/account/profile/).
106112

107113
The linking may take a few hours to take effect and is necessary for you to
108114
access the BADC archives via JASMIN. Some CMIP5 data sets such as MIROC
109115
are not accessible by default and special permission has to be requested to
110-
access them via the CEDA catalogue page https://catalogue.ceda.ac.uk/
116+
access them via [the CEDA catalogue page](https://catalogue.ceda.ac.uk/).
111117

112118
#### Test your Setup
119+
113120
Log into jasmin-login:
114-
ssh -X JASMIN-USERNAME@jasmin-login1.ceda.ac.uk
121+
122+
~~~
123+
ssh -X JASMIN-USERNAME@jasmin-login1.ceda.ac.uk
124+
~~~
125+
{: .language-bash}
115126

116127
Then log into the sci1 machine:
128+
129+
~~~
117130
ssh -X jasmin-sci1
131+
~~~
132+
{: .language-bash}
118133

119134
Can you see the following locations:
135+
~~~
120136
- ls /group_workspaces/jasmin4/esmeval/obsdata/Tier2
121137
- ls /badc/cmip5/data/cmip5/output1/MOHC/HadGEM2-ES
122138
- ls /badc/cmip6/data/CMIP6/CMIP/*/*/historical/r1i1p1f?/Omon/[ts]os/gn/latest/*.nc
139+
~~~
140+
{: .language-bash}
123141

124-
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.
142+
Note that the JASMIN is only open to certain locations (mostly universities, and research centres).
143+
You may need a VPN if you wish to connect from your home network.
125144

126145
### DLR
127146
FIXME
@@ -144,40 +163,53 @@ You will also need to able to use:
144163

145164
#### Windows
146165

147-
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.
166+
ESMValTool does not directly support Windows,
167+
but successful usage has been reported through the
168+
[Windows Subsystem for Linux(WSL)](https://docs.microsoft.com/en-us/windows/wsl/),
169+
available in Windows 10.
148170

149171

150172

151173
## Github account (Advanced)
152174

153-
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/
175+
You don’t need a github account to participate in the tutorial.
176+
However, if you want to raise an issue, contribute to the discussions,
177+
or share your code, please [create a github account](https://github.com/).
154178

155-
To learn how to use github, please have a look at this page:
156-
https://lab.github.com/githubtraining/introduction-to-github
179+
To learn how to use github, please have a look at this [introduction to github]
180+
(https://lab.github.com/githubtraining/introduction-to-github).
157181

158182
You may hear a few of the following phrases during the tutorial. Don’t be alarmed, they will make sense eventually.
159183

160184
### github issues
161-
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.
185+
Issues are github’s ticketing system.
186+
They allow users and developers to discuss problems,
187+
identify bugs, or to make suggestions.
188+
Each issue is assigned a number and will have it’s own page on github.
189+
190+
Here’s an explanation of the [github issues](https://guides.github.com/features/issues/).
162191

163-
Here’s an explanation of the github issues: https://guides.github.com/features/issues/
192+
Raising an issue is the act of creating a new issue.
193+
If you are asked to raise an issue, please follow any instructions that you are given,
194+
and also make sure that you read the default issue text.
164195

165-
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.
166196

167197
### pull request
168198

169199
A github pull request is the act of requesting that a branch is merged with another branch.
170200

171-
This is an advanced feature of GitHub, and will generally be performed by the ESMValTool development team.
172-
201+
This is an advanced feature of GitHub, and will generally be performed by the ESMValTool development team.
173202

174203

175204

176205
## Install conda
177206

178-
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.
207+
The python package manager Conda (anaconda or miniconda)
208+
needs to be installed on your system before the tutorial starts.
209+
In some cases, your system may have a central version installed already.
179210

180-
More details on this process are available in the [Installation episode]({{ page.root}}[% link _episodes/02-installation.md %}).
211+
More details on this process are available in the
212+
[Installation episode]({{ page.root}}[% link _episodes/02-installation.md %}).
181213

182214

183215

0 commit comments

Comments
 (0)