Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 4/01/2024
Public
Document Table of Contents

4.1.31.8. qed::configure_slurm_compute_spec (::quartus::qed)

The following table displays information for the qed::configure_slurm_compute_spec Tcl command:

Tcl Package and Version

Belongs to ::quartus::qed

Syntax qed::configure_slurm_compute_spec [-h | -help] [-long_help] [-exe <quartus_sta|quartus_cdb|quartus_sh> ] [-exe_options <exe_options> ] [-additional_args <additional_args> ] [-cluster <cluster> ] [-constraint <constraint> ] [-cores_per_socket <cores_per_socket> ] [-email <email> ] [-env <env> ] [-initial_work_dir <initial_work_dir> ] [-licenses <licenses> ] [-lm_license_file <lm_license_file> ] [-memory <memory> ] [-output <output> ] [-partition <partition> ] [-priority <priority> ] [-quartus_rootdir <quartus_rootdir> ] [-resources <resources> ] [-sockets_per_node <sockets_per_node> ] <object>
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-exe <quartus_sta|quartus_cdb|quartus_sh> Executable to open the project with. Dictates the packages and commands that will be available to run.
-exe_options <exe_options> List of options to pass to executable.
-additional_args <additional_args> Additional arguments to pass to the slurm client when connecting to remote host
-cluster <cluster> Comma separated list of clusters to use
-constraint <constraint> Node features required as defined by Slurm administrator
-cores_per_socket <cores_per_socket> Number of CPU cores per socket
-email <email> Email address to receive job status updates. Defaults to submitting user.
-env <env> Comma-separated list of environment variables to pass to job
-initial_work_dir <initial_work_dir> Initial working directory on remote host. The remote host will start in this directory.
-licenses <licenses> Licenses that need to be allocated for this job
-lm_license_file <lm_license_file> LM_LICENSE_FILE environment setting
-memory <memory> Memory requirement per node. Default unit is megabytes
-output <output> Filename to store standard output
-partition <partition> Comma separated list of partitions to use
-priority <priority> Job priority. The higher the number, the higher the priority
-quartus_rootdir <quartus_rootdir> Appropriate Quartus Prime Pro installation folder to access the project
-resources <resources> Architecture, license, and/or memory requirement
-sockets_per_node <sockets_per_node> Number of CPUs per node
<object> Identifier associated with the object, must be unique
Description
Sets properties on the specified object to cause background Quartus
Prime Pro software instances to execute through the SLURM workload
management platform.

Use the following options to configure the SLURM settings:
 * -cluster
 * -partition
 * -memory
 * -sockets_per_node
 * -cores_per_socket
 * -priority
 * -resources
 * -constraint
 * -email
 * -additional_args
 * -env
 * -initial_work_dir
 * -output
 * -licenses

The "-exe" option specifies the Quartus Prime Pro executable to run.
The supported options are quartus_sta, quartus_cdb, and quartus_sh.

The "-exe_options" option specifies any options passed to the
executable that is specified with the "-exe" option.

The "-quartus_rootdir" option specifies the directory location of the
desired Quartus Prime Pro software installation. This is the root directory
of the software installation, not the bin directory.

The "-lm_license_file" option specifies the LM_LICENSE_FILE value
that will be passed to the Quartus Prime Pro software executable. If you
don't know the value, look in the Tools > License Setup dialog in
the Quartus Prime Pro software GUI.
Example Usage
    qed::configure_slurm_compute_spec workspace_id -exe quartus_sta
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful