pyepic.desktops package

Submodules

pyepic.desktops.desktop module

class pyepic.desktops.desktop.Desktop(data_path, node_code)

Bases: object

An EPIC Desktop Definition

Parameters:

  • data_path – The path to the data to be loaded on the Desktop, formed as an epic url (e.g. “epic://path_to/data”)

  • node_code (str) – The node_code of the Desktop Node Type to launch

Variables:

  • runtime (int) – The runtime for the Desktop in hours

  • mount_type (MountType) – How should the data folder be mounted to the desktop. Offline takes a copy of the data and will not be automatically synced back to the data store.

  • secure_ip (bool, optional) – Should we restrict which IPs can connect to this node? (defaults to False)

  • ip_address (str, optional) – If secure_ip is True, which IP should connections be restricted to?

  • invoice_reference (str, optional) – Reference string for this desktop to appear on invoices.

  • project_id (int, optional) – ID of the EPIC project to run this job in

get_launch_spec()

Get a Specification for this desktop for launching it

Returns:

Desktop Specification

Return type:

class:epiccore.models.DesktopNodeLaunchSpec

get_quote_spec()

Get a Specification for this desktop for quotes

Returns:

Desktop Quote Specification

Return type:

class:epiccore.models.DesktopNodeQuote

class pyepic.desktops.desktop.MountType(value)

Bases: Enum

How should the data folder be mounted to the desktop. Offline takes a copy of the data and will not be automatically synced back to the data store.

OFFLINE = 'offline'
ONLINE = 'online'

Module contents