daemon.add_queue

jcmwave.daemon.add_queue(Hostname='localhost', JCMROOT=None, Login='', SSHClient=None, SSHAgentForwarding=None, SSHTimeOut=None, Multiplicity=10, Type='Slurm', Account='', JobName='', PartitionName='', NNodes=None, NTasks=None, NTasksPerNode=None, NodeList='', ExcludeNode='', CmdLineArgs='', WorkingDir='', NThreads=1, Time=None, Features=None, Exclusive=None, MemoryPerJob=None, OOCDir=None, MaxCoreSize=None, Environment=None)

Adds a new queue with a given multiplicity. Example:

jcmwave.daemon.add_queue(Hostname='localhost', Multiplicity=24, NThreads=4)
Parameters:
  • Hostname (str) – host name of the (remote) login node of the queue. To form a login chain concatenate the hostnames with ; separators, i.e gateway.com;maxwell
  • JCMROOT (str) – JCMsuite installation path on computing nodes of the queue. default: same directory as local installation
  • Login (str) – Login name to the (remote) login node of the queue 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 multiply simultaneous submission of jobs to the queue default: 10
  • Type (str) – Determines type of batch queue. Possible values are: Slurm. default: Slurm
  • NThreads (int) – number of threads used by one job on the remote computer
  • Account (str) – Your slurm account [optional]
  • PartitionName (str) – Name of the slurm partition you want to add
  • NNodes (str) – number of nodes allocated for each job to run a cluster parallel problem
  • NTasks (str) – number of tasks allocated for each job to run a cluster parallel problem
  • NTasksPerNode (str) – (maximum) number of taks per node
  • WorkingDir (str) – Directory used by JCMsuite to place temporary files. Project files are copied as well if the project directory is not shared by the login nodes and the nodes of the queue. This directory must be accessible by any node of the queue, i.e. a directory on a shared filesystem.
  • Features (str) – Constraints job allocation to nodes of the cluster with the selected features.
  • NodeList (str) – Limit job execution to a specific node of the cluster.
  • ExcludeNode (str) – Exclude a node of a partition from executing jobs. Multiple nodes can be entered as a comma separated list containing no spaces, i.e. maxwell1,maxwell2,… or as a range of nodes, i.e. maxwell[1-3].Setting a node list and excluding a node are mutually exclusive.
  • OOCDir (str) – swapping directory for out-of-core data
  • MaxCoreSize (int) – restricts maximum core RAM usage (requires setting of swapping directory OOCDIR)
  • MemoryPerJob (int) – Reserve at least MemPerCPU MB of RAM for every job that is run on this allocation (for a distributed job running on multiple nodes this is the maximum memory usage per node)
  • Time (float) – total run time limit in minutes.
  • CmdLineArgs (str) – Command line arguments as used for the submission tool. This allows you to pass options directly to the submission tool. For a slurm queue these arguments are placed at the end of the header of the sbatch file. It is possible to skip all the above queue related arguments and to use only this parameter to configure the queue options.
  • Environment (str) – list of environment variables (separated by white spaces)

Warning

Adding a job queue recursively increases the number of simultaneously submitted jobs in this queue.