Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 12/04/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

4.1.30.7. qed::configure_pbspro_compute_spec (::quartus::qed)

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

Tcl Package and Version

Belongs to ::quartus::qed

Syntax qed::configure_pbspro_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> ] [-pbspro_additional_args <pbspro_additional_args> ] [-pbspro_environment_variables <pbspro_environment_variables> ] [-pbspro_initial_work_dir <pbspro_initial_work_dir> ] [-pbspro_priority <pbspro_priority> ] [-pbspro_queue <pbspro_queue> ] [-pbspro_resources <pbspro_resources> ] <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.
-pbspro_additional_args <pbspro_additional_args> Specify additional PBSPro args
-pbspro_environment_variables <pbspro_environment_variables> Specify the PBSPro environment variables propagation setting
-pbspro_initial_work_dir <pbspro_initial_work_dir> Specify the PBSPro initial work directory setting
-pbspro_priority <pbspro_priority> Specify the PBSPro priority setting
-pbspro_queue <pbspro_queue> Specify the queue setting
-pbspro_resources <pbspro_resources> Specify the PBSPro resources setting
<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 PBSPro workload
management platform.

Use the following options to configure the PBSPro settings:
 * -pbspro_resources
 * -pbspro_queue
 * -pbspro_priority
 * -pbspro_initial_work_dir
 * -pbspro_environment_variables
 * -pbspro_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_pbspro_compute_spec workspace_id -exe quartus_sta
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful