daemon.add_cluster

jcmwave.daemon.add_cluster(Nodes, Hostname='localhost', JCMROOT=None, Login='', SSHClient=None, SSHAgentForwarding=None, SSHTimeOut=None, PEMFile=None, Multiplicity=1, NThreads=1, WorkingDir='', OOCDir=None, MaxCoreSize=None, LicenseServerPort=None)

Adds a new computation cluster. Example:

cluster=[{'Hostname': 'computer1'},{'Hostname': 'computer2'}]
jcmwave.daemon.add_cluster(Hostname='computer1', Nodes=cluster)
Parameters:

  • Hostname (str) – host name of the remote cluster access point To form a login chain concatenate the hostnames with ; separators, i.e gateway.com;maxwell

  • JCMROOT (str) – JCMsuite installation path on remote computer default: same directory as local installation

  • PEMFile (str) – File with private ssh-key for establishing a ssh connection, e.g. ~/.ssh/id_rsa (optional).

  • Login (str) – Login name to the remote computer For a login chain concatenate the user names with ; separators, i.e user1;user2

  • SSHClient (str) – ssh client used to establish a secure connection to the remote machine. As a default the system ssh client is used (if not available on Windows Putty’s plink is used) For a login chain concatenate ssh clients with ‘;’ separators, i.e ‘plink;ssh’

  • SSHAgentForwarding (str) – Enables forwarding of the authentication agent connection. (boolean, default False)

  • SSHTimeOut (str) – Timeout for establishing the ssh connection (default 6s)

  • Multiplicity (int) – allow for multiple simultaneous use of the resource default: 1 (single use)

  • NThreads (int) – number of threads used by one job on the remote computer

  • WorkingDir (str) – Directory used by JCMsuite to place temporary files.

  • OOCDir (str) – swapping directory for out-of-core data

  • MaxCoreSize (int) – restricts maximum core RAM usage (requires setting of swapping directory OOCDir)

  • Nodes (list) –

    List for the specification of the computer nodes of the cluster. An entry is a dictionary with keys the following key-value pairs:

    ’Hostname’ -> hostname (or ip-address) of the cluster node as seen from the cluster access point

    The first node in the custer must be the cluster access point.

    ’JCMROOT’ -> JCMsuite installation path on this cluster node

    As default None is also accepted (as JCMROOT the value of the access point is used)

    ’GPU’ -> activates GPU usage and select specific GPU by its identifier. Either all nodes should have access to a GPU or none.

  • LicenseServerPort (int) – If the remote machine cannot reach the local license server (e.g. a cloud instance), it can be configured to look for the license server at localhost:XXXX. Then, LicenseServerPort must be equal to XXXX. default: No port forwarding.

Warning

Adding a machine recursively increases the number of simultaneously running jobs on this machine.