Skip to content

Commit 84ef921

Browse files
authored
README: Move the unmaintained managers (SGE, PBS, HTCondor, and Scyld) to a separate table (#255)
Follow-up to #247 and #248.
1 parent 732c86c commit 84ef921

File tree

1 file changed

+24
-9
lines changed

1 file changed

+24
-9
lines changed

README.md

+24-9
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,15 @@ The `ClusterManagers.jl` package implements code for different job queue systems
1111
1212
## Available job queue systems
1313

14-
Implemented in this package (the `ClusterManagers.jl` package):
14+
### In this package
15+
16+
The following managers are implemented in this package (the `ClusterManagers.jl` package):
1517

1618
| Job queue system | Command to add processors |
1719
| ---------------- | ------------------------- |
18-
| Sun Grid Engine (SGE) via `qsub` | `addprocs_sge(np::Integer; qsub_flags=``)` or `addprocs(SGEManager(np, qsub_flags))` |
19-
| Sun Grid Engine (SGE) via `qrsh` | `addprocs_qrsh(np::Integer; qsub_flags=``)` or `addprocs(QRSHManager(np, qsub_flags))` |
20-
| PBS (Portable Batch System) | `addprocs_pbs(np::Integer; qsub_flags=``)` or `addprocs(PBSManager(np, qsub_flags))` |
21-
| Scyld | `addprocs_scyld(np::Integer)` or `addprocs(ScyldManager(np))` |
22-
| HTCondor[^1] | `addprocs_htc(np::Integer)` or `addprocs(HTCManager(np))` |
2320
| Local manager with CPU affinity setting | `addprocs(LocalAffinityManager(;np=CPU_CORES, mode::AffinityMode=BALANCED, affinities=[]); kwargs...)` |
2421

25-
[^1]: HTCondor was previously named Condor.
26-
27-
Implemented in external packages:
22+
### Implemented in external packages
2823

2924
| Job queue system | External package | Command to add processors |
3025
| ---------------- | ---------------- | ------------------------- |
@@ -33,8 +28,28 @@ Implemented in external packages:
3328
| Kubernetes (K8s) | [K8sClusterManagers.jl](https://github.com/beacon-biosignals/K8sClusterManagers.jl) | `addprocs(K8sClusterManager(np; kwargs...))` |
3429
| Azure scale-sets | [AzManagers.jl](https://github.com/ChevronETC/AzManagers.jl) | `addprocs(vmtemplate, n; kwargs...)` |
3530

31+
### Not currently being actively maintained
32+
33+
> [!WARNING]
34+
> The following managers are not currently being actively maintained or tested.
35+
>
36+
> We are seeking maintainers for the following managers. If you are an active user of any of the following job queue systems listed and are interested in being a maintainer, please open a GitHub issue - say that you are interested in being a maintainer, and specify which job queue system you use.
37+
>
38+
39+
| Job queue system | Command to add processors |
40+
| ---------------- | ------------------------- |
41+
| Sun Grid Engine (SGE) via `qsub` | `addprocs_sge(np::Integer; qsub_flags=``)` or `addprocs(SGEManager(np, qsub_flags))` |
42+
| Sun Grid Engine (SGE) via `qrsh` | `addprocs_qrsh(np::Integer; qsub_flags=``)` or `addprocs(QRSHManager(np, qsub_flags))` |
43+
| PBS (Portable Batch System) | `addprocs_pbs(np::Integer; qsub_flags=``)` or `addprocs(PBSManager(np, qsub_flags))` |
44+
| Scyld | `addprocs_scyld(np::Integer)` or `addprocs(ScyldManager(np))` |
45+
| HTCondor | `addprocs_htc(np::Integer)` or `addprocs(HTCManager(np))` |
46+
47+
### Custom managers
48+
3649
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).
3750

51+
## Notes on specific managers
52+
3853
### Slurm: please see [SlurmClusterManager.jl](https://github.com/JuliaParallel/SlurmClusterManager.jl)
3954

4055
For Slurm, please see the [SlurmClusterManager.jl](https://github.com/JuliaParallel/SlurmClusterManager.jl) package.

0 commit comments

Comments
 (0)