Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 9/29/2025
Public
Document Table of Contents

4.1.35.6. rpc::create_slurm_compute_spec (::quartus::rpc)

The following table displays information for the rpc::create_slurm_compute_spec Tcl command:

Tcl Package and Version

Belongs to ::quartus::rpc

Syntax rpc::create_slurm_compute_spec [-h | -help] [-long_help] [-exe <quartus_sta|quartus_cdb|quartus_sh> ] [-exe_options <exe_options> ] [-id <id> ] [-additional_args <additional_args> ] [-cluster <cluster> ] [-constraint <constraint> ] [-cores_per_socket <cores_per_socket> ] [-cpus_per_task <cpus_per_task> ] [-email <email> ] [-env <env> ] [-initial_work_dir <initial_work_dir> ] [-licenses <licenses> ] [-lm_license_file <lm_license_file> ] [-memory <memory> ] [-modules <modules> ] [-output <output> ] [-partition <partition> ] [-priority <priority> ] [-quartus_rootdir <quartus_rootdir> ] [-resources <resources> ] [-sockets_per_node <sockets_per_node> ]
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.
-id <id> Identifier used to refer to a unique compute specification.
-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
-cpus_per_task <cpus_per_task> Number of CPUs per task
-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. Format is <value><units>. Units can be K,M,G or T. Default unit is megabytes
-modules <modules> Comma-separated list of environment modules to pass to job
-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 installation folder to access the project
-resources <resources> Architecture, license, and/or memory requirement
-sockets_per_node <sockets_per_node> Number of CPU sockets per node
Description
Defines a compute specification that causes background Quartus
Prime 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 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 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 software executable. If you
don't know the value, look in the Tools > License Setup dialog in
the Quartus Prime software GUI.
Example Usage
    rpc::create_slurm_compute_spec -exe quartus_sta
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful