Skip to content

Commit 4837929

Browse files
authored
Update index.md
1 parent c926583 commit 4837929

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

docs/src/index.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,11 +63,11 @@ cd ~/bin
6363
ln -s /somwehere/home/me/julia-x.x.x/bin/julia .
6464
```
6565
Make sure your `$HOME/bin` is in your `$PATH` else which you can check with `echo $PATH | grep "$HOME/bin"`. If you do not see your `bin` directory highlighted, do `export PATH=~/bin:$PATH`
66-
The preferred development and usage environment for HiQGA is [Visual Studio Code](https://code.visualstudio.com/), which provides interactive execution of Julia code through the [VSCode Julia extension](https://code.visualstudio.com/docs/languages/julia). To install VSCode on the National Computational Infrastructure (NCI), you need to extract the VSCode rpm package using the steps in [this gist](https://gist.github.com/a2ray/701347f703b72abb630d2521b43c5f22), to a location where your account has write access. You will NOT be using vscode on a gadi login node, but on OOD.
66+
The preferred development and usage environment for HiQGA is [Visual Studio Code](https://code.visualstudio.com/), which provides interactive execution of Julia code through the [VSCode Julia extension](https://code.visualstudio.com/docs/languages/julia). To install VSCode on the National Computational Infrastructure (NCI), see underneath. You will NOT be using vscode on a gadi login node, but on [ARE](https://are.nci.org.au).
6767

6868
Get Julia language support from VSCode after launching the VSCode binary by going to File->Extensions by searching for Julia. If after installation it doesn't find the Julia binary, go to File->Extensions->Julia->Manage (the little gear icon) and manually type in `/home/yourusername/bin/julia` in the "Executable Path" field.
6969

70-
It is also useful to use Revise.jl to ensure changes to the package are immediately reflected in a running Julia REPL (this is the reason that Revise is a dependency on some example scripts as noted above). More information on a workflow to use Revise during development can be found [here](https://gist.github.com/a2ray/e593751b24e45f8160ba8041fb811680).
70+
It is also useful to use Revise.jl to ensure changes to the package are immediately reflected in a running Julia REPL (this is the reason that Revise is a dependency on some example scripts as noted above). More information on a workflow to use Revise during development can be found [here](https://gist.github.com/a2ray/e593751b24e45f8160ba8041fb811680). However, do not use `Revise` for production runs and long MPI jobs.
7171

7272
As [shown above](#installation), to install HiQGA, start Julia and go into the `Pkg` REPL by hitting `]` to enter `pkg>` mode like so:
7373
```
@@ -78,7 +78,19 @@ Then enter the following, at the `pkg>` prompt:
7878
```
7979
pkg> add HiQGA
8080
```
81-
81+
### VSCode on the NCI ###
82+
Install Julia from binary for your platform, download the VSCode RPM at a plce where you have write access and free inodes. Then at the terminal, write:
83+
`rpm2cpio code-xxxx-vyyy.rpm | cpio -idv`
84+
The VScode binary is at `<rpmdir>/usr/share/code/bin/code`, where `<rpmdir>` is the folder where you ran the `rpm2cpio` command. The best way to make running VSCode easy is to add the following line to `~/.bashrc`:
85+
```
86+
prepend_path PATH ${HOME}/bin
87+
```
88+
and then in `~/bin` create a file called `code` with the following contents
89+
```
90+
#!/bin/bash
91+
/path/to/vscode/usr/share/code/code --no-sandbox
92+
```
93+
and then do `source ~/.bashrc` or restart the terminal. The next time you run `code` from your terminal it will bring up VSCode. Use VScode on ARE, not a Gadi login node.
8294
### Installing MPI.jl and MPIClusterManagers.jl on NCI
8395
We have found that the safest bet for MPI.jl to work without [UCX issues](https://docs.juliahub.com/MPI/nO0XF/0.19.2/knownissues/#UCX) on NCI is to use intel-mpi. In order to install MPI.jl and configure it to use the intel-mpi provided by the module `intel-mpi/2021.10.0`, following the example below.
8496

0 commit comments

Comments
 (0)