Intel® Quartus® Prime Pro Edition User Guide: Scripting
A newer version of this document is available. Customers should click here to go to the newest version.
Visible to Intel only — GUID: reference_TCL_tcl_pkg_qed_ver_1_0_cmd_qed__configure_slurm_compute_spec
Ixiasoft
Visible to Intel only — GUID: reference_TCL_tcl_pkg_qed_ver_1_0_cmd_qed__configure_slurm_compute_spec
Ixiasoft
4.1.29.6. 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> ] [-lm_license_file <lm_license_file> ] [-quartus_rootdir <quartus_rootdir> ] [-slurm_additional_args <slurm_additional_args> ] [-slurm_cluster <slurm_cluster> ] [-slurm_cores_per_socket <slurm_cores_per_socket> ] [-slurm_environment_variables <slurm_environment_variables> ] [-slurm_initial_work_dir <slurm_initial_work_dir> ] [-slurm_memory <slurm_memory> ] [-slurm_partition <slurm_partition> ] [-slurm_priority <slurm_priority> ] [-slurm_resources <slurm_resources> ] [-slurm_sockets_per_node <slurm_socket_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. | ||
-lm_license_file <lm_license_file> | License file setting, LM_LICENSE_FILE | ||
-quartus_rootdir <quartus_rootdir> | Folder location where the Quartus Prime Pro software is installed and accessible on the remote machine. | ||
-slurm_additional_args <slurm_additional_args> | Specify additional SLURM args | ||
-slurm_cluster <slurm_cluster> | Specify the SLURM cluster setting | ||
-slurm_cores_per_socket <slurm_cores_per_socket> | Specify the SLURM cores per socket requirement | ||
-slurm_environment_variables <slurm_environment_variables> | Specify the SLURM environment variables setting | ||
-slurm_initial_work_dir <slurm_initial_work_dir> | Specify the SLURM initial work directory setting | ||
-slurm_memory <slurm_memory> | Specify the SLURM memory requirement. Example 16G | ||
-slurm_partition <slurm_partition> | Specify the SLURM partition setting | ||
-slurm_priority <slurm_priority> | Specify the SLURM job priority | ||
-slurm_resources <slurm_resources> | Specify the SLURM gres setting | ||
-slurm_sockets_per_node <slurm_socket_per_node> | Specify the SLURM sockets per node requirement | ||
<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: * -slurm_resources * -slurm_queue * -slurm_priority * -slurm_initial_work_dir * -slurm_environment_variables * -slurm_processor_limit 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 -exe quartus_sta |
||
Return Value | Code Name | Code | String Return |
TCL_OK | 0 | INFO: Operation successful |