Skip to content

Commit 94d1a31

Browse files
author
Prashanth Kanduri
committed
address review comments with better process clarification
1 parent fe3637d commit 94d1a31

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

docs/access/vscode.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ After downloading, copy the `code` executable to a location in your PATH, so tha
4848
export PATH=$HOME/.local/$(uname -m)/bin:$PATH
4949
```
5050
The `uname -m` command will print `aarch64` or `x86_64`, according to the microarchitecture of the node it is run on.
51-
51+
5252
Then create the path, and copy the `code` executable to the architecture-specific path:
5353
```
5454
mkdir -p $HOME/.local/$(uname -m)/bin
@@ -157,18 +157,21 @@ If you plan to do computation using your VSCode, then you should first allocate
157157

158158
### Using with containers
159159

160-
This will use CSCS's custom **Container Engine** which can easily pull a container from a registry like DockerHub. Same setup process as earlier with GitHub.
160+
This will use CSCS's **[Container Engine][ref-container-engine]**. Using this workflow, one can pull a container from a registry like DockerHub. Note that this process also requires that you have a GitHub account, with an authentication and authorization step as described earlier.
161161

162162
#### TOML File with Image and Mount Paths
163163

164164
```toml
165165
image = "nvcr.io#nvidia/pytorch:24.01-py3" # example of PyTorch NGC image
166166
writable = true
167167
mounts = ["/paths/on/scratch/or/home:path/on/the/container",
168-
"/path/if/same/on/both"]
168+
"/path/if/same/on/both"
169+
"/path/of/code/executable:/path/for/code/executable/in/container"]
169170
workdir = "default/working/dir/path"
170171
```
171172

173+
Ensure that the `code` executable is accessible in the container. Either it can be contained in the image, or one of the mounted folders should contain it.
174+
172175
#### Launch Container & Tunnel
173176

174177
```bash
@@ -177,12 +180,10 @@ srun -N 1 --environment=/absolute/path/to/tomlfile.toml --pty bash
177180

178181
start tunnel
179182

180-
cd /path/to/code/executable
183+
cd path/for/code/executable/in/container
181184
./code tunnel --name=$CLUSTER_NAME-tunnel
182185
```
183186

184-
185-
186187
## Connecting via VSCode UI
187188

188189
!!! warning

0 commit comments

Comments
 (0)