qed::configure_pbspro_compute_spec (::quartus::qed)

Tcl Package and Version

Syntax

qed::configure_pbspro_compute_spec [-h | -help] [-long_help] [-exe <quartus_sta|quartus_cdb|quartus_sh> ] [-exe_options <exe_options> ] [-additional_args <additional_args> ] [-email <email> ] [-env <env> ] [-initial_work_dir <initial_work_dir> ] [-lm_license_file <lm_license_file> ] [-priority <priority> ] [-quartus_rootdir <quartus_rootdir> ] [-queue <queue> ] [-resources <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.

-additional_args <additional_args>

Additional arguments to pass to the pbspro client when connecting to remote host

-email <email>

List of email addresses to receive job status updates. Comma separated.

-env <env>

A 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.

-lm_license_file <lm_license_file>

LM_LICENSE_FILE environment setting

-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

-queue <queue>

Name of the job queue to use

-resources <resources>

Architecture, license, and/or memory requirement

<object>

Identifier associated with the object, must be unique

Description

Sets properties on the specified object to cause background Quartus
Prime software instances to execute through the Altair PBS Professional
workload management platform.

Use the following options to configure the Altair PBS Professional settings:
 * -queue
 * -priority
 * -resources
 * -email
 * -additional_args
 * -env
 * -initial_work_dir

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

    qed::configure_pbspro_compute_spec workspace_id -exe quartus_sta

Return Value

Code Name

Code

String Return

TCL_OK

0

INFO: Operation successful

Tcl Package and Version	Belongs to ::quartus::qed 1.0
Syntax	`qed::configure_pbspro_compute_spec [-h \| -help] [-long_help]` `[-exe` <quartus_sta\|quartus_cdb\|quartus_sh> `]` `[-exe_options` <exe_options> `]` `[-additional_args` <additional_args> `]` `[-email` <email> `]` `[-env` <env> `]` `[-initial_work_dir` <initial_work_dir> `]` `[-lm_license_file` <lm_license_file> `]` `[-priority` <priority> `]` `[-quartus_rootdir` <quartus_rootdir> `]` `[-queue` <queue> `]` `[-resources` <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.
	`-additional_args` <additional_args>		Additional arguments to pass to the pbspro client when connecting to remote host
	`-email` <email>		List of email addresses to receive job status updates. Comma separated.
	`-env` <env>		A 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.
	`-lm_license_file` <lm_license_file>		LM_LICENSE_FILE environment setting
	`-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
	`-queue` <queue>		Name of the job queue to use
	`-resources` <resources>		Architecture, license, and/or memory requirement
	<object>		Identifier associated with the object, must be unique
Description	Sets properties on the specified object to cause background Quartus Prime software instances to execute through the Altair PBS Professional workload management platform. Use the following options to configure the Altair PBS Professional settings: * -queue * -priority * -resources * -email * -additional_args * -env * -initial_work_dir 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	qed::configure_pbspro_compute_spec workspace_id -exe quartus_sta
Return Value	Code Name	Code	String Return
TCL_OK	0	INFO: Operation successful