Safe Haskell	None
Language	Haskell2010

Hyperion.Slurm.Sbatch

Synopsis

data SbatchError = SbatchError {
- exitCodeStdinStderr :: (ExitCode, String, String)
- input :: String
}
data SbatchOptions = SbatchOptions {
- jobName :: Maybe Text
- chdir :: Maybe FilePath
- output :: Maybe FilePath
- nodes :: Int
- nTasksPerNode :: Int
- time :: NominalDiffTime
- mem :: Maybe Text
- mailType :: Maybe Text
- mailUser :: Maybe Text
- partition :: Maybe Text
- constraint :: Maybe Text
- account :: Maybe Text
- qos :: Maybe Text
}
defaultSbatchOptions :: SbatchOptions
sBatchOptionString :: SbatchOptions -> String
sbatchOutputParser :: Parser JobId
sbatchScript :: SbatchOptions -> String -> IO JobId
formatRuntime :: NominalDiffTime -> String
sbatchCommand :: SbatchOptions -> FilePath -> [Text] -> IO JobId

Documentation

data SbatchError Source #

Error from running sbatch. The Strings are the contents of stdout and stderr from sbatch.

Constructors

SbatchError
Fields exitCodeStdinStderr :: (ExitCode, String, String) input :: String

Instances

Instances details

Show SbatchError Source #
Instance details Defined in Hyperion.Slurm.Sbatch Methods showsPrec :: Int -> SbatchError -> ShowS # show :: SbatchError -> String # showList :: [SbatchError] -> ShowS #
Exception SbatchError Source #
Instance details Defined in Hyperion.Slurm.Sbatch Methods toException :: SbatchError -> SomeException # fromException :: SomeException -> Maybe SbatchError # displayException :: SbatchError -> String #

data SbatchOptions Source #

Type representing possible options for sbatch. Map 1-to-1 to sbatch options, so see man sbatch for details.

Constructors

SbatchOptions

Fields

jobName :: Maybe Text
Job name ("--job-name")
chdir :: Maybe FilePath
Working directory for the job ("--D")
output :: Maybe FilePath
Where to direct stdout of the job ("--output")
nodes :: Int
Number of nodes ("--nodes")
nTasksPerNode :: Int
Number of tasks per node ("--ntasks-per-node")
time :: NominalDiffTime
Job time limit ("--time")
mem :: Maybe Text
Memory per node, use suffix K,M,G, or T to define the units. ("--mem")
mailType :: Maybe Text
("--mail-type")
mailUser :: Maybe Text
("--mail-user")
partition :: Maybe Text
SLURM partition ("--partition")
constraint :: Maybe Text
("--constraint")
account :: Maybe Text
("--account")
qos :: Maybe Text
("--qos")

Instances

Instances details

Show SbatchOptions Source #
Instance details Defined in Hyperion.Slurm.Sbatch Methods showsPrec :: Int -> SbatchOptions -> ShowS # show :: SbatchOptions -> String # showList :: [SbatchOptions] -> ShowS #

defaultSbatchOptions :: SbatchOptions Source #

Default SbatchOptions. Request 1 task on 1 node for 24 hrs, everything else unspecified.

sBatchOptionString :: SbatchOptions -> String Source #

Convert SbatchOptions to a string of options for sbatch

sbatchOutputParser :: Parser JobId Source #

sbatchScript :: SbatchOptions -> String -> IO JobId Source #

Runs sbatch on a batch file with options pulled from SbatchOptions and script given as the String input parameter. If sbatch exists with failure then throws SbatchError.

formatRuntime :: NominalDiffTime -> String Source #

Formats NominalDiffTime into hh:mm:ss.

sbatchCommand :: SbatchOptions -> FilePath -> [Text] -> IO JobId Source #

Runs the command given by FilePath with arguments [Text] in sbatch script via sbatchScript. If sbatch fails then throws SbatchError.