Skip to content

Commit d435502

Browse files
committed
improvements
1 parent 1bda63d commit d435502

File tree

3 files changed

+33
-6
lines changed

3 files changed

+33
-6
lines changed

website/user_faq.md

+8
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ Set [`JULIA_CPU_TARGET`](https://docs.julialang.org/en/v1.10-dev/manual/environm
5050

5151
This compiles all functions (`clone_all`) for Intel Skylake (`skylake-avx512`), AMD Zen 2 (`znver2`), and a generic fallback (`generic`).
5252

53+
For more information, see [this section of the Julia documentation](https://docs.julialang.org/en/v1/manual/environment-variables/#JULIA_CPU_TARGET) and [this section of the developer documentation](https://docs.julialang.org/en/v1/devdocs/sysimg/#Specifying-multiple-system-image-targets).
54+
5355
[_**back to Content**_](#content)
5456

5557
## Should I use Distributed.jl or MPI.jl for large-scale parallelism?
@@ -118,4 +120,10 @@ Try setting `JULIA_CUDA_MEMORY_POOL=none` (see the [CUDA.jl documentation](https
118120

119121
By default, Julia uses many parallel tasks during precompilation. On the login nodes of some HPC clusters, parallel processes might be subject to resource restrictions. In these cases, you might want to set [`JULIA_NUM_PRECOMPILE_TASKS`](https://docs.julialang.org/en/v1/manual/environment-variables/#JULIA_NUM_PRECOMPILE_TASKS) to a low value, e.g. `export JULIA_NUM_PRECOMPILE_TASKS=1` (single task).
120122

123+
[_**back to Content**_](#content)
124+
125+
## Can I precompile GPU code on a login node without a GPU?
126+
127+
Yes, at least for CUDA.jl. See [this part](https://cuda.juliagpu.org/stable/installation/overview/#Precompiling-CUDA.jl-without-CUDA) of the CUDA.jl documentation.
128+
121129
[_**back to Content**_](#content)

website/user_gettingstarted.md

+23-6
Original file line numberDiff line numberDiff line change
@@ -19,24 +19,41 @@ Getting started with Julia on a new cluster can sometimes be a challenge. Below
1919

2020
---
2121

22-
## Julia binaries or Julia module
22+
## Use the regular Julia binaries or a Julia module (if available)
2323

2424
When starting on a new HPC cluster the first thing you should do is figure out if there is a pre-configured Julia module ([Lmod module](https://lmod.readthedocs.io/en/latest/010_user.html)) available on the cluster. To that end, `module key julia` or `module spider julia` might be helpful commands.
2525

26-
If there isn't a Julia module available that you can load, you should use the regular, pre-built Julia binaries. You can either download (e.g. `wget` or `curl`) them directly [from the website](https://julialang.org/downloads/) or use [juliaup](https://github.com/JuliaLang/juliaup). In any case, you should **not** build Julia from source (unless you have a very good reason and know that you're doing).
26+
If there is no Julia module available that you can load, you should download and use the regular, precompiled Julia binaries. We strongly recommend to use [juliaup](https://github.com/JuliaLang/juliaup) for this. Alternatively, you can also manually download the binaries directly [from the website](https://julialang.org/downloads/).
27+
28+
In any case, you should generally **not** build Julia from source (unless you have a very good reason).
2729

2830
[_**back to Content**_](#content)
2931

30-
## Placing the Julia depot
32+
## Place the Julia depot on the parallel file system.
33+
34+
One you have Julia installed and you can run `julia` from the command line, you should place the Julia depot - the `.julia` folder where Julia stores all dependencies, logs, etc. - on an appropriate file system. By default, it will be stored in `$HOME/.julia`. This may or may not be a good choice, but more often than not it isn't.
3135

32-
One you have `julia`, you must make sure that the Julia depot is placed on an appropriate file system. By default, it will be stored in `$HOME/.julia`. This may or may not be a good choice. What you want is a place on a file system with the following properties
36+
You want to choose a file system with the following properties
3337
* no tight quotas (at least >= 20 GB)
3438
* read and write access (ideally also from compute nodes)
3539
* good (parallel) I/O
3640
* no automatic deletion of unused files (or otherwise you have to find a workaround)
3741

38-
Often times these criterion are best fit on a parallel file system (often `$SCRATCH`). For this reason it might be necessary to set `JULIA_DEPOT_PATH=$SCRATCH/.julia`.
42+
**On most clusters these criterion are best fit on a parallel file system (often `$SCRATCH`).** In this case, you should put `JULIA_DEPOT_PATH=$SCRATCH/.julia` into your `.bashrc`.
3943

40-
Note that if the last point (automatic deletion of unused files) is an issue for you, a pragmatic workaround could be a cronjob that touches all files in the Julia depot every once in a while.
44+
**Note:** If the last point (automatic deletion of unused files) is an issue for you, a pragmatic workaround could be a cronjob that touches all files in the Julia depot every once in a while.
4145

4246
[_**back to Content**_](#content)
47+
48+
49+
## Set `JULIA_CPU_TARGET` appropriately.
50+
51+
On many clusters, the sections above are all you need to get a solid Julia setup. However, if your on a **heterogeneous HPC cluster**, that is, if different nodes have different CPU (micro-)architectures, you should/need to do a few more preparations. Otherwise, you might encounter nasty error messages like "`Illegal instruction`".
52+
53+
To make Julia produce efficient code that works on different CPUs, you need to set [`JULIA_CPU_TARGET`](https://docs.julialang.org/en/v1.10-dev/manual/environment-variables/#JULIA_CPU_TARGET). For example, if you want Julia to compile all functions (`clone_all`) for Intel Skylake (`skylake-avx512`), AMD Zen 2 (`znver2`), and a generic fallback (`generic`), for safety, you could put the following into your `.bashrc`:
54+
55+
`export JULIA_CPU_TARGET="generic;skylake-avx512,clone_all;znver2,clone_all"`.
56+
57+
For more information, see [this section of the Julia documentation](https://docs.julialang.org/en/v1/manual/environment-variables/#JULIA_CPU_TARGET) and [this section of the developer documentation](https://docs.julialang.org/en/v1/devdocs/sysimg/#Specifying-multiple-system-image-targets).
58+
59+
[_**back to Content**_](#content)

website/user_vscode.md

+2
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,8 @@ Microsoft provides ["Remote tunnels"](https://code.visualstudio.com/docs/remote/
128128
* Requires a GitHub / Microsoft account.
129129
* Microsoft serves as the tunnel provider (man in the middle).
130130

131+
**How to do it?**
132+
131133
1. Download the VS Code command line interface from [https://code.visualstudio.com/Download](https://code.visualstudio.com/Download) (search for **CLI**).
132134

133135
2. Copy the single `code` binary to the cluster (and put the directory on `PATH`).

0 commit comments

Comments
 (0)