Skip to content

Commit 25b924a

Browse files
committed
consistently use VS Code instead of VSCode
1 parent c4ef1be commit 25b924a

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

docs/access/vscode.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
[](){#ref-access-vscode}
2-
# Connecting with VSCode
2+
# Connecting with VS Code
33

44
[Visual Studio Code](https://code.visualstudio.com/) provides flexible support for remote development.
5-
VSCode's [remote tunnel feature](https://code.visualstudio.com/docs/remote/tunnels) starts a server on a remote system, and connects the editor to this server.
5+
VS Code's [remote tunnel feature](https://code.visualstudio.com/docs/remote/tunnels) starts a server on a remote system, and connects the editor to this server.
66
There are two ways to set up the connection:
77

88
* using the code CLI: the most flexible method if using containers or uenv.
9-
* using the VSCode interface: VSCode will connect onto the system, download and start the server
9+
* using the VS Code interface: VS Code will connect onto the system, download and start the server
1010

11-
The main challenge with using VSCode is that the most convenient method for starting a remote session is to start a remote tunnel from the VS Code GUI.
11+
The main challenge with using VS Code is that the most convenient method for starting a remote session is to start a remote tunnel from the VS Code GUI.
1212
This approach starts a session in the standard login environment on that node, however this won't work if you want to be developing in a container, in a uenv, or on a compute node.
1313

1414
This process is also demonstrated in a webinar on [Interactive computing on "Alps"](https://www.cscs.ch/publications/tutorials/2025/video-of-the-webinar-interactive-computing-on-alps):
@@ -25,7 +25,7 @@ This process is also demonstrated in a webinar on [Interactive computing on "Alp
2525

2626
## Flexible method: remote server
2727

28-
The most flexible method for connecting VSCode is to log in to the Alps system, set up your environment (start a container or uenv, start a session on a compute node), and start the remote server in that environment pre-configured.
28+
The most flexible method for connecting VS Code is to log in to the Alps system, set up your environment (start a container or uenv, start a session on a compute node), and start the remote server in that environment pre-configured.
2929

3030
[](){#ref-vscode-install}
3131
### Installing the server
@@ -116,13 +116,13 @@ $ code tunnel --name=$CLUSTER_NAME-tunnel
116116
```
117117

118118
!!! tip
119-
Give the tunnel a unique name using the `--name` flag, which will later be listed on the VSCode UI.
119+
Give the tunnel a unique name using the `--name` flag, which will later be listed on the VS Code UI.
120120

121121
You will be requested to go to [github.com/login/device](https://github.com/login/device) and enter an 8-digit code.
122-
Once you have finished registering the service with GitHub, in VSCode on your PC/laptop open the "remote explorer" pane on the left hand side of the main window, and the connection will be visible under REMOTES (TUNNELS/SSH) -> Tunnels.
122+
Once you have finished registering the service with GitHub, in VS Code on your PC/laptop open the "remote explorer" pane on the left hand side of the main window, and the connection will be visible under REMOTES (TUNNELS/SSH) -> Tunnels.
123123

124124
!!! note "First time setting up a remote service"
125-
If this is the first time you have followed this procedure, you may have to sign in to GitHub in VSCode.
125+
If this is the first time you have followed this procedure, you may have to sign in to GitHub in VS Code.
126126

127127
Click on the Remote Explorer button on the left hand side, and then find the following option:
128128

@@ -134,12 +134,12 @@ Once you have finished registering the service with GitHub, in VSCode on your PC
134134

135135
If you have not signed in to GitHub with VS Code editor, you will be redirected to the browser to sign in.
136136

137-
After signing in and authorizing VSCode, the open tunnel should be visible under REMOTES (TUNNELS/SSH) -> Tunnels.
137+
After signing in and authorizing VS Code, the open tunnel should be visible under REMOTES (TUNNELS/SSH) -> Tunnels.
138138

139139
[](){#ref-vscode-uenv}
140140
### Using with uenv
141141

142-
To use a uenv with VSCode, the uenv must be started before calling `code tunnel`.
142+
To use a uenv with VS Code, the uenv must be started before calling `code tunnel`.
143143
Log into the target system and start the uenv, then start the remote server, for example:
144144
```
145145
# log into daint (this could be any other Alps cluster)
@@ -156,7 +156,7 @@ ssh daint
156156
uenv run --view=default prgenv-gnu/24.11:v1 -- code tunnel --name=$CLUSTER_NAME-tunnel
157157
```
158158

159-
Once the tunnel is configured, you can access it from VSCode.
159+
Once the tunnel is configured, you can access it from VS Code.
160160

161161
!!! warning
162162
If you plan to do any intensive work: repeated compilation of large projects or running python code in Jupyter, please see the guide to running on a compute node below.
@@ -165,7 +165,7 @@ Once the tunnel is configured, you can access it from VSCode.
165165
[](){#ref-vscode-compute-nodes}
166166
### Running on a compute node
167167

168-
If you plan to do computation using your VSCode, then you should first allocate resources on a compute node and set up your environment there.
168+
If you plan to do computation using your VS Code, then you should first allocate resources on a compute node and set up your environment there.
169169

170170
!!! example "directly create the tunnel using srun"
171171
You can directly execute the `code tunnel` command using srun:
@@ -176,7 +176,7 @@ If you plan to do computation using your VSCode, then you should first allocate
176176

177177
* `--uenv` and `--view` set up the uenv
178178
* `-t120` requests a 2 hour (120 minute) reservation
179-
* `-n1` requests a single rank - only one rank/process is required for VSCode
179+
* `-n1` requests a single rank - only one rank/process is required for VS Code
180180
* `--pty` allows forwarding of terminal I/O, required to sign in to Github
181181

182182
Once the job allocation is granted, you will be prompted to log into GitHub, the same as starting a session on the login node.
@@ -201,7 +201,7 @@ If you plan to do computation using your VSCode, then you should first allocate
201201
```
202202

203203
* `-t120` requests a 2 hour (120 minute) reservation
204-
* `-n1` requests a single rank - only one rank/process is required for VSCode
204+
* `-n1` requests a single rank - only one rank/process is required for VS Code
205205
* `--pty` allows forwarding of terminal I/O, for bash to work interactively
206206

207207
[](){#ref-vscode-containers}
@@ -234,7 +234,7 @@ $ cd path/for/code/executable/in/container
234234
$ ./code tunnel --name=$CLUSTER_NAME-tunnel
235235
```
236236

237-
## Connecting via VSCode UI
237+
## Connecting via VS Code UI
238238

239239
!!! warning
240240
This approach is not recommended, and is not supported by CSCS.

0 commit comments

Comments
 (0)