ufrc package¶

Tools for UFRC

Subpackages¶

Submodules¶

ufrc.exc module¶

exception ufrc.exc.NoUFRCConnectionException[source]¶: Bases: ufrc.exc.UFRCSSHException

exception ufrc.exc.UFRCException[source]¶: Bases: Exception

exception ufrc.exc.UFRCSSHException[source]¶: Bases: ufrc.exc.UFRCException

ufrc.main module¶

class ufrc.main.UFRC(server='hpg.rc.ufl.edu')[source]¶

Bases: object

__init__(server='hpg.rc.ufl.edu')[source]¶

cancel_job_by_id(job_id)[source]¶

Return type: SSHResponse

cancel_jobs_by_lookup(group_name=None, user_id=None, job_name=None)[source]¶

Return type: SSHResponse

connect(username, password)[source]¶

disconnect()[source]¶

get(remote_path, local_path='', recursive=False, preserve_times=False)[source]¶

property is_connected: bool¶

Return type: bool

job_status(group_name=None, user_id=None, job_name=None)[source]¶

Return type: SQueueResponse

put(files, to_path='.', recursive=False, preserve_times=False)[source]¶

put_sbatch(sbatch, file_name='my_job.sbatch', to_path='.')[source]¶

run(command)[source]¶

Return type: SSHResponse

ufrc.sbatch module¶

class ufrc.sbatch.MailType(value)[source]¶

Bases: str, enum.Enum

An enumeration.

ALL = 'ALL'¶

BEGIN = 'BEGIN'¶

END = 'END'¶

FAIL = 'FAIL'¶

NONE = 'NONE'¶

class ufrc.sbatch.SBatchFile(**data)[source]¶

Bases: pydantic.main.BaseModel

commands: List[str]¶

property contents: str¶

Return type: str

headers: ufrc.sbatch.SBatchHeaders¶

shebang: str¶

class ufrc.sbatch.SBatchHeaders(**data)[source]¶

Bases: pydantic.main.BaseModel

array: Optional[str]¶

cpus_per_task: int¶

email: str¶

property header_str: str¶

Return type: str

job_name: str¶

mail_types: List[ufrc.sbatch.MailType]¶

memory_mb: int¶

n_tasks: int¶

output: str¶

time: str¶