pyiron.base.server.queuestatus module¶
-
pyiron.base.server.queuestatus.queue_check_job_is_waiting_or_running(item)[source]¶ Check if a job is still listed in the queue system as either waiting or running.
- Parameters
item (int, GenericJob) – Provide either the job_ID or the full hamiltonian
- Returns
[True/False]
- Return type
bool
-
pyiron.base.server.queuestatus.queue_delete_job(item)[source]¶ Delete a job from the queuing system
- Parameters
item (int, pyiron.base.job.generic.GenericJob) – Provide either the job_ID or the full hamiltonian
- Returns
Output from the queuing system as string - optimized for the Sun grid engine
- Return type
str
-
pyiron.base.server.queuestatus.queue_enable_reservation(item)[source]¶ Enable a reservation for a particular job within the queuing system
- Parameters
item (int, pyiron.base.job.generic.GenericJob) – Provide either the job_ID or the full hamiltonian
- Returns
Output from the queuing system as string - optimized for the Sun grid engine
- Return type
str
-
pyiron.base.server.queuestatus.queue_info_by_job_id(job_id)[source]¶ Display the queuing system info of job by qstat | grep shell command as dictionary
- Parameters
requested_id (int) – query for a specific job_id
- Returns
Dictionary with the output from the queuing system - optimized for the Sun grid engine
- Return type
dict
-
pyiron.base.server.queuestatus.queue_is_empty()[source]¶ Check if the queue table is currently empty - no more jobs to wait for.
- Returns
True if the table is empty, else False - optimized for the Sun grid engine
- Return type
bool
-
pyiron.base.server.queuestatus.queue_table(job_ids=[], project_only=True, full_table=False)[source]¶ Display the queuing system table as pandas.Dataframe
- Parameters
job_ids (list) – check for a specific list of job IDs - empty list by default
project_only (bool) – Query only for jobs within the current project - True by default
- Returns
Output from the queuing system - optimized for the Sun grid engine
- Return type
pandas.DataFrame
-
pyiron.base.server.queuestatus.wait_for_job(job, interval_in_s=5, max_iterations=100)[source]¶ Sleep until the job is finished but maximum interval_in_s * max_iterations seconds.
- Parameters
job (pyiron.base.job.generic.GenericJob) – Job to wait for
interval_in_s (int) – interval when the job status is queried from the database - default 5 sec.
max_iterations (int) – maximum number of iterations - default 100