Skip to content

Commit

Permalink
Rename the package from LSFClusterManager.jl to `LSFClusterManagers…
Browse files Browse the repository at this point in the history
….jl` (#9)

Ref #5.

I think the name of this package should probably be pluralized, based on
the [package naming guidelines
here](https://pkgdocs.julialang.org/v1/creating-packages/#Package-naming-rules):

> Packages that provide most of their functionality in association with
a new type should have pluralized names.
  • Loading branch information
DilumAluthge authored Jan 6, 2025
1 parent 7e0dae4 commit c0fa1ee
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name = "LSFClusterManager"
name = "LSFClusterManagers"
uuid = "af02cf76-cbe3-4eeb-96a8-af9391005858"
version = "1.0.0-DEV"

Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# LSFClusterManager.jl
# LSFClusterManagers.jl

The `LSFClusterManager.jl` package implements code for the LSF (Load Sharing Facility) compute cluster job queue system.
The `LSFClusterManagers.jl` package implements code for the LSF (Load Sharing Facility) compute cluster job queue system.

`LSFClusterManager.LSFManager` supports IBM's scheduler. See the `addprocs_lsf` docstring
`LSFClusterManagers.LSFManager` supports IBM's scheduler. See the `addprocs_lsf` docstring
for more information.

Implemented in this package (the `LSFClusterManager.jl` package):
Implemented in this package (the `LSFClusterManagers.jl` package):

| Job queue system | Command to add processors |
| ---------------- | ------------------------- |
| Load Sharing Facility (LSF) | `addprocs_lsf(np::Integer; bsub_flags=``, ssh_cmd=``)` or `addprocs(LSFClusterManager.LSFManager(np, bsub_flags, ssh_cmd, retry_delays, throttle))` |
| Load Sharing Facility (LSF) | `addprocs_lsf(np::Integer; bsub_flags=``, ssh_cmd=``)` or `addprocs(LSFClusterManagers.LSFManager(np, bsub_flags, ssh_cmd, retry_delays, throttle))` |
2 changes: 1 addition & 1 deletion src/LSFClusterManager.jl → src/LSFClusterManagers.jl
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module LSFClusterManager
module LSFClusterManagers

using Distributed
using Sockets
Expand Down
6 changes: 3 additions & 3 deletions test/runtests.jl
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import LSFClusterManager
import LSFClusterManagers
import Test

import Distributed
Expand All @@ -11,15 +11,15 @@ using Distributed: remotecall_fetch, @spawnat
using Test: @testset, @test, @test_skip

# LSF:
using LSFClusterManager: addprocs_lsf, LSFManager
using LSFClusterManagers: addprocs_lsf, LSFManager

const test_args = lowercase.(strip.(ARGS))

@info "" test_args

lsf_is_installed() = !isnothing(Sys.which("bsub"))

@testset "LSFClusterManager.jl" begin
@testset "LSFClusterManagers.jl" begin
if lsf_is_installed()
@info "Running the LSF tests..." Sys.which("bsub")
include("lsf.jl")
Expand Down

0 comments on commit c0fa1ee

Please sign in to comment.