Code documentation

jobs module

This module implements classes for the different SLURM job types used in GfxLauncher.

Jobs module

This module provides classes for supported job types.

class lhpcdt.jobs.Job(account='', partition='', time='00:60:00')

Class describing a SLURM jobs

add_constraint(constraint)

Add constraint (feature)

class lhpcdt.jobs.JobPluginBase(account='', partition='', time='00:60:00')

Base class for loadable job plugins.

class lhpcdt.jobs.JupyterLabJob(account='', partition='', time='00:30:00', jupyterlab_module='Anaconda3', use_localhost=False, conda_env='')

Jupyter lab job

do_process_output(output_lines)

Process job output

on_notebook_url_found(url)

Event method called when notebook has been found

class lhpcdt.jobs.JupyterNotebookJob(account='', partition='', time='00:30:00', notebook_module='Anaconda3', use_localhost=False, conda_env='')

Jupyter notebook job

do_process_output(output_lines)

Process job output

on_notebook_url_found(url)

Event method called when notebook has been found

class lhpcdt.jobs.PlaceHolderJob(account='', partition='', time='00:30:00')

Placeholder job running acting as master process

class lhpcdt.jobs.VMJob(account='', partition='', time='00:30:00')

Special Job for starting VM:s

do_update_processing()

Check for vm job ip file

on_vm_available(hostname)

Callback when job ib file found.

lhpcdt.jobs.find_remote_port(url)

Extract port information from a url.

conda_utils module

Module implementing conda integration.

job_ui module

This module provide job user interface functionality.

Job User Interface module

This module provide job user interface functionality.

class lhpcdt.job_ui.JupyterNotebookJobPropWindow(parent=None)

Resource specification window

disable_controls()

Disable controls on dialog

enable_controls()

Enable all controls on dialog

get_data()

Get values from controls

modules_supports_anaconda()

Check for anaconda support

on_browse_modules_button_clicked()

Start ml-browse as a separate thread

on_cancel_button_clicked()

Event method for Cancel button

on_ok_button_clicked()

Event method for OK button

on_process_thread_finished()

Handle output from ml-browse

on_query_completed()

Conda queryt callback when query is completed

on_query_env(conda_env)

Conda query callback for updating UI

on_timeout()

Timeout for starting conda query

set_data()

Assign values to controls

showEvent(event)

Disable controls and start timer for querying modules

update_controls()

Update user interface controls

update_list()

Update list box

class lhpcdt.job_ui.ProcessThread(cmd)

Job submission thread

run()

Main thread method

launcher module (Main user interface)

This module implements the main user interface of GfxLauncher.

LUNARC HPC Desktop Launcher Module

This module implements the main user interface of the application launcher.

class lhpcdt.launcher.GfxLaunchWindow(parent=None)

Main launch window user interface

closeEvent(event)

Handle window close event

disable_extras_panel()

Clear user interface components in extras panel

dump_error_log()

Dump errors on standard output

enable_extras_panel()

Clear user interface components in extras panel

enable_silent_ui()

Hides controls for running in silent mode.

get_defaults_from_cmdline()

Get properties from command line

has_project()

Check for user in grantfile

init_defaults()

Basic property defaults

launch_browser(url)

Open a configured browser for the url.

on_append_text(text)

Callback for to update status output from standard output

on_autostart_timeout()

Automatically submit jobn

on_cancelButton_clicked()

Cancel running job

on_closeButton_clicked()

User asked to close window

on_helpButton_clicked()

Open help page if set

on_notebook_url_found(url)

Callback when notebook url has been found.

on_reconnect_notebook()

Reopen connection to notebook.

on_reconnect_vm()

Reopen connection to vm

on_resourceDetailsButton_clicked()

Open resources specification window

on_showDetails_clicked()

Show details on job and script

on_show_job_settings_button_clicked()

Open help page if set

on_startButton_clicked()

Submit job

on_status_timeout()

Status timer callback. Updates job status.

on_submit_finished()

Event called from submit thread when job has been submitted

on_vm_available(hostname)

Start an RDP session to host

submit_job()

Submit placeholder job

time_to_decimal(time_string)

Time to decimal conversion routine

update_controls()

Update user interface from properties

update_feature_combo()

Update only feature combo box.

update_properties()

Get properties from user interface

class lhpcdt.launcher.OutputReceiver(queue, *args, **kwargs)

Receiver thread for synchronised access to queued output

class lhpcdt.launcher.SubmitThread(job, cmd='xterm', opengl=False, vglrun=True, vgl_path='')

Job submission thread

run()

Main thread method

class lhpcdt.launcher.TunnelThread(ssh_tunnel)

Job submission thread

disconnect(a0: QMetaObject.Connection) → bool

disconnect(self) → None

run()

Main thread method

class lhpcdt.launcher.WriteStream(queue)

Class for synchronised stream writing

desktop module - Menu generation classes

Module for generating menu items and menus in Linux.

class lhpcdt.desktop.DesktopEntry(dryrun)

Implements a XDG menu entry

write()

Write desktop entry

class lhpcdt.desktop.Menu(dryrun=False)

XDG Menu class

write()

Write menu XML

scripts module - Run script generation

config module - Configuration management classes

Module for managing application configuration.

Configuration module

This reads the configuration file and maintains a configuration singleton for other parts of the application to access configuration options.

lrms module - SLURM interface classes

Module for interfacing with SLURM.

Base classes for interacting with resource management systems.

class lhpcdt.lrms.Accounting

sacct -o jobid%20,jobname%50,state%30,exitcode%20

class lhpcdt.lrms.GrantFile(filename)

Class for accessing LUNARC grantfiles

query_active_projects(user)

Query for an active project for user

class lhpcdt.lrms.Queue

Class for encapsuling a SLURM queue

job_info(jobid)

Return information on job jobid

update()

Update queue information

class lhpcdt.lrms.Slurm

SLURM Interface class

cancel_job(job)

Cancel job

cancel_job_with_id(jobid)

Cancel job

has_started(job)

Query if job has started

is_waiting(job)

Query if job is in an non-running state

job_output(job)

Query job output

job_status(job)

Query status of job

query_features(part, exclude_set={})

Query features of partition

query_gres(part)

Query features of partition

query_node(node)

Query information on node

query_nodes()

Query information on node

query_partitions(exclude_set={})

Query partitions in slurm.

submit(job)

Submit job to SLURM

wait_for_start(job)

Wait for job to start

lhpcdt.lrms.execute_cmd(cmd)

Wrapper function for calling an external process

remote module - Remote execution classes

This module implements several remote execution methods (SSH, VGLConnect and XfreeRDP).

Remote launch module

This module implements different classes for remote launch methods.

class lhpcdt.remote.SSH(local_exec=False)

Implements a SSH connection

execute(node, command, re_count=0)

Execute command on a node/host

execute_again()

Execute again with the same command and node

execute_with_output(node, command, re_count=0)

Execute command node, capturing output.

is_active()

Return SSH connection status

terminate()

Terminate SSH connection process

wait()

Blocking wait for process to finish.

class lhpcdt.remote.StatusProbe(local_exec=False)

check_cpu_usage(node)

Check cpu usage of node

check_memory(node)

Check memory status of node

print_summary()

Print probe summary

class lhpcdt.remote.VGLConnect

Implements a remote connecting supporting VirtualGL

execute(node, command, re_count=0)

Execute a command on a host

execute_again()

Execute command again with same parameters.

is_active()

Return status of VGL connection

terminate()

Terminate connection process

wait()

Wait for process to finish.

class lhpcdt.remote.XFreeRDP(hostname)

Implements a RDP connection

execute()

Execute command on a node/host

get_xfreerdp_cmd()

Get method for xfreerdp_cmd property

get_xfreerdp_path()

Get method for xfreerdp_path property

is_active()

Return RDP connection status

set_xfreerdp_cmd(c)

Set method for xfreerdp_cmd property

set_xfreerdp_path(p)

Set method for xfreerdp_path property

terminate()

Terminate RDP connection process

wait()

Wait for the process to exit

property xfreerdp_cmd

Get method for xfreerdp_cmd property

property xfreerdp_path

Get method for xfreerdp_path property

lhpcdt.remote.find_available_port()

Find an available tcp port.