Skip to content

Commit 4699c49

Browse files
authored
README: Don't mention the Slurm functionality in this package (and point users to SlurmClusterManager.jl instead) (#245)
1 parent e3e7a11 commit 4699c49

File tree

1 file changed

+3
-32
lines changed

1 file changed

+3
-32
lines changed

README.md

Lines changed: 3 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ Implemented in this package (the `ClusterManagers.jl` package):
2020
| PBS (Portable Batch System) | `addprocs_pbs(np::Integer; qsub_flags=``)` or `addprocs(PBSManager(np, qsub_flags))` |
2121
| Scyld | `addprocs_scyld(np::Integer)` or `addprocs(ScyldManager(np))` |
2222
| HTCondor[^1] | `addprocs_htc(np::Integer)` or `addprocs(HTCManager(np))` |
23-
| Slurm | `addprocs_slurm(np::Integer; kwargs...)` or `addprocs(SlurmManager(np); kwargs...)` |
2423
| Local manager with CPU affinity setting | `addprocs(LocalAffinityManager(;np=CPU_CORES, mode::AffinityMode=BALANCED, affinities=[]); kwargs...)` |
2524

2625
[^1]: HTCondor was previously named Condor.
@@ -29,44 +28,16 @@ Implemented in external packages:
2928

3029
| Job queue system | External package | Command to add processors |
3130
| ---------------- | ---------------- | ------------------------- |
31+
| Slurm | [SlurmClusterManager.jl](https://github.com/JuliaParallel/SlurmClusterManager.jl) | `addprocs_slurm(np::Integer; kwargs...)` or `addprocs(SlurmManager(np); kwargs...)` |
3232
| Load Sharing Facility (LSF) | [LSFClusterManager.jl](https://github.com/JuliaParallel/LSFClusterManager.jl) | `addprocs_lsf(np::Integer; bsub_flags=``, ssh_cmd=``)` or `addprocs(LSFManager(np, bsub_flags, ssh_cmd, retry_delays, throttle))` |
3333
| Kubernetes (K8s) | [K8sClusterManagers.jl](https://github.com/beacon-biosignals/K8sClusterManagers.jl) | `addprocs(K8sClusterManager(np; kwargs...))` |
3434
| Azure scale-sets | [AzManagers.jl](https://github.com/ChevronETC/AzManagers.jl) | `addprocs(vmtemplate, n; kwargs...)` |
3535

3636
You can also write your own custom cluster manager; see the instructions in the [Julia manual](https://docs.julialang.org/en/v1/manual/distributed-computing/#ClusterManagers).
3737

38-
### Slurm: a simple example
38+
### Slurm: please see [SlurmClusterManager.jl](https://github.com/JuliaParallel/SlurmClusterManager.jl)
3939

40-
```julia
41-
using Distributed, ClusterManagers
42-
43-
# Arguments to the Slurm srun(1) command can be given as keyword
44-
# arguments to addprocs. The argument name and value is translated to
45-
# a srun(1) command line argument as follows:
46-
# 1) If the length of the argument is 1 => "-arg value",
47-
# e.g. t="0:1:0" => "-t 0:1:0"
48-
# 2) If the length of the argument is > 1 => "--arg=value"
49-
# e.g. time="0:1:0" => "--time=0:1:0"
50-
# 3) If the value is the empty string, it becomes a flag value,
51-
# e.g. exclusive="" => "--exclusive"
52-
# 4) If the argument contains "_", they are replaced with "-",
53-
# e.g. mem_per_cpu=100 => "--mem-per-cpu=100"
54-
addprocs(SlurmManager(2), partition="debug", t="00:5:00")
55-
56-
hosts = []
57-
pids = []
58-
for i in workers()
59-
host, pid = fetch(@spawnat i (gethostname(), getpid()))
60-
push!(hosts, host)
61-
push!(pids, pid)
62-
end
63-
64-
# The Slurm resource allocation is released when all the workers have
65-
# exited
66-
for i in workers()
67-
rmprocs(i)
68-
end
69-
```
40+
For Slurm, please see the [SlurmClusterManager.jl](https://github.com/JuliaParallel/SlurmClusterManager.jl) package.
7041

7142
### SGE - a simple interactive example
7243

0 commit comments

Comments
 (0)