pysqa.ext.remote.RemoteQueueAdapter

class pysqa.ext.remote.RemoteQueueAdapter(config: dict, directory: str = '~/.queues', execute_command: callable = <function execute_command>)

Bases: BasisQueueAdapter

__init__(config: dict, directory: str = '~/.queues', execute_command: callable = <function execute_command>)

Methods

__init__(config[, directory, execute_command])
check_queue_parameters(queue[, cores, ...])	param queue:
convert_path_to_remote(path)
delete_job(process_id)	param process_id:
enable_reservation(process_id)	param process_id:
get_job_from_remote(working_directory)	Get the results of the calculation - this is necessary when the calculation was executed on a remote host.
get_queue_status([user])	param user:
get_status_of_job(process_id)	param process_id:
get_status_of_jobs(process_id_lst)	param process_id_lst list[int]:
get_status_of_my_jobs()	rtype: pandas.DataFrame
submit_job([queue, job_name, ...])	param queue:
transfer_file(file[, transfer_back, ...])

Attributes

config	Returns: dict:
queue_list	Returns: list:
queue_view	Returns: pandas.DataFrame:
queues
remote_flag
ssh_delete_file_on_remote

check_queue_parameters(queue: str, cores: int = 1, run_time_max: int | None = None, memory_max: int | None = None, active_queue: dict | None = None) → list

Parameters:

• queue (str/None)

• cores (int)

• run_time_max (int/None)

• memory_max (int/None)

• active_queue (dict)

Returns:

[cores, run_time_max, memory_max]

Return type:

list

property config

Returns: dict:

delete_job(process_id: int) → str

Parameters:

process_id (int)

Return type:

str

enable_reservation(process_id: int) → str

Parameters:

process_id (int)

Return type:

str

get_job_from_remote(working_directory: str)

Get the results of the calculation - this is necessary when the calculation was executed on a remote host.

get_queue_status(user: str | None = None) → DataFrame

Parameters:

user (str)

Return type:

pandas.DataFrame

get_status_of_job(process_id: int) → str

Parameters:

process_id

Returns:

[‘running’, ‘pending’, ‘error’]

Return type:

str

get_status_of_jobs(process_id_lst: list[int]) → list[str]

Parameters:

list[int] (process_id_lst)

Returns:

[‘running’, ‘pending’, ‘error’, …]

Return type:

list[str]

get_status_of_my_jobs() → DataFrame

Return type:

pandas.DataFrame

property queue_list: list

Returns: list:

property queue_view: DataFrame

Returns: pandas.DataFrame:

submit_job(queue: str | None = None, job_name: str | None = None, working_directory: str | None = None, cores: int | None = None, memory_max: int | None = None, run_time_max: int | None = None, dependency_list: list[str] | None = None, command: str | None = None, **kwargs) → int

Parameters:

• queue (str/None)

• job_name (str/None)

• working_directory (str/None)

• cores (int/None)

• memory_max (int/None)

• run_time_max (int/None)

• dependency_list (list/None)

• command (str/None)

Return type:

int