Skip to content

Commit

Permalink
README: Clearly distinguish between implementations in this package v…
Browse files Browse the repository at this point in the history
…s external packages (#220)

* README: Clearly distinguish between implementations in this package vs external packages

* Change "Currently supported" to "Available"
  • Loading branch information
DilumAluthge authored Jan 2, 2025
1 parent c9c9374 commit 7443587
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

Support for different job queue systems commonly used on compute clusters.

## Currently supported job queue systems
## Available job queue systems

Implemented in this package (the `ClusterManagers.jl` package):

| Job queue system | Command to add processors |
| ---------------- | ------------------------- |
Expand All @@ -14,6 +16,11 @@ Support for different job queue systems commonly used on compute clusters.
| HTCondor | `addprocs_htc(np::Integer)` or `addprocs(HTCManager(np))` |
| Slurm | `addprocs_slurm(np::Integer; kwargs...)` or `addprocs(SlurmManager(np); kwargs...)` |
| Local manager with CPU affinity setting | `addprocs(LocalAffinityManager(;np=CPU_CORES, mode::AffinityMode=BALANCED, affinities=[]); kwargs...)` |

Implemented in external packages:

| Job queue system | Command to add processors |
| ---------------- | ------------------------- |
| Kubernetes (K8s) via [K8sClusterManagers.jl](https://github.com/beacon-biosignals/K8sClusterManagers.jl) | `addprocs(K8sClusterManagers(np; kwargs...))` |
| Azure scale-sets via [AzManagers.jl](https://github.com/ChevronETC/AzManagers.jl) | `addprocs(vmtemplate, n; kwargs...)` |

Expand Down

0 comments on commit 7443587

Please sign in to comment.