pyworkflow.protocol.hosts module

This modules contains classes to store information about execution hosts.

class pyworkflow.protocol.hosts.HostConfig(**kwargs)[source]

Bases: Object

Main store the configuration for execution hosts.

getAddress()[source]
getCancelCommand()[source]
getCheckCommand()[source]
getHostName()[source]
getHostPath()[source]
getJobDoneRegex()[source]
getLabel()[source]
getMpiCommand()[source]
getPassword()[source]
getQueueSystem()[source]
getQueuesDefault()[source]
getScipionConfig()[source]

From which file to read the configuration file in this hosts. Useful for remote jobs.

getScipionHome()[source]

Return the path where Scipion is installed in the host. This is useful when launching remote jobs.

getSubmitCommand()[source]
getSubmitPrefix()[source]
getSubmitTemplate()[source]
getUserName()[source]
isQueueMandatory()[source]
classmethod load(hostsConf)[source]

Load several hosts from a configuration file. Return an dictionary with hostName -> hostConfig pairs.

setAddress(newAddress)[source]
setHostName(hostName)[source]
setHostPath(hostPath)[source]
setLabel(label)[source]
setMpiCommand(mpiCommand)[source]
setPassword(password)[source]
setQueueSystem(queueSystem)[source]
setScipionConfig(newConfig)[source]
setScipionHome(newScipionHome)[source]
setUserName(userName)[source]
classmethod writeBasic(configFn)[source]

Write a very basic Host configuration for testing purposes.

class pyworkflow.protocol.hosts.QueueConfig(**kwargs)[source]

Bases: Object

getAllowMPI()[source]
getAllowThreads()[source]
getMaxCores()[source]
getMaxHours()[source]
getName()[source]
setAllowMPI(allowMPI)[source]
setAllowThreads(allowThreads)[source]
setMaxCores(maxCores)[source]
setMaxHours(maxHours)[source]
setName(name)[source]
class pyworkflow.protocol.hosts.QueueSystemConfig(**kwargs)[source]

Bases: Object

getCancelCommand()[source]
getCheckCommand()[source]
getMandatory()[source]
getName()[source]
getQueueConfig(objId)[source]
getQueues()[source]
getSubmitCommand()[source]
getSubmitTemplate()[source]
hasName()[source]
hasValue()[source]
setCancelCommand(cancelCommand)[source]
setCheckCommand(checkCommand)[source]
setJobDoneRegex(jobDoneRegex)[source]
setMandatory(mandatory)[source]
setName(name)[source]
setQueues(queues)[source]
setSubmitCommand(submitCommand)[source]
setSubmitTemplate(submitTemplate)[source]