B

Environment Variables

This appendix describes public environment variables that control the characteristics of the Virtuoso ADE Explorer. You can customize the operation and behavior of ADE Explorer by changing the value of a particular environment variable.

This appendix lists the environment variables in the following areas:

Simulation Environment

LBS Distributed Processing Environment

These sections describe the environment variables used to set up and use distributed processing for job simulation in Virtuoso® using the Cadence© Load Balancing Software (LBS).

Simulator-Specific Environment Variables

Environment variables that you add in your .cdsinit file are applicable to all the simulators that you want to use. To specify environment variables that apply only to specific simulators, define the sessInitTrigFunc function in your .cdsinit file.

Ensure that the name of this function does not begin with a lower-case character.

After the sessInitTrigFunc function is defined in the .cdsinit file, you can create an entry for this function in the .cdsenv or .cdsinit files to indicate the specified function name.

Consider the following example in which you specify different resource requirement strings for the Spectre simulator and UltraSim simulator.

Add the following in your .cdsinit file:

procedure(CCSsessInitTrigFunc(session)
    case(asiGetSimName(session)
     ("spectre"
 envSetVal("asimenv.distributed" "lsfResourceString" 'string "lsfStringForSpectre")
  )
  ("UltraSim"
 envSetVal("asimenv.distributed" "lsfResourceString" 'string "lsfStringForUltraSim")
  )
 )
)

Here,

session is the name of the asi session.
lsfStringForSpectre is the LSF resource requirement string for the Spectre simulator.
lsfStringForUltraSim is the LSF resource requirement string for the UltraSim simulator.

Set the following environment variables in your .cdsenv and .cdsinit files, indicating the name of the sessInitTrigFunc function to be used:

In the .cdsenv file:

asimenv.startup sessInitTrigFunc string "CCSsessInitTrigFunc"

In the .cdsinit file:

envSetVal("asimenv.startup" "sessInitTrigFunc" 'string "CCSsessInitTrigFunc")

Environment Variables for Distributed Processing

This section describes the environment variables that control various distributed processing settings. Add the variables you want to use in your .cdsenv file.

The following environment variables are common to all distributed jobs:

userDefinedJobName

The default value is nil.By default, job are started with the prefix "job" in the name. When specified before a virtuoso run, this variable overrides the default job value in the Job Name field of the Job Policy Setup form. This will be effective until you explicitly change the job name in the Job Policy Setup form. You cannot set this variable during a session. This variable is most useful in regression runs with distributed systems and with different job names in each run set through the environment variable.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed userDefinedJobName string "" nil

Example

envSetval "asimenv.distributed" "userDefinedJobName" 'string "robert"

copyModeDir

The directory, relative to the execution host, that is set up as the working directory of a copy mode job.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed copyModeDir string "/tmp" nil

hostMode

Makes the distributed processing option the default in the analog circuit design environment.

To set this variable in the .cdsenv file, enter the following:

asimenv.startup hostMode "distributed"

autoJobSubmit

If set to nil, the Job Policy Setup form is presented to the user at the time when the job is submitted. If set to t, jobs are submitted automatically.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed autoJobSubmit boolean t

bypassNetlist

If this variable is set to its default value, nil, netlisting is done for all the subtasks of a multi-task job before job submission. If it is set to t, netlisting is bypassed for subtasks.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed bypassNetlist boolean nil

hostName

Sets the default host name. If unspecified, the load balancer automatically selects the host.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed hostName  string    nil

If the environment variables queueName, hostName, and drmsCommand are specified in the .cdsinit file, then the mode is selected as per the order of precedence –queue, list, and command. This means that if all the environment variables are specified, the queue mode will be selected; if hostName and drmsCommand are specified, the list mode will be used; whereas, if only the drmsCommand is specified, the command mode will be used.

startTime

Sets the specified time as the default start time for a job. If unspecified, the job runs immediately.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed startTime  string  "20:00"  nil

mailTo

Sets the default list of users who will receive an e-mail when the job terminates. If unspecified, no e-mail notification is provided.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed mailTo  string  ""  nil

stateFile

By default, the system creates a file named .adpState in your home directory containing the job server’s state. You can rename the file and put it in a different directory by modifying the statefile string.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed stateFile  string  "statefile"  nil

showMessages

If set to t, a message is displayed in the CIW or OCEAN terminal when a job is completed.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed showMessages boolean  t  nil

startDay

Sets the default start day for a job. If set to today, the job will always run on the same day it is submitted.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed startDay  cyclic  "day"  nil

Valid Values: today, Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday.

expTime

Sets the specified time as the default expiration time for the job. If unspecified, expiration time is based on the value of the timeLimit variable.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed expTime string  "06:30"  nil

expDay

Sets the default expiration day for a job. If set to today, the job always runs on the same day it is submitted.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed expDay cyclic  day  nil

Valid Values: today, Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday.

timeLimit

Sets the default time limit for a job. If set to none, no time limit is imposed. If set to unspecified, the expiration time is based on the value of expTime and expDay variables.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed timeLimit cyclic  time  nil

Valid Values: unspecified, none, 5 minutes, 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours, 1 day, 2 days, 3 days, 5 days, and 10 days.

emailNotify

If set to t, e-mail notification is provided following job termination.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed emailNotify boolean  t  nil

logsInEmail

If set to t, stdout and stderr logs are included in the termination e-mail.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed logsInEmail boolean  t  nil

daysBeforeExpire

Specifies the number of days after which terminated jobs are deleted from the job server.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed daysBeforeExpire int  3  nil

block

If set to t, analog circuit design environment or OCEAN will be blocked until all the jobs have completed.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed block boolean  nil

loginShell

Specifies login shell for the job. If set to none, the user’s local environment is copied over to the execution host and used as the job’s environment.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed loginShell  cyclic   shell  nil

Valid Values: none, csh, ksh, and sh.

puttogetherqueue

Used to specify the queue to be used for Put Together Job.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed puttogetherqueue string "" n

copyNetlist

Used to specify whether the netlist directory needs to be copied from the execution host to the submission host. This may be required during simulation if some files are generated under netlist dir.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed copyNetlist boolean nil

logsDir

Used to specify the directory name where log files of jobs submitted through distributed processing are stored. The default value of the variable is "/tmp". There are some specific checks made for the value specified for logsDir, which are as follows:

If the value specified starts from "." or "~", it is expanded using simplifyFilename().
If a directory named logsDir exists, it is used as the log directory for the current job.
Otherwise, display a message requesting for creation of a directory. If the user response is a No, the job is not submitted. If the user response is a Yes, create a directory as specified in logsDir:
- If the directory is created successfully, use this as logsDir.
- Else, display a message stating that the directory cannot be created. In this message ask if the user wishes to use "/tmp" as logsDir and then continue. If the response is a Yes, "/tmp" used as logsDir. If the response is a No, it stops at this point without any job submission.The value of this variable can be changed from one job to another.

The user must ensure that the logsDir specified is exported on all the hosts participating in distributed processing.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed logsDir string "/tmp" nil

mailAllLogs

If set to t, sends out a mail after completion of all the tasks and each individual task.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed mailAllLogs boolean  nil

logsInPsf

If set to t, stores the stdout/stderr log file in the corresponding psf directory.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed logsInPsf boolean  nil

shellCmd

Specifies the default value for Shell_Cmd_at_Finish as available in the Job Policy Setup form.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed shellCmd string ""

listMode

Specifies whether the list option for specifying hosts needs to be displayed in the Job Policy Setup form. If set to nil, the list option will not be displayed. Therefore, you will only be able to submit jobs from queues.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed listMode boolean t

deleteJob

Specifies whether to remove a job and its log files from the distributed processing database after the job is complete. If this variable is set to t, the same job name can be used in successive runs. For example, if you submit a job by the name Job001, the data for this job is generated in the <>/..../job001 directory. When you submit another job after the completion of job001, the same job name can be used in the Job Name field of the Job Policy Setup form and the data for that is generated at the same directory <>/..../job001.

The results of the previous run are not deleted. However, results of all the runs for the same job name are saved in the same directory. To delete the data specifically, use the Results – Delete menu option.

The GUI option corresponding to the deleteJob environment variable is the Reuse Job Name After Completion option on the Job Policy Setup form. To set this variable in the .cdsenv file use the following call:

asimenv.distributed deleteJob boolean t

To set this variable in the .cdsinit file or CIW, use the following call:

envSetVal("asimenv.distributed" "deleteJob" 'boolean t)

Remote login is required in order to remove the error or log files. You can delete the error or log files without the remote login, by setting the following variable in .cdsenv file:

asimenv.distributed deleteWithoutRemLogin  boolean  t

If set to t, the log files are removed from the NFS mounted path without the remote login.

Make sure that the /tmp/cds_erasefile.<userID> is deleted from all the remote machines.

removeJobData

Specifies whether to remove the results data of a job from the distributed processing database before submitting a new job with the same name. For example, if you submit a job by the name Job001, the data for this job is generated in the <>/..../job001 directory. When you submit another job with the same name, the data for that would be generated at the same location <>/..../job001. However, if the removeJobData variable is set to t, the results of the previous run are deleted before submitting the new job. The GUI option corresponding to the removeJobData environment variables is the Remove Data before job submission option on the Job Policy Setup form.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed removeJobData boolean nil

Environment Variables for Distributed Processing with LBS

This section describes the environment variables that control various distributed processing options. Add the variables you want to use in your .cdsenv file.

The following environment variables are available when jobs are distributed using LBS:

lsfResourceString

Specifies the LSF resource requirement string. The resource requirement string is displayed in the LSF Resource String field in the Job Policy Setup form. To use the resource requirement string when submitting a job, select the LSF Resource String check box in the Job Policy Setup form, or add the selectLsfResourceString t variable. For more information about resource requirement strings, see System Administration of Distributed Jobs with LBS.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed lsfResourceString string ""

selectLsfResourceString

If set to nil, the specified LSF resource string is not used when you submit a job, unless you select the LSF Resource String check box in the Job Policy Setup form. If set to t, the specified LSF resource string is used when a job is submitted.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed selectLsfResourceString  boolean  t

drmsCommand

Specifies the DRMS commands you want to use to submit jobs in the command mode. For example, you can specify bsub commands for LSF or qsub commands for SGE (Sun Grid Engine) for submitting jobs using this environment variable. When this environment variable is set, the command option in the Job Policy Setup form is selected by default and the specified DRMS commands are displayed in the command field. For more information about submitting jobs using the command mode, see Submitting Simulation Jobs in LBS Distribution Method.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed drmsCommand string ""

queueName

Sets the default queue name. If unspecified, the system default specified in your setup file is used.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed queueName  string  ""  nil

queueNameExclusionList

Removes the specified queues from the list of queues available to distributed processing for submitting jobs. For example, if there are four LSF queues named Q1, Q2, Q3, and Q4 and you set the variable to "Q1 Q3", then only Q2 and Q4 will be available to distributed processing for submitting jobs.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed queueNameExclusionList string "" nil

queueNameInclusionList

Makes only the specified queues available to distributed processing for submitting jobs. For example, if there are four LSF queues named Q1, Q2, Q3, and Q4 and you set the variable to "Q1 Q4", then only Q1 and Q4 will be available to distributed processing for submitting jobs.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed queueNameInclusionList string ""

remoteShell

Sets rsh as the default remote connection mode and rcp as the default remote copy mode for distributed processing. Specify the value ssh to use ssh as the connection mode and scp as the copy mode for distributed processing. You can also specify the path to any other script or command to be used as the default remote connection mode. If you do this, rcp will be used as the default remote copy mode. You can use the remoteCopy environment variable to specify a different command to be used as the default remote copy mode.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed remoteShell string “rsh”

Valid Values: rsh, ssh, or the path to any other script or command.

Default Values: rsh

remoteCopy

Allows you specify the path to the command to be used as the default remote copy mode for distributed processing. If this environment variable is not set, the default remote copy mode for distributed processing will depend on the settings for the remoteShell environment variable.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed remoteCopy string ""

queueName

Specifies name of the queue in which the job is to be submitted. This variable is used in both SGE and LSF modes.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed queueName string nil

lsfApplicationProfile

Specifies name of an application profile to be used in LSF mode.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed lsfApplicationProfile string

selectLsfApplicationProfile

Specifies if the value specified by lsfApplicationProfile is to be used in LSF mode.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed selectLsfApplicationProfile boolean

lsfNoOfProcessors

Specifies the number of parallel processors to be used in LSF mode.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed lsfNoOfProcessors string "3"

selectLsfNoOfProcessors

Specifies if the value specified by lsfNoOfProcessors is to be used in LSF mode.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed selectLsfNoOfProcessors boolean

sgeNoOfProcessors

Specifies the default number of processors to be used in SGE mode.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed sgeNoOfProcessors string nil

sgeParallelEnvName

Specifies name of the parallel environment in SGE mode.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed sgeParallelEnvName string nil

sgeSoftResources

Specifies the default soft resources to be used in SGE mode.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed sgeSoftResources string nil

sgeHardResources

Specifies the default hard resources to be used in SGE mode.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed sgeHardResources string nil

sgePriority

Specifies the default priority to be set for a job submitted in SGE mode. Default value set to 0.

To set this variable in the .cdsenv file, enter the following:

asimenv.distributed sgePriority int nil

adexl.monte

additionalNetlistOptions

adexl.monte additionalNetlistOptions string any_string

Description

Specifies the additional analysis options to be generated in the netlist.

You cannot specify the numruns, firstrun, and seed options using this environment variable.

The default value is " ".

GUI Equivalent

Command	Monte Carlo
Field	Netlist Options

Examples

envGetVal("adexl.monte" "additionalNetlistOptions")

envSetVal("adexl.monte" "additionalNetlistOptions" 'string "nullmfactorcorrelation=yes")

applySaveOptionsToNetlist

adexl.monte applySaveOptionsToNetlist boolean { t | nil }

Description

Controls the writing of process and mismatch parameter information in the netlist. The valid values are:

t: Applies the saveprocessparams and savemismatchparams options in the netlist depending on the settings for the Save Process Data and Save Mismatch Data check boxes in the Monte Carlo form.
For example, if the Save Process Data and Save Mismatch Data check boxes are not selected in the Monte Carlo form, the saveprocessparams and savemismatchparams options are set to no in the netlist and Spectre will not write process and mismatch parameter information to the disk.
For more information about the saveprocessparams and savemismatchparams options, see the Spectre Circuit Simulator Reference.
nil: Writes process and mismatch parameter information in the netlist.
When nil, the settings for the Save Process Data and Save Mismatch Data check boxes in the Monte Carlo form are not passed to the netlist.

The default value is t.

Examples

envGetVal("adexl.monte" "additionalNetlistOptions")

envSetVal("adexl.monte" "additionalNetlistOptions" 'boolean t)

envSetVal("adexl.monte" "additionalNetlistOptions" 'boolean nil)

createStatisticalCornerType

adexl.monte createStatisticalCornerType cyclic { sequence | value | prompt | promptValues | auto }

Description

Controls the writing of process and mismatch parameter information in the netlist.It has the following valid values:

sequece: Create a statistical corner by using a sequence ID of a sample.
value: Create a statistical corner by using the statistical parameter values of a sample.
This requires saving the mismatch data while running Monte Carlo
prompt: Displays the Create Statistical Corner form in which you can confirm which one of the two types mentioned above is to be used to create a statistical corner. The default choice selected in the form is to create the sequence ID-based corner.
If you have saved the mismatch data while running Monte Carlo, you can choose to create a statistical corner by using the statistical parameter values.
promptValues: Displays the Create Statistical Corner form in which you can confirm which one of the two types mentioned above is to be used to create a statistical corner. The default choice selected in the form is to create the statistical parameter-based corner.
auto: Automatically creates a statistical corner after completion of simulation using the statistical parameter values of an appropriate sample generated by Spectre. The selected sample varies depending on the Monte Carlo method used for running simulation.

The default value is auto.

Examples

envGetVal("adexl.monte" "createStatisticalCornerType")

envSetVal("adexl.monte" "createStatisticalCornerType" 'cyclic "auto")

envSetVal("adexl.monte" "createStatisticalCornerType" 'cyclic "sequence")

envSetVal("adexl.monte" "createStatisticalCornerType" 'cyclic "value")

envSetVal("adexl.monte" "createStatisticalCornerType" 'cyclic "prompt")

envSetVal("adexl.monte" "createStatisticalCornerType" 'cyclic "promptValues")

enableMonteCarloOverStatisticalCorners

adexl.monte enableMonteCarloOverStatisticalCorners boolean { t | nil }

Description

Enables you to run Monte Carlo analysis (mismatch variation) over parameter-based statistical corners, consisting of process variation. It can have the following values:

t: Monte Carlo analysis can be run over parameter-based statistical corners.
nil: Monte Carlo analysis cannot be run with statistical corners.

The default value is nil.

Examples

envGetVal("adexl.monte" "enableMonteCarloOverStatisticalCorners")

envSetVal("adexl.monte" "enableMonteCarloOverStatisticalCorners" 'boolean nil)

envSetVal("adexl.monte" "enableMonteCarloOverStatisticalCorners" 'boolean t)

incrementalUpdate

adexl.monte incrementalUpdate boolean { t | nil }

Description

Controls the update of Monte Carlo simulation results in the Results tab of the Outputs pane. It can have the following values:

t: Monte Carlo simulation results are updated after each iteration of the Monte Carlo run.
Use the iterationUpdates environment variable to specify the number of iterations of the Monte Carlo run after which the simulation results are updated in the Results tab of the Outputs pane.
nil: Monte Carlo simulation results are displayed only after all iterations of the Monte Carlo run are over.

The default value is t.

Examples

envGetVal("adexl.monte" "incrementalUpdate")

envSetVal("adexl.monte" "incrementalUpdate" 'boolean t)

envSetVal("adexl.monte" "incrementalUpdate" 'boolean nil)

iterationUpdates

adexl.monte iterationUpdates int integer

Description

Controls the number of iterations of the Monte Carlo run after which simulation results are updated in the Results tab of the Outputs pane.

The default value is 10.

Examples

envGetVal("adexl.monte" "iterationUpdates")

envSetVal("adexl.monte" "iterationUpdates" 'int 10)

envSetVal("adexl.monte" "iterationUpdates" 'int 20)

minGroupSizeSplitAcrossIdleJobs

adexl.monte minGroupSizeSplitAcrossIdleJobs int integer

Description

Specifies the minimum group size to be considered while splitting or distributing the Monte Carlo simulation points to the available idle jobs. By default, the points are not reallocated after an initial assignment to jobs. However, if there are multiple jobs, you can set this variable to a value greater than 1 to enable reallocation of points. In this case, ADE XL identifies the busy or idle jobs, and if the number of pending points on a busy job is more than the specified group size, it reallocates some of the points to the idle jobs, thereby helping in optimum utilization of the available resources.

For example, if a Monte Carlo simulation has 100 points and the Max Jobs field on the Job Policy Setup form is set to 2, a set of 50 simulation points are allocated to each one of job1 and job2. If the simulations running on job1 are completed faster than those running on job2, job1 becomes idle. If you have specified the minimum size for a group of simulations to be considered for the reallocation of points to 5 and the number of points pending with job2 is greater than 5, some of the points are reallocated to job1. This can improve the overall run time for Monte Carlo simulations.

The default value is 0.

This environment variable is not supported in reliability analysis for Monte Carlo run mode.

Examples

envGetVal("adexl.monte" "minGroupSizeSplitAcrossIdleJobs")

envSetVal("adexl.monte" "minGroupSizeSplitAcrossIdleJobs" 'int 0)

envSetVal("adexl.monte" "minGroupSizeSplitAcrossIdleJobs" 'int 5)

numberOfPointsToview

adexl.monte numberOfPointsToView int integer

Description

Specifies the number of points to be displayed in the Detail results view for the Monte Carlo Sampling run mode. By default, the Detail view shows all the points of a Monte Carlo run. By setting this variable, you can choose to view only a selected number of worst points.

When this environment variable is set to a zero, all the points are displayed in both Detail and Detail - Transpose results views. When it is set to a non-zero value, the Detail - Transpose results view is disabled for the Monte Carlo Sampling run mode.

The default value is 0.

Examples

envGetVal("adexl.monte" "numberOfPointsToView")

envSetVal("adexl.monte" "numberOfPointsToView" 'int 0)

envSetVal("adexl.monte" "numberOfPointsToView" 'int 5)

samplingMethod

adexl.monte samplingMethod string lds

Description

Sets the default sampling method for the Monte Carlo Sampling run mode. The valid values are:

random: Random.
lhs: Latin Hypercube Sampling.
lds: Low-Discrepancy Sequence.

The default value is lds.

Examples

envGetVal("adexl.monte" "samplingMethod")

envSetVal("adexl.monte" "samplingMethod" 'string "lds")

envSetVal("adexl.monte" "samplingMethod" 'string "random")

envSetVal("adexl.monte" "samplingMethod" 'string "lhs")

saveProcessOptionDefaultValue

adexl.monte saveProcessOptionDefaultValue boolean { t | nil }

Description

Controls the default setting for the Save Statistical Parameter Data check box in the Monte Carlo form.

The valid values are:

t: The Save Statistical Parameter Data check box in the Monte Carlo form is selected by default, provided that the environment variable saveMismatchOptionDefaultValue is also set to t (if the settings for this option is not already there in the setup).
nil: The Save Process Data check box in the Monte Carlo form is deselected by default (if the settings for this option is not already there in the setup).

The default value is nil.

Examples

envGetVal("adexl.monte" "saveProcessOptionDefaultValue")

envSetVal("adexl.monte" "saveProcessOptionDefaultValue" 'boolean t)

envSetVal("adexl.monte" "saveProcessOptionDefaultValue" 'boolean nil)

saveMismatchOptionDefaultValue

adexl.monte saveMismatchOptionDefaultValue boolean { t | nil }

Description

Controls the default setting for the Save Statistical Parameter Data check box in the Monte Carlo form.

The valid values are:

t: The Save Statistical Parameter Data check box in the Monte Carlo form is selected by default, provided that the environment variable saveProcessOptionDefaultValue is also set to t (if the settings for this option is not already there in the setup).
nil: The Save Process Data check box in the Monte Carlo form is deselected by default (if the settings for this option is not already there in the setup).

The default value is nil.

Examples

envGetVal("adexl.monte" "saveMismatchOptionDefaultValue")

envSetVal("adexl.monte" "saveMismatchOptionDefaultValue" 'boolean t)

envSetVal("adexl.monte" "saveMismatchOptionDefaultValue" 'boolean nil)

saveSimulationData

adexl.monte saveSimulationData boolean { t | nil }

Description

Specifies if the simulation data is to be saved so that it can be used for plotting. This environment variable sets the default value of the Save Data To Allow Family Plots check box in the Monte Carlo form.

The valid values are:

t: The Save Data To Allow Family Plots check box in the Monte Carlo form is selected by default.
nil: The Save Data To Allow Family Plots check box in the Monte Carlo form is deselected by default.

The default value is nil.

Examples

envGetVal("adexl.monte" "saveSimulationData")

envSetVal("adexl.monte" "saveSimulationData" 'boolean nil)

envSetVal("adexl.monte" "saveSimulationData" 'boolean t)

AMS

ams.emirOpts

The following table lists the environment variables in the ams.emirOpts partition. These variables work exactly same as the variables in the spectre.emirOpts partition.

ams.emirOpts environment variables	Corresponding spectre.emirOpts environment variables
autoLoadVfiFile	autoLoadVfiFile
dspfListBox	dspfListBox
editSummaryInfoTable	editSummaryInfoTable
layerName	layerName
netName	netName
short	short
shortResLayer	shortResLayer
spgsAdvIRDrop	spgsAdvIRDrop
spgsFilterMoscap	spgsFilterMoscap
techFileMode	techFileMode

ams.envOpts

amsIEsList

Specifies the default IE cards and the values of related fields to be loaded in the Interface Element (IE) Setup form when Interface Element/IE-card Based Setup is selected. Multiple IE cards can be added to the IE Card table using this variable. The same IE cards and field values are loaded in the form when you click the Reset all IE Parameters to Default Values button on the form.

To set this variable in the .cdsinit file or CIW, use the call:
envSetVal("ams.envOpts" "amsIEsList" 'string "((t \"global\" \"\" \"Value\" \"1.8\" \"connectLib.CR_full_fast\" \"\" \"logic\" \"discipline=logic;nox=1;\" \"Built-in\") (t \"inst\" \"/I3\" \"Value\" \"2.8\" \"connectLib.CR_full_fast\" \"\" \"\" \"inst=\\\"/I3\\\";\" \"Built-in\"))")

Variable Type	string
Default Value	""
Acceptable Values	List of lists that specify the following: `enableBoolean` — Boolean that specifies whether to enable or disable the IE card. `scopeString` — String that specifies the value of the Scope field. `scopeAppliedToString` — String that specifies the value of the Scope Applied To field. `vsupNetOrValueString` — String that specifies the value of the Vsup Value/Net field. `connectRuleNameString` — String that specifies the value of the connrule field. `modeString` — String that specifies the value of the mode field. `disciplineString` — String that specifies the value of the discipline field `updatedParametersString` — String the specifies the value of the Updated Parameters field.
GUI Equivalent	N/A

autoConfigNameForConfigCreation

Specifies the default configuration name to be used while creating a config cellview automatically by choosing Configuration – Auto Create Configuration from Virtuoso Schematic Editor or Virtuoso Text Editor.

To set this variable in the .cdsinit file or CIW, use the call:
envSetVal("ams.envOpts" "autoConfigNameForConfigCreation" 'string "auto_config")

To set this variable in the .cdsenv file, use the call:
ams.envOpts autoConfigNameForConfigCreation 'string "auto_config"

Variable Type	string
Default Value	`auto_config`
Acceptable Values	Any string value
GUI Equivalent	N/A

case_sensitive

Enables case sensitivity in a regenerated netlist and adds case_sensitive = true in the dspf_include statement for a Smart View.

For more information, see DSPF Support.

To set this variable in the .cdsinit file or CIW, use the call:
envSetVal("ams.envOpts" "case_sensitive" 'string "true")

To set this variable in the .cdsenv file, use the call:
ams.envOpts case_sensitive 'string "true"

Variable Type	string
Default Value	`true`
Acceptable Values	`true`, `false`
GUI Equivalent	N/A

connectRulesList

Sets the default set of connect rules. To set this variable in the .cdsinit file, use the call:

envSetVal("ams.envOpts" "connectRulesList" 'string "connectLib;ConnRules_18V_full;connect connectLib;mixedsignal;connect")

This variable will set two connect rules connectLib/ConnRules_18V_full and connectLib/mixed-signal as the default connect rules in the Connect Rules form.

To set a single connect rule, use the following call:

envSetVal("ams.envOpts" "connectRulesList" 'string "connectLib;ConnRules_5V_full;connect")

Variable Type	string
Default Value	`"connectLib;ConnRules_5V_full;connect"`

constraintListForConfigCreation

Specifies the default constraint list to be used while creating a config cellview using Virtuoso Schematic Editor or Virtuoso Text Editor. The same constraint list is used when the config cellview is created automatically. It is also displayed in the Constraint List field on the Setup Configuration form.

A constraint list specifies the constraints that apply to the design.

To set this variable in the .cdsinit file or CIW, use the call:

envSetVal("ams.envOpts" "constraintListForConfigCreation" 'string "")

To set this variable in the .cdsenv file, use the call:

ams.envOpts constraintListForConfigCreation 'string ""

Variable Type	string
Default Value	`""`
Acceptable values	A space-separated list of cellview types

defaultVsupForVAR

Changes the default value of variable defined in Supply value/Net. If the value set in the defaultVsupForVAR changes, the value of variable to be defined in the Supply value/Net field also changes accordingly.

For example, If the variable set in Supply value/Net is VAR(VDD) has its value 1.8, based on the value set for defaultVsupForVAR. If the value of defaultVsupForVAR is updated, then the value in VAR(VDD) is not affected, but the value of next variable that the user sets in Supply Value/Net is updated.

To set this variable in the .cdsinit file or CIW, use the call:
envSetVal("ams.envOpts" "defaultVsupForVAR" 'string "2.5")

Variable Type	string
Default Value	1.8
Acceptable Values	`t`

disableCompileVAAsVAMS

Controls whether the Compile VerilogA as Verilog-AMS field is displayed in the Netlist and Run Options form. If this variable is set to t, the field is hidden in the form.

To set this variable in the .cdsinit file or CIW, use the call:
envSetVal( "ams.envOpts" "disableCompileVAAsVAMS" 'boolean t)

To set this variable in the .cdsenv, use the following:
ams.envOpts disableCompileVAAsVAMS boolean t

Variable Type	boolean
Default Value	`nil`
Acceptable Values	`t`, `nil`

disableRunModeInDP

When the host mode is distributed processing, setting the value to t disables the interactive simulation mode and sets batch simulation mode as default for distributed processing. Setting the value to nil will keep both interactive and batch simulation mode active for any host mode.

To set this variable in the .cdsinit file or CIW, use the call:
envSetVal("ams.envOpts" "disableRunModeInDP" 'boolean t)

To set it in the .cdsenv file, add:
ams.envOpts disableRunModeInDP 'boolean t

Variable Type	boolean
Default Value	`nil`
Acceptable Values	`t, nil`

enableChangeSpectrePath

Enables the Change spectre path check box in the Netlist and Run Options form.

To set this variable in the .cdsinit file or CIW, use the call:
envSetVal("ams.envOpts" "enableChangeSpectrePath" 'toggle (t

To set it in the .cdsenv file, add:
ams.envOpts enableChangeSpectrePath 'toggle (t, nil)

Variable Type	boolean
Default Value	`nil`
Acceptable Values	`t, nil`
GUI Equivalent	Simulation – Netlist and Run Options – Netlist and Run Options form – Change spectre path

filesOnIrunCmdLineHDL

This variable is used to specify the files passed to AMS simulator without any options.

To set this variable in the .cdsenv file, add the line
ams.envOpts filesOnIrunCmdLineHDL string "((t \"yyy.vams\") (t \"zzz.vams\"))"

To set this variable in the .cdsinit file or CIW, use the call:
envSetVal("ams.envOpts" "filesOnIrunCmdLineHDL" 'string "((t \"yyy.vams\") (t \"zzz.vams\"))")

Variable Type	String
Default Value	""
Acceptable Values	To enable flag — String list of (t \"<file name>\") pair To disable flag — String list of (nil \"<file name>\") pair
GUI Equivalent	Simulation – Options – AMS Option – Include Option Settings

ipAddIpLabelAsPrefix

If set to t, this variable adds the specified IP Label is added as the prefix to the Virtuoso library name.

To set this variable in the .cdsinit file or CIW, use the following call:
envSetVal("ams.envOpts" "ipAddIpLabelAsPrefix" 'boolean nil)

To set this variable in the .cdsenv file, use the following call:
ams.envOpts ipAddIpLabelAsPrefix boolean nil

Variable Type	boolean
Default Value	`nil`
Acceptable Values	`t`, `nil`
GUI Equivalent	AMS IP Export – SystemVerilog Configuration File – Add IP Label to Virtuoso Library Name as Prefix

ipExportHDLFiles

If set to t, this variable copies the HDL files to the specified IP Export directory path.

To set this variable in the .cdsinit file or CIW, use the following call:
envSetVal( "ams.envOpts" "ipExportHDLFiles" 'boolean nil)

To set this variable in the .cdsenv file, use the following call:
ams.envOpts ipExportHDLFiles boolean nil

Variable Type	boolean
Default Value	`nil`
Acceptable Values	`t`, `nil`
GUI Equivalent	AMS IP Export – Miscellaneous – Export HDL Files

irunIncDirHDL

Specifies a directory to search for the 'include files.

To set this variable in the .cdsinit file or CIW, use the following call:
envSetVal( "ams.envOpts" "irunIncDirHDL" 'string "((t \"/path/include_files/\") (t \".\") )")

To set this variable in the .cdsenv file, use the following call:
ams.envOpts irunIncDirHDL string "((t \"/path/include_files/\") (t \".\") )"

Variable Type	String
Default Value	""
Acceptable Values	To enable flag — String list of (t \"<directory path>\") pair To disable flag — String list of (nil \"<directory path>\") pair
GUI Equivalent	Virtuoso Analog Design Environment – Simulation – Options – AMS Option – Include Option Settings

libDirsHDL

Specifies the path to the directory containing the library to be used by AMS simulator.

To set this variable in the .cdsinit file or CIW, use the following call:
envSetVal( "ams.envOpts" "libDirsHDL" 'string "((t \"/path/src_files\") (t )")

To set this variable in the .cdsenv file, use the following call:
ams.envOpts libDirsHDL string ""((t \"/path/src_files\") (t )"

Variable Type	String
Default Value	""
Acceptable Values	To enable flag —String list of (t \"<directory path>\") pair String list of (nil \"<directory path>\") pair
GUI Equivalent	Virtuoso Analog Design Environment – Simulation – Options – AMS Option – Include Option Settings

libFilesHDL

Specifies the name of the file in the library to be used by AMS simulator.

To set this variable in the .cdsinit file or CIW, use the following call:
envSetVal( "ams.envOpts" "libFilesHDL" 'string "((t \"module1.vams\") (nil \"/path1/module2.vams\"))")

To set this variable in the .cdsenv file, use the following call:
ams.envOpts libFilesHDL string "((t \"module1.vams\") (nil \"/path1/module2.vams\"))"

Variable Type	String
Default Value	""
Acceptable Values	To enable flag — String list of (t \"<file name>\") pair To disable flag — String list of (nil \"<file name>\") pair
GUI Equivalent	Virtuoso Analog Design Environment – Simulation – Options – AMS Option – Include Option Settings

libraryListForConfigCreation

Customizes the list of libraries in .cdsinit and SKILL programming in CIW. It sets the default global bindings when you set up a configuration or edit an existing configuration using Setup Configuration form or directly by Auto Create Configuration.

To set this variable in the .cdsinit file or CIW, use the following call:
envSetVal("ams.envOpts" "libraryListForConfigCreation" 'string "Lib1 Lib2")

Variable Type	String
Default Value	""
Acceptable Values	A single library name, example, `Lib1`. Or a space-separated list of more than one library names, example, `Lib1 Lib2`.
GUI Equivalent	Virtuoso Hierarchy Editor Editing– Global Bindings – Library List

maxNumSnapShots

Specifies the maximum number of snapshots to be saved during the specified period for the periodic snapshots.

To set this environment variable in the .cdsinit file or CIW, use the following call:
envSetVal("ams.envOpts" "maxNumSnapShots" 'int 4)

To set this environment variable in the .cdsenv file, use the following call:
ams.envOpts maxNumSnapShots int 4

Variable Type	integer
Default Value	`4`
Acceptable Values	A positive integer value.
GUI Equivalent	Simulation – Netlist and Run Options – SAVE AND RESTART OPTIONS – Periodic snapshot – Max number

optsFileHDL

Specifies the command-line arguments contained in the arguments file for AMS simulator.

To set this variable in the .cdsinit file or CIW, use the following call:
envSetVal("ams.envOpts" "optsFileHDL" 'string "((t \"opt.f\"))")

To set this variable in the .cdsenv file, use the following call:
ams.envOpts optsFileHDL 'string "((t \"opt.f\"))"

Variable Type	string
Default Value	""
Acceptable Values	To enable flag — String list of (t \"<file name>\") pair To disable flag — String list of (nil \"<file name>\") pair
GUI Equivalent	Virtuoso Analog Design Environment – Simulation – Options – AMS Option – Include Option Settings

saveAllSnapShots

Specifies whether to save all snapshots taken during the time window specified for periodic snapshots.

To set this environment variable in the .cdsinit file or CIW, use the following call:
envSetVal("ams.envOpts" "saveAllSnapShots" 'boolean nil)

To set this environment variable in the .cdsenv file, use the following call:
ams.envOpts saveAllSnapShots boolean nil

Variable Type	boolean
Default Value	`nil`
Acceptable Values	`t`, `nil`
GUI Equivalent	Simulation – Netlist and Run Options – SAVE AND RESTART OPTIONS – Periodic snapshot – Save all snapshots

snapShotBaseName

Specifies the base name of the snapshot.The base name must be alphanumeric with no spaces or special characters.

To set this environment variable in the .cdsinit file or CIW, use the following call:
envSetVal("ams.envOpts" "snapShotBaseName" 'string "mySnapShot")

To set this environment variable in the .cdsenv file, use the following call:
ams.envOpts snapShotBaseName string "mySnapShot"

Variable Type	string
Default Value	"`mySnapShot`"
Acceptable Values	An alphanumeric string with no spaces or special characters.
GUI Equivalent	Simulation – Netlist and Run Options – SAVE AND RESTART OPTIONS – Snapshot base name

snapShotNameTimeUnit

Specifies the time unit to be used in the snapshot name.

For example, if you specify the Strobe time(s) as 20n, and the Snapshot name time unit as us, a snapshot named mySnapShot_20n_us_run1 is saved.

This variable can only be used if the Save all snapshots check box is selected.

To set this environment variable in the .cdsinit file or CIW, use the following call:
envSetVal("ams.envOpts" "snapShotNameTimeUnit" 'string "us")

To set this environment variable in the .cdsenv file, use the following call:
ams.envOpts snapShotNameTimeUnit string "us"

Variable Type	string
Default Value	`us`
Acceptable Values	`ps`, `ns`, `us`, `ms`, `s`
GUI Equivalent	Simulation – Netlist and Run Options – SAVE AND RESTART OPTIONS – Snapshot time unit

snapShotSaveMode

Specifies the mode for saving the snapshots. The two modes are Time points and Periodic snapshot.

To set this environment variable in the .cdsinit file or CIW, use the following call:
envSetVal("ams.envOpts" "snapShotSaveMode" 'string "Time points")

To set this environment variable in the .cdsenv file, use the following call:
ams.envOpts snapShotSaveMode string "Time points"

Variable Type	string
Default Value	`"Time` `points"`
Acceptable Values	`Time` `point`, `Periodic` `snapshot`
GUI Equivalent	Simulation – Netlist and Run Options – SAVE AND RESTART OPTIONS – Save snapshot

spectrePath

Allows to specify a different version of Spectre when using the AMSD flex flow.

Note the following:

This environment variable can be used only if the Enable AMS flexible release matrix check box in the Netlist and Run Options form is selected and enableChangeSpectrePath is set to t.
It is recommended to use the latest version of Xcelium and Spectre while using the AMSD flex flow.

To set this environment variable in the .cdsinit file or CIW, use the following call:
envSetVal("ams.envOpts" "spectrePath" 'string "")

To set this environment variable in the .cdsenv file, use the following call:
ams.envOpts spectrePath 'string ""

Variable Type	string
Default Value	`""`
Acceptable Values	A valid path to a Spectre build.
GUI Equivalent	Simulation – Netlist and Run Options – Netlist and Run Options form – Change spectre path

stopListForConfigCreation

Specifies the default stop list to be used while creating a config cellview using Virtuoso Schematic Editor or Virtuoso Text Editor. The same stop list is used when the config cellview is created automatically. It is also displayed in the Stop List field on the Setup Configuration form.

A stop list is a list of views that are to be treated as leaf nodes, that is, not to be expanded.

To set this variable in the .cdsinit file or CIW, use the call:
envSetVal("ams.envOpts" "stopListForConfigCreation" 'string "spectre")

To set it in the .cdsenv file, add:
ams.envOpts stopListForConfigCreation 'string "spectre"

Variable Type	string
Default Value	`spectre`
Acceptable Values	A space-separated list of cellview types

strobeTime

Specifies the time interval between saving snapshots, followed by the time unit.

To set this environment variable in the .cdsinit file or CIW, use the following call:
envSetVal("ams.envOpts" "strobeTime" 'string "")

To set this environment variable in the .cdsenv file, use the following call:
ams.envOpts strobeTime string ""

Variable Type	string
Default Value	`""`
Acceptable Values	Any integer value greater than 0, followed by the time unit.
GUI Equivalent	Simulation – Netlist and Run Options – SAVE AND RESTART OPTIONS – Strobe time(s)

useIeSetup

If this variable is set to t, the Interface Element/IE-card based setup is selected for AMS simulation. By default, the Connect Rule/Connect Module based setup is selected for AMS simulation.

After setting this variable to t, when you open the Interface Element (IE) setup form, the Interface Element/IE-card Based Setup(OSS/UNL) radio button is selected and the additional options required for the Interface Element/IE-card based setup are displayed in the form. Also, when you netlist the design while the Interface Element/IE-card based setup is selected, an ie_card.scs file is placed in the netlist directory.

The ie_card.scs file contains information about how the connect rules are used during simulation.

To set this variable in the .cdsenv file, use the call: ams.envOpts useIeSetup boolean t

To set this variable in the .cdsinit file or CIW, use the call:
envSetVal("ams.envOpts" "useIeSetup" 'boolean t)

Variable Type	boolean
Default Value	`nil`
Acceptable Values	`t`, `nil`

viewListForConfigCreation

Specifies the default view list to be used while creating a config cellview using Virtuoso Schematic Editor or Virtuoso Text Editor. The same view list is used when the config cellview is created automatically. It is also displayed in the View List field on the Setup Configuration form.

A view list specifies the views to be added in your configuration. It applies to every level of the configuration and determines which view is selected for each object in the design, unless overridden by a cell or instance binding. You can use the asterisk character (*) as a wildcard in the view list.

To set this variable in the .cdsinit file or CIW, use the call:
envSetVal("ams.envOpts" "viewListForConfigCreation" 'string "spectre spice pspice verilog verilogams behavioral functional systemVerilog schematic veriloga vhdl vhdlams wreal")

To set it in the .cdsenv file, add:
ams.envOpts viewListForConfigCreation 'string "spectre spice pspice verilog verilogams behavioral functional systemVerilog schematic veriloga vhdl vhdlams wreal"

Variable Type	string
Default Value	`spectre spice pspice verilog verilogams behavioral functional systemVerilog schematic veriloga vhdl vhdlams wreal`
Acceptable Values	A space-separated list of cellview types

switchViewList

Specifies the default view list. It is a list of the views for ADE to switch when searching for design variables and when netlisting. The same view list is displayed in the Switch View List field on the Environment Options form.

To set this variable in the .cdsinit file or CIW, use the call:
envSetVal("spectre.envOpts" "switchViewList" 'string "schematic spectre")

To set this variable in the .cdsenv file, use the call:
spectre.envOpts switchViewList 'string "schematic spectre"

Variable Type	string
Default Value	`spectre cmos_sch cmos.sch schematic veriloga`
Acceptable Values	View names, separated by spaces.
GUI Equivalent	Virtuoso Analog Design Environment – Environment Options – Switch View List.

enableAMSdebug

Selects or deselects the Enable mixed signal debugger check box in the Netlist and Run Options form. This launches the SimVision debug environment for AMS simulator.

To set this variable in the .cdsinit file or CIW, use the call:
envSetVal("ams.envOpts" "enableAMSdebug" 'toggle (nil))

To set this variable in the .cdsenv file, use the call:
ams.envOpts enableAMSdebug toggle (nil)

Variable Type	Boolean
Default Value	`(nil)`
Acceptable Values	`(t`, `nil)`
GUI Equivalent	Simulation – Netlist and Run Options form – Enable mixed signal debugger

ipPreserveEnvVars

Selects or deselects the Preserve Env Variables check box in the AMS IP Export form.

To set this variable in the .cdsinit file or CIW, use the call:
envSetVal("ams.envOpts" "ipPreserveEnvVars" 'boolean nil)

To set this variable in the .cdsenv file, use the call:
ams.envOpts ipPreserveEnvVars boolean nil

Variable Type	boolean
Default Value	`nil`
Acceptable Values	`t`, `nil`
GUI Equivalent	AMS IP Export form – Miscellaneous Tab –Preserve Env Variables

ipEnableDutCell

Selects or deselects the Enable Export DUT Cell As Top check box in the AMS IP Export form.

To set this variable in the .cdsinit file or CIW, use the call:
envSetVal("ams.envOpts" "ipEnableDutCell" 'boolean nil)

To set this variable in the .cdsenv file, use the call:
ams.envOpts ipEnableDutCell boolean nil

Variable Type	boolean
Default Value	`nil`
Acceptable Values	`t`, `nil`
GUI Equivalent	AMS IP Export form – Miscellaneous Tab –Enable Export DUT Cell As Top

ipDutCell

Specifies the DUT cell name in the DUT Configuration group box in the Miscellaneous tab of the AMS IP Export form.

To set this variable in the .cdsinit file or CIW, use the call:
envSetVal("ams.envOpts" "ipDutCell" 'string " ")

To set this variable in the .cdsenv file, use the call:
ams.envOpts ipEnableDutCell string " "

Variable Type	string
Default Value	`""`
Acceptable Values	Name of the cell from where you want to export the IP block.
GUI Equivalent	AMS IP Export form – Miscellaneous Tab –DUT Configuration – Cell

ipDutLib

Specifies the DUT library name in the DUT Configuration group box in the Miscellaneous tab of the AMS IP Export form.

To set this variable in the .cdsinit file or CIW, use the call:
envSetVal("ams.envOpts" "ipDutLib" 'string " ")

To set this variable in the .cdsenv file, use the call:
ams.envOpts ipDutLib string " "

Variable Type	string
Default Value	`""`
Acceptable Values	Name of the library from where you want to export the IP block.
GUI Equivalent	AMS IP Export form – Miscellaneous Tab –DUT Configuration – Library

ipDutView

Specifies the DUT library name in the DUT Configuration group box in the Miscellaneous tab of the AMS IP Export form.

To set this variable in the .cdsinit file or CIW, use the call:
envSetVal("ams.envOpts" "ipDutView" 'string " ")

To set this variable in the .cdsenv file, use the call:
ams.envOpts ipDutView string " "

Variable Type	string
Default Value	`""`
Acceptable Values	Name of the view from where you want to export the IP block.
GUI Equivalent	AMS IP Export form – Miscellaneous Tab –DUT Configuration – View

ieUseUcmAsDefault

ams.envOpts ieUseUcmAsDefault boolean { t| nil}

Description

Selects or deselects the Use UCM as Default check box in the Interface Element (IE) Setup form. This check box specifies that by default, any new IE card must be created by using the Universal Connect Module (UCM).

The default value is nil.

GUI Equivalent

Command	Setup – Connect Rules/IE Setup– Interface Element (IE) Setup
Field	Use UCM as Default

Examples

envGetVal("ams.envOpts" "ieUseUcmAsDefault")

envSetVal("ams.envOpts" "ieUseUcmAsDefault" 'boolean t)

ams.netlisterOpts

unlAnalogOnly

ams.netlisterOpts unlAnalogOnly string { Pure Analog Cellviews| Extracted Views| ""}

Description

Specifies the value for the option Netlist using Spectre in the Netlister tab of the AMS Options form.

"": Disables netlisting using Spectre.
This is the default.
Pure Analog Cellviews: Enables Spectre netlisting for pure analog cellviews.
Extracted Views: Enables Spectre netlisting for extracted views.

GUI Equivalent

Command	Simulation – Options – AMS Simulator
Field	Netlist using Spectre

Examples

envGetVal("ams.netlisterOpts" "unlAnalogOnly")

envSetVal("ams.netlisterOpts" "unlAnalogOnly" 'string "Pure Analog Cellviews")

asimenv

ignoreUnsetDesVars

Ignores the design variables with undefined values, while running a simulation and disables the warning message.

To set this variable in the .cdsinit file or CIW, use the call:
envSetVal("asimenv" "ignoreUnsetDesVars" 'boolean nil))

To set this variable in the .cdsenv file, use the call:
asimenv enableAMSdebug boolean nil

Variable Type	Boolean
Default Value	`nil`
Acceptable Values	`t`, `nil`

asimenv.monte

highPrecision

Controls the numerical precision of the results in the Results Display Window. This window gets displayed on using the forms, Correlation Table and Plot/Print Versus Iteration.

By default, the results displayed are accurate up to 4 decimal places.

If set to t, the results displayed are accurate up to 6 decimal places.

To set this variable in the .cdsinit file or CIW, use the call:
envSetVal("asimenv.monte" "highPrecision" 'boolean nil)

To set it in the .cdsenv file, add:
asimenv.monte highPrecision 'boolean nil

Variable Type	Boolean
Default Value	`nil`
Acceptable Values	`t` –The results displayed are accurate up to 6 decimal places. `nil` – The results displayed are accurate up to 4 decimal places.

precisionDigits

Overrides the numerical accuracy specified through the variable highPrecision.

To set this variable in the .cdsinit file or CIW, use the call:
envSetVal("asimenv.monte" "precisionDigits" 'int 0)

To set it in the .cdsenv file, add:
asimenv.monte precisionDigits int 0

Variable Type	Integer
Default Value	`0`
Acceptable Values	A positive integer value.

asimenv.netlist

issueInfoMsgOnCellRename

asimenv.netlist issueInfoMsgOnCellRename boolean { t | nil }

Description

Prints information messages when a subcircuit is renamed due to a conflict.

For example, if the same instance comes from two different libraries in one schematic view, the subcircuit is renamed and an information message is displayed.

The default is nil.

GUI Equivalent

None

Examples

envGetVal("asimenv.netlist" "issueInfoMsgOnCellRename")

envSetVal("asimenv.netlist" "issueInfoMsgOnCellRename" 'boolean t)

auCore.misc

doExactTermMatch

auCore.misc doExactTermMatch boolean { t | nil }

Description

Specifies whether the tool compares the terminal order in the cellview with the terminal order in CDF during check and save. By default, this variable is set to nil and ADE Explorer or ADE Assembler ignore the order of terminals. This lets you ignore terminal order mismatches caused by the the format in which terminals are saved.

GUI Equivalent

None

Examples

envGetVal("auCore.misc" "doExactTermMatch")

envSetVal("auCore.misc" "doExactTermMatch" 'boolean t)

auCore.selection

alwaysFlattenNames

auCore.selection alwaysFlattenNames boolean { t | nil }

Description

Specifies whether to display or hide the Include as bundle check box on the Select bits from bus form.

The default value is nil.

GUI Equivalent

The Include as bundle check box in the Select bits from bus form.

Examples

envGetVal("auCore.selection" "alwaysFlattenNames")

envSetVal("auCore.selection" "alwaysFlattenNames" 'boolean t)

HspiceD

license

maestro.cpupdtr

keepHistoryData

Specifies whether or not to copy the history of a maestro view while copying the tests in the view.

If you do not wish to copy the simulation results, it is recommended to also set the variable, copyResultsData in your .cdsenv file and set its value to nil.

The keepHistoryData variable is used by both Virtuoso and a supporting utility. Therefore, it is recommended to set it in the ~/.cdsenv file that is read by both. If you set this variable in the <current-working-directory>/.cdsenv file, you must also set the CDS_LOAD_ENV variable in the UNIX environment to CSF. The variable is not used when specified in the .cdsinit file.

To set this variable in .cdsenv:

maestro.cpupdtr keepHistoryData boolean t

Variable Type	boolean
Default Value	t
Acceptable Values	t, nil

maestro.distribute

spectreMTNumberUsed

Specifies the value of the +mt option for Spectre APS when on the High-Performance Simulation Options form, the Manual multi-threading mode option is selected for APS Spectre simulation performance.

To set this variable in the .cdsenv:

maestro.distribute spectreMTNumberUsed cyclic "Estimated"

In .cdsinit or the CIW:

envSetVal( "maestro.distribute" "spectreMTNumberUsed" 'cyclic "Estimated")

Variable Type	cyclic
Default Value	`Estimated`
Acceptable Values	`"Specified"`: `+mt` is set to the value of the #Threads field on the High-Performance Simulation Options form. `"Estimated":` If the resource estimation for the current job policy is enabled, `+mt` is set to the thread count estimated for the job policy. Otherwise, `+mt` is set to the value of the #Threads field. You can enable resource estimation for the current job policy by using the options given in the Provide CPU and Memory Data group box on the Resources tab of the Job Policy Setup form. `"Automatic"`: If the resource estimation for the current job policy is enabled, compares the thread count estimated for the current job policy with value of the #Threads field, and uses the smaller value. Otherwise, `+mt` is set to the value of the #Threads field.

maestro.emir

showEnableRFReferenceFlowUI

maestro.emir showEnableRFReferenceFlowUI boolean {t | nil}

Description

Selects the Enable RF Reference Flow check box in the Basic tab of the EMIR Analysis Setup form that enables the RF reference flow. This lets you add passive devices for electromigration analysis like inductors or transformers.

The default value is nil.

GUI Equivalent

Command:	Setup – EMIR Analysis
Field:	Enable RF Reference Flow

Examples

envGetVal("maestro.emir" "showEnableRFReferenceFlowUI")

envSetVal("maestro.emir" "showEnableRFReferenceFlowUI" 'boolean t)

maestro.explorer

defaultOutputColumns

Specifies the default list of columns to be shown on the Outputs Setup tab in ADE Explorer.

To set this variable in the .cdsenv:

maestro.explorer defaultOutputColumns 'string "\"Name\" \"Type\" \"Details\" \"Value\" \"Plot\" \"Save\" \"Spec\"

In .cdsinit or the CIW:

envSetVal( "maestro.explorer" "defaultOutputColumns" 'string "\"Name\" \"Type\" \"Details\" \"Value\" \"Plot\" \"Save\" \"Spec\"")

Variable Type	string
Default Value	"\"Name\" \"Type\" \"Details\" \"Value\" \"Plot\" \"Save\" \"Spec\""
Acceptable Values	Valid column names, including user-defined column names

displayImplicitSignals

Controls whether to show or hide the implicit signals in ADE Explorer. While creating expressions in the Details field, if it uses a signal or net that does not already exist in the outputs table, a new row for an output of type Implicit is added to the table. For example, when you create an output expression, average("/net06")), an implicit output is created for signal /net06.

By default, implicit signals are not shown in the outputs table.

To set this variable in .cdsinit or CIW:

envSetVal("maestro.explorer" "displayImplicitSignals" 'boolean nil)

Variable Type	boolean
Default Value	`nil`
Acceptable Values	`t` — Displays implicit signals in ADE Explorer `nil` — Hides implicit signals in ADE Explorer
GUI Equivalent	Results — Implicit Signals

outputSetupFilteringNumOutputThreshold

Sets the minimum limit after which filters start appearing on the columns in the Output Setup pane in ADE Explorer. When you set the value of this variable to 0, filters will always appear regardless of the number of output rows. On the other hand, if you set the value to a large number, say 99999, filters will never appear.

You can use these filters to search and filter results based on the specified text. For more information about how to perform filtering in Outputs Setup pane, see Filtering and Searching in Outputs Setup Pane.

To set this variable in the .cdsinit file or CIW:

envSetVal("maestro.explorer" "outputSetupFilteringNumOutputThreshold" 'int 20)

Variable Type	integer
Default Value	20
Acceptable Values	from 0 to 99999

retainNetlistDirForSinglePoint

Determines whether the netlist directory is to be retained when the next simulation is a single-point run. When this variable is set to t (default value), the netlist directory is retained for the next simulation run. If set to nil, the netlist directory is deleted before the next simulation run starts.

To set this variable in the .cdsinit file or CIW:

envSetVal("maestro.explorer" "retainNetlistDirForSinglePoint" 'boolean t)

Variable Type	boolean
Default Value	t
Acceptable Values	t, nil

showSaveBySubcktAssistant

Controls the display of Save By Subckt Instances assistant in ADE Explorer. The default value of this variable is auto, which means this assistant is displayed only when the saved subcircuit information is available. When set to always, the Save By Subckt Instances assistant is always displayed in ADE Explorer and schematic. When set to never, this assistant is not displayed.

However, if you open Save By Subckt Instances assistant using the Outputs – To Be Saved – Select By Subckt Inst menu, it always appears regardless of the setting of this variable.

To set this variable in the .cdsinit file or CIW:

envSetVal("maestro.explorer" "showSaveBySubcktAssistant" ’cyclic "auto")

Variable Type	string
Default Value	auto
Acceptable Values	auto, never, always

showWhatsNewWindow

Controls whether the What's New window should be displayed when ADE Explorer is opened for the first time. This window highlights the new features in ADE Explorer and is displayed only in those releases that include significant new features. If a release does not include a new feature, the What’s New window is not displayed regardless of the setting of this environment variable. In addition, the value of this environment variable is always in synchronization with the Do not show this again check box on the What’s New window.

For example, suppose you are using the IC6.1.7ISR3 or ICADV12.2ISR3 release and this window is enabled for these releases. Now, if you select the Do not show this again check box, this window will not appear next time when you open ADE Explorer in these releases. Also, the value of variable is automatically set to the specific release number. In this example, it is set to IC6.1.7-64b.500.3 or ICADV12.2-64b.500.3. Alternatively, to stop displaying the What’s New window for a specific release, instead of clicking the Do not show this again check box, you can also manually set the value of this variable to the specific release number.

Now, if you move to IC6.1.7ISR4 or ICADV12.2ISR4,

If the What’s New window is enabled, the value of this variable and the Do not show this again check box are reset, and the What’s New Window is always displayed to highlight the new features.
If the What’s New window is not enabled, it will not be displayed.

To set this variable in the .cdsinit file or CIW:

envSetVal("maestro.explorer" "showWhatsNewWindow" 'string "yes")

Variable Type	string
Default Value	yes
Acceptable Values	any string value indicating a release number

maestro.gui

confirmBeforeTestOrCornerDelete

Controls the display of the confirmation message that appears when you delete a test or a corner in the Setup assistant of ADE Explorer or in the Data View assistant of ADE Assembler. When this variable is set to t, the confirmation message appears every time you delete a test or a corner. When this variable is set to nil, which is the default value, the confirmation message will be disabled for the current Virtuoso session.

To set this variable in the .cdsinit file or CIW:

envSetVal("maestro.gui" "confirmBeforeTestOrCornerDelete" 'boolean nil)

Variable Type	boolean
Default Value	nil
Acceptable Values	t, nil

nameDisplayWidthInDataView

Controls the width of the divider bar that appears on top of the Data View and Setup assistants. You can drag this bar to resize the width of the Name and Value columns.

This variable can be set to the following values:

Fixed—Divider bar is fixed. You cannot drag the bar to resize the column width.
FitToColumn—Column width is automatically adjusted according to the length of the names or values in the columns.
Interactive—Divider bar is moveable. You can drag the bar to change the column width.
UseVariableNameWidth—At first, the column width is automatically adjusted according to the length of the names or values in the columns. Later, you can drag the bar to change the column width. For example, if a new variable is added and it is longer than the longest column name, then the slider will have to be manually adjusted to see the new column name.

To set this variable in the .cdsinit file or CIW:

envSetVal("maestro.gui" "nameDisplayWidthInDataView" 'cyclic "Interactive")

Variable Type	cyclic
Default Value	Interactive
Acceptable Values	Fixed, FitToColumn, Interactive, UseVariableNameWidth

resultsFilteringColumnsList

Specifies the threshold number of rows after which the column filters are displayed on the Results tab of ADE Explorer and ADE Assembler. By default, the variable is set to 0. Therefore, the column filters are always displayed. Set this variable to a larger number to hide the filters for a small number of rows.

In .cdsenv:

maestro.gui resultsFilteringColumnsList int 0

In .cdsinit or the CIW:

envSetVal( "maestro.gui" "resultsFilteringColumnsList" 'int 0)

Valid Values

Positive integer value

The threshold number of rows after which column filters are displayed.

Default Value

showFilterInDataView

Determines whether to display filters on top of the Name and Value columns in the Setup assistant. When this variable is set to t, which is the default value, the filters are shown. When set to nil, the filters are hidden. You can use these filters to filter the column contents of the Setup assistant.

The setting of this variable is applicable only when ADE Explorer is opened for the first time. You can also change this setting by right-clicking the column header in the Setup assistant and choosing Show Filters or Hide Filters. When you change the setting using user interface, it will always be considered for the given session regardless of the setting of this variable.

To set this variable in the .cdsinit file or CIW:

envSetVal("maestro.gui" "showFilterInDataView" 'boolean "t")

Variable Type	boolean
Default Value	t
Acceptable Values	t, nil

useExpressionBuilder

Determines whether to use the Expression Builder or the Calculator window to create output expressions in the ADE Outputs Setup pane. When this variable is set to t, the Expression Builder opens up when you create expressions. When it is set to nil, the Calculator window appears that you can use to build expressions.

To set this variable in the .cdsinit file or CIW:

envSetVal("maestro.gui" "useExpressionBuilder" ’boolean nil)

Variable Type	boolean
Default Value	t
Acceptable Values	t, nil

usePlottingTemplate

Controls the display of the Plotting Template drop-down list in ADE Explorer and ADE Assembler.

To set this variable in the .cdsinit file or CIW:

envSetVal("maestro.gui" "usePlottingTemplate" 'boolean t)

Variable Type	boolean
Default Value	`t`
Acceptable Values	`t`, `nil`

yieldViewMaxOutputsShowExpanded

Specifies the threshold value for the number of output rows that can be displayed in expanded form in the Yield results view. If the output rows exceed this threshold, the results are displayed in collapsed form.

To set this variable in the .cdsinit file or CIW:

envSetVal( "maestro.gui" "yieldViewMaxOutputsShowExpanded" 'int 20)

Variable Type	integer
Default Value	20
Acceptable Values	A positive integer

saveImplicitSignalsDuringRun

Ensures that the implicit signals are added to the save statement in the netlist during the simulation run in the following scenarios:

The output expressions, containing implicit signals, were created using ADE Explorer or Assembler (IC6.1.8 ISR5 version or below). Simulation is not run using these expressions.
The Select signals to output (save) option on the Save options form is set to selected or allpub during the creation of an output expression.

To set this variable in .cdsinit or CIW:

envSetVal("maestro.gui" "saveImplicitSignalsDuringRun" 'boolean nil)

Variable Type	boolean
Default Value	nil
Acceptable Values	`t` — Saves implicit signals while running a simulation `nil` — Does not save implicit signals while running a simulation
GUI Equivalent	N/A

hideShowMultiProcess

Controls whether to show or hide the option, Multi-processing, in the General section of High-Performance Simulation Options form, when Simulation performance mode is set to Spectre X.

To set this variable in .cdsinit or CIW:

envSetVal("maestro.gui" "hideShowMultiProcess" 'boolean t)

Variable Type	boolean
Default Value	`nil`
Acceptable Values	`t` — Hides the option Multi-processing in the General section of High-Performance Simulation Options form `nil` — Displays the option Multi-processing in the General section of High-Performance Simulation Options form
GUI Equivalent	High Performance Simulation Options — Multi-Processing

showUnitsInResults

Controls whether to hide or show units, such as Hz or dB,in the measured results for the expressions in the Results tab.

To set this variable in the .cdsenv:

maestro.gui showUnitsInResults boolean t

In .cdsinit:

envSetVal("maestro.gui" "showUnitsInResults" 'boolean t)

Variable Type	boolean
Default Value	`t`
Acceptable Values	`t` — Displays the unit values in the Results tab `nil` — Hides the unit in the Results tab
GUI Equivalent	Right-click menu in the Results column header

textColorForSpecFailInResults

Specifies a text color, color name, or a color value in hexadecimal format, to be used for the Pass/Fail, Min, and Max columns for the result values that fail to meet the specification.

To set this variable in .cdsinit or CIW:

maestro.gui textColorForSpecFailInResults "colorName_or_hexadecimalValue"

Variable Type	string
Default Value	"`#ff0000`"
Acceptable Values	Color name or hexadecimal value
GUI Equivalent	N/A

Example

envSetVal("maestro.gui" "textColorForSpecFailInResults" 'string "maroon")

Sets the color to be used for values that fail the spec results to maroon, as shown below.

Note that in this example, the Max value for output UGF was meeting the spec. Therefore, only the pass/fail status and the Min value are in the color specified by this env var.

textColorForSpecNearInResults

Specifies a text color, color name, or a color value in hexadecimal format, to be used for the Pass/Fail, Min, and Max columns for the result values that are near the specification.

To set this variable in .cdsinit or CIW:

maestro.gui textColorForSpecNearInResults "colorName_or_hexadecimalValue"

Variable Type	string
Default Value	"`#D2691E`"
Acceptable Values	Color name or hexadecimal value
GUI Equivalent	N/A

Example

envSetVal("maestro.gui" "textColorForSpecNearInResults" 'string "#AC00CA")

Sets the color to be used for values that are near the specification to purple, as shown below.

textColorForSpecPassInResults

Specifies a text color, color name or a color value in hexadecimal format, to be used for the Pass/Fail, Min, and Max columns for the result values that meet the specification.

To set this variable in .cdsinit or CIW:

maestro.gui textColorForSpecPassInResults "colorName_or_hexadecimalValue"

Variable Type	string
Default Value	"`#008000`"
Acceptable Values	Color name or hexadecimal value

Example

envSetVal("maestro.gui" "textColorForSpecPassInResults" 'string "#00ACAC")

Sets the color to be used for values that pass the spec results to light blue, as shown below.

showNativeRelxpertSwitch

Enables you to switch between the Spectre Native and RelXpert modes.

When this environment variable is set to t, a drop-down list is displayed on the Reliability Analysis Editor form, as shown in the following figure.

Using this drop-down list, you can choose one of the following simulator modes:

Native (Spectre Native)
RelXpert

To set this variable in the .cdsenv:

maestro.gui showNativeRelxpertSwitch boolean nil

In .cdsinit:

envSetVal("maestro.gui" "showNativeRelxpertSwitch" 'boolean nil)

Variable Type	boolean
Default Value	`nil`
Acceptable Values	`t` — Enables you to switch between the Spectre Native and RelXpert simulator modes using a drop-down list in the Reliability Analysis Editor form. `nil` — The drop-down list to switch between the simulator modes is not displayed in the Reliability Analysis Editor form.

showRedundantPointsinDT

Displays the redundant data points in the Detail-Transpose results view.

To set this variable in the .cdsenv:

maestro.gui showRedundantPointsinDT boolean nil

In .cdsinit:

envSetVal("maestro.gui" "showRedundantPointsinDT" 'boolean nil)

Variable Type	boolean
Default Value	`nil`
Acceptable Values	`t`, `nil`

defaultParametersAllowList

Modifies the list of parameters to be displayed in the Parameters tab of the Variables and Parameters assistant.

To set this variable in the .cdsenv:

maestro.gui defaultParametersAllowList string "C c cap* finger* fw L l length M m nFin nf nfin numFinger* R r res* simM W Wfg w wf width"

In .cdsinit:

envSetVal("maestro.gui" "defaultParametersAllowList" 'string "C c cap* finger* fw L l length M m nFin nf nfin numFinger* R r res* simM W Wfg w wf width")

Variable Type	string
Default Value	`"C c cap* finger* fw L l length M m nFin nf nfin numFinger* R r res* simM W Wfg w wf width"`
Acceptable Values	The list of parameters to be displayed in the Parameters tab of the Variables and Parameters assistant.

defaultParametersAssistantFilter

Specifies the default filter to be set for device instance parameters in the Parameters tab of the Variables and Parameters assistant.

To set this variable in the .cdsenv:

maestro.gui defaultParametersAssistantFilter string "Allow List"

In .cdsinit:

envSetVal("maestro.gui" "defaultParametersAssistantFilter" 'string "Allow List")

Variable Type	string
Default Value	`"Allow` `List"`
Acceptable Values	The default filter to be set for device instance parameters in the Parameters tab of the Variables and Parameters assistant`.`

enableGroupByTagsForVars

Selects the Group By Tags option in the context menu for the section Design Variables or Global Variables in the Data View assistant. It then groups the variables in both the sections according to the assigned tags, creating sub-trees named tag:tagname.

Variables that do not have any assigned tags are displayed in a sub-tree named Tag:untagged.

To set this variable in the .cdsenv:

maestro.gui enableGroupByTagsForVars boolean nil

In .cdsinit:

envSetVal("maestro.gui" "enableGroupByTagsForVars" 'boolean nil)

Variable Type	Boolean
Default Value	`nil`
Acceptable Values	`t`, `nil`

enableGroupByTagsForCorners

maestro.gui enableGroupByTagsForCorners boolean { t | nil }

Description

Selects the Group By Tags option in the context menu for the Corners section in the Data View assistant. It then groups the corners according to the assigned tags, creating sub-trees named Tag:tagname.

Corners that do not have any assigned tags are displayed in a sub-tree named Tag:untagged.

The default value is nil.

GUI Equivalent

Command:	Data View Assistant – Corners
Field:	Group By Tags

Examples

envGetVal("maestro.gui" "enableGroupByTagsForCorners")

envSetVal("maestro.gui" "enableGroupByTagsForCorners" 'boolean t)

disableInfoAnalysisOutputWhenUIDisabled

maestro.gui disableInfoAnalysisOutputWhenUIDisabled boolean { t | nil }

Description

Controls whether the following circuit information analyses should be saved or not when the corresponding check boxes are disabled in the Save Circuit Information Analysis table of the Save options form.

primitives
subckts
asserts

The default value is nil.

GUI Equivalent

Command:	Save Options – Save Circuit Information Analysis
Field:	Enabled check box corresponding to the information analyses, primitives, subckts, and asserts

Examples

envGetVal("maestro.gui" "disableInfoAnalysisOutputWhenUIDisabled")

envSetVal("maestro.gui" "disableInfoAnalysisOutputWhenUIDisabled" 'boolean t)

disableHighPerformanceSimulationEnableMS

maestro.gui disableHighPerformanceSimulationEnableMS boolean { t | nil }

Description

Controls the availability of the Enable MS check box in the High-Performance Simulation Options form, which lets you use the mixed-signal options during simulation when the simulation performance mode is set to APS or Spectre X

t means that the Enable MS check box is grayed out.
nil lets you select or deselect the Enable MS check box. This is the default.

GUI Equivalent

None

Examples

envGetVal("maestro.gui" "disableHighPerformanceSimulationEnableMS")

envSetVal("maestro.gui" "disableHighPerformanceSimulationEnableMS" 'boolean t)

hideStringResultsFailures

maestro.gui hideStringResultsFailures boolean { t | nil }

Description

Controls the coloring of results that have specifications written as string values. When specifications are written in string format, result values cannot be compared to get the pass, fail, or near status. Set this variable to t to avoid coloring of such results.

Default value is nil.

GUI Equivalent

None

Examples

envGetVal("maestro.gui" "hideStringResultsFailures")

envSetVal("maestro.gui" "hideStringResultsFailures" 'boolean t)

defaultParametersAllowList

maestro.gui defaultParametersAllowList string { t | nil }

Description

Default value is nil.

GUI Equivalent

None

Examples

envGetVal("maestro.gui" "hideStringResultsFailures")

envSetVal("maestro.gui" "hideStringResultsFailures" 'boolean t)

showRemoveTmpADEDirButton

maestro.gui showRemoveTmpADEDirButton boolean { t | nil }

Description

Displays or hides the Remove .tmpADEDir button from the Output Setup toolbar in ADE Explorer and Tools toolbar in ADE Assembler.

The default value is t.

GUI Equivalent

None

Examples

envGetVal("maestro.gui" "showRemoveTmpADEDirButton")

envSetVal("maestro.gui" "showRemoveTmpADEDirButton" 'boolean nil)

showMSOptionsInSpectreXTab

maestro.gui showMSOptionsInSpectreXTab boolean { t | nil }

Description

Displays or hides the MS Options group box in the High-Performance Simulation Options form for Spectre X.

The default value is nil.

GUI Equivalent

None

Examples

envGetVal("maestro.gui" "showMSOptionsInSpectreXTab")

envSetVal("maestro.gui" "showMSOptionsInSpectreXTab" 'boolean t)

deleteUnusedProbes

maestro.gui deleteUnusedProbes boolean { t | nil }

Description

Removes the differentiating colour or the highlights when the previously selected nets in the schematic are reselected.

The default value is nil.

GUI Equivalent

None

Examples

envGetVal("maestro.gui" "deleteUnusedProbes")

envSetVal("maestro.gui" "deleteUnusedProbes" 'boolean t)

disableHighPerformanceSimulationSpectreXOption

maestro.gui disableHighPerformanceSimulationSpectreXOption boolean { t | nil }

Description

Removes Spectre X from the simulation performance mode options in the High-Performance Simulation Options form and selects the APS option.

The variable is effective only when you set it in .cdsinit.

The default value is nil.

GUI Equivalent

None

Examples

envGetVal("maestro.gui" "disableHighPerformanceSimulationSpectreXOption")

envSetVal("maestro.gui" "disableHighPerformanceSimulationSpectreXOption" 'boolean t)

donotExpandNameForparam_file

maestro.gui donotExpandNameForparam_file boolean { t | nil }

Description

Indicates whether relative path to the dynamic parameter file, which is specified in the Choosing Analyses form for transient analysis, must be resolved to its absolute path..

The default value is t.

GUI Equivalent

None

Examples

envGetVal("maestro.gui" "donotExpandNameForparam_file")

envSetVal("maestro.gui" "donotExpandNameForparam_file" 'boolean nil)

showNoiseSummaryinTableWidget

maestro.gui showNoiseSummaryinTableWidget boolean { t | nil }

Description

Specifies whether to enable or disable the Noise Summary window that displays the noise summary report in a tabulated format.

The default value is nil.

GUI Equivalent

None

Examples

envGetVal("maestro.gui" "showNoiseSummaryinTableWidget")

envSetVal("maestro.gui" "showNoiseSummaryinTableWidget" 'boolean nil)

maestro.license

checkoutOrder

Controls the license checkout order to be followed for ADE Explorer and ADE Assembler. This variable has the following valid values:

Explorer_Assembler (default): When set, the ADE Explorer license is searched first. If it is not available, then Assembler license is searched and used.
Assembler_Explorer: When set, the ADE Assembler license is searched first. If it is not available, then ADE Explorer license is searched and used.
Explorer: When set, only ADE Explorer license is searched and used.
Assembler: When set, only ADE Assembler license is searched and used

To set this variable in the .cdsinit file or CIW:

envSetVal("maestro.license" "checkoutOrder" 'cyclic "Explorer_Assembler")

Variable Type	cyclic
Default Value	`Explorer_Assembler`
Acceptable Values	`Explorer_Assembler`, `Assembler_Explorer`, `Explorer`, `Assembler`

maestro.mpt

createNewStrips

Controls whether to plot new leaves for signals in new strips.

To set this variable in the .cdsenv:

maestro.mpt createNewStrips boolean nil

In .cdsinit:

envSetVal("maestro.mpt" "createNewStrips" 'boolean nil)

Variable Type	Boolean
Default Value	`nil`
Acceptable Values	`t` — New leaves for signals are plotted in separate strips. `nil` — All leaves for the signals are plotted in a single strip.

exactMatchOnly

Controls whether to plot only matching leaves using plotting template.

To set this variable in the .cdsenv:

maestro.mpt exactMatchOnly boolean nil

In .cdsinit:

envSetVal("maestro.mpt" "exactMatchOnly" 'boolean nil)

Variable Type	Boolean
Default Value	`nil`
Acceptable Values	`t` — Only matching leaves of the signal are plotted using plotting templates. `nil` — All leaves for the signals are plotted using plotting templates.

useColorBank

Controls whether to plot signals using default color bank.

To set this variable in the .cdsenv:

maestro.mpt useColorBank boolean nil

In .cdsinit:

envSetVal("maestro.mpt" "useColorBank" 'boolean nil)

Variable Type	Boolean
Default Value	`nil`
Acceptable Values	`t` — Signals are plotted using default color bank. `nil` — All signals are plotted using the signal color in the saved plotting template.

maestro.plotting

showViVAGraphLaunchTip

Displays the tip providing information that you can open ViVA XL graph as an assistant or as a standalone window. This tip appears when the ViVA XL graph is opened as an assistant for the first time. Set this variable to nil to hide this tip.

To set this variable in the .cdsinit file or CIW:

envSetVal("maestro.plotting" "showViVAGraphLaunchTip" ’boolean t)

Variable Type	boolean
Default Value	t
Acceptable Values	t, nil

distributedPlotEnabled

maestro.plotting distributedPlotEnabled boolean {t | nil}

Description

Specifies whether to enable distributed plot by default. The default value is nil, which indicates that distributed plot is disabled by default.

GUI Equivalent

None

Examples

envGetVal("maestro.plotting" "distributedPlotEnabled")

envSetVal("maestro.plotting" "distributedPlotEnabled" 'boolean t)

distributedPlotEnableCIW

maestro.plotting distributedPlotEnableCIW boolean {t | nil}

Description

Specifies whether to enable CIW for distributed plot. The default value is nil, which indicates that CIW for distributed plot is disabled by default.

GUI Equivalent

None

Examples

envGetVal("maestro.plotting" "distributedPlotEnableCIW")

envSetVal("maestro.plotting" "distributedPlotEnableCIW" 'boolean t)

distributedPlotJobPolicy

maestro.plotting distributedPlotJobPolicy string jobPolicyName

Description

Specifies the default job policy for distributed plot. The default value is "", which indicates that Virtuoso uses the job policy that is previously used in the setup.

If the user creates a new maestro view, the default job policy is the local machine.

GUI Equivalent

None

Examples

envGetVal("maestro.plotting" "distributedPlotJobPolicy")

envSetVal("maestro.plotting" "distributedPlotJobPolicy" 'string "LSCS")

distributedPlotLoadCdsInit

maestro.plotting distributedPlotLoadCdsInit boolean {t | nil}

Description

Specifies whether to load the .cdsinit file before launching the distributed plot. In addition to the .cdsinit file, the distributed plot process also tries to load the .distributedPlotInit file. The default value is nil, which indicates that the .cdsinit file is not loaded before launching the distributed plot.

GUI Equivalent

None

Examples

envGetVal("maestro.plotting" "distributedPlotLoadCdsInit")

envSetVal("maestro.plotting" "distributedPlotLoadCdsInit" 'boolean t)

distributedPlotLingerTime

maestro.plotting distributedPlotLingerTime boolean {t | nil}

Description

Specifies the time in seconds for which the distributed plot process waits before exiting when there is no active plotting window is visible. The default value is 60 second. It is recommended not to set the linger time to less than 30 second.

GUI Equivalent

The Linger Time field in the Distributed Plot section of ADE Assembler Plotting/Printing Options and ADE Explorer Plotting/Printing Options forms

Examples

envGetVal("maestro.plotting" "distributedPlotLingerTime")

envSetVal("maestro.plotting" "distributedPlotLingerTime" 'boolean t)

distributedPlotPolicyNameFilter

maestro.plotting distributedPlotPolicyNameFilter string filterName

Description

Specifies the string by which you want to filter the job policies displayed in the Job Policy Name drop-down list in the Job Policy Selection for Distributed Plot form. The default value is "", which indicates that all job policies defined using the Job Policy Setup form are displayed.

If you set this environment variable to "UNIX", only the job policies that contain UNIX in their names are displayed in the Job Policy Name drop-down list in the Job Policy Selection for Distributed Plot form. For example: UNIX_LBS and myJobPolicy_UNIX.

GUI Equivalent

None

Examples

envGetVal("maestro.plotting" "distributedPlotPolicyNameFilter")

envSetVal("maestro.plotting" "distributedPlotPolicyNameFilter" 'string "UNIX")

distributedPlotEnableNonSupportedPlotWarning

maestro.plotting distributedPlotEnableNonSupportedPlotWarning boolean {t | nil}

Description

Specifies whether to issue warning messages for waveforms that cannot be plotted by Distributed Plot service. The default value is t, which indicates that warning messages are displayed for waveforms that are not supported by Distributed Plot service.

GUI Equivalent

None

Examples

envGetVal("maestro.plotting" "distributedPlotEnableNonSupportedPlotWarning")

envSetVal("maestro.plotting" "distributedPlotEnableNonSupportedPlotWarning" 'string "UNIX")

quickPlotGlobalWriteDisable

maestro.plotting quickPlotGlobalWriteDisable boolean {t | nil}

Description

Specifies whether to turn off generating Quick Plot data. The default value is nil, which indicates that Quick Plot data is generated by default.

If you set this environment variable to t, generation of Quick Plot data remains disabled during the entire virtuoso session.

GUI Equivalent

None

Examples

envGetVal("maestro.plotting" "quickPlotGlobalWriteDisable")

envSetVal("maestro.plotting" "quickPlotGlobalWriteDisable" 'boolean t)

maestro.polo

dspfBindingSummary

maestro.polo dspfBindingSummary boolean { t | nil }

Description

Prints the DSPF-to-subcircuit binding summary in the CDS.log file.

The default is nil.

GUI Equivalent

None

Examples

envGetVal("maestro.polo" "dspfBindingSummary")

envSetVal("maestro.polo" "dspfBindingSummary" 'boolean t)

dspfBindingToCell

maestro.polo dspfBindingToCell cyclic { "bindToAll" | "bindToOne" }

Description

Specifies whether the DSPF files can be bound to multiple subcircuits or one.

bindToAll (the default) specifies that the DSPF files can be bound to multiple subcircuits.
bindToOne specifies that the DSPF files can be bound to one subcircuit each.

GUI Equivalent

None

Examples

envGetVal("maestro.polo" "dspfBindingToCell")

envSetVal("maestro.polo" "dspfBindingToCell" 'cyclic "bindToOne")

mspsSkipMappingForExtractedViews

maestro.polo mspsSkipMappingForExtractedViews string { "none" | "all" }

Description

Specifies whether to perform or skip signal mapping for all extracted views. When set to none, signals of all extracted views are mapped to the signals in the schematic. When set to all, mapping is skipped for all extracted views including the views extracted using other Cadence tools, for example, Quantus QRC av_extracted view.

When using the extracted views that are not saved by Virtuoso, set this variable to all to improve simulation performance.

This variable is used only when set in .cdsinit or .vdsinit files.

Default value is none.

GUI Equivalent

None

Examples

envGetVal("maestro.polo" "mspsSkipMappingForExtractedViews")

envSetVal("maestro.polo" "mspsSkipMappingForExtractedViews" 'string "all")

netlistSmartViewDSPFOnRecreateNetlist

maestro.polo netlistSmartViewDSPFOnRecreateNetlist boolean { t | nil }

Description

Recreates the DSPF file for a Smart View when the Netlist – Recreate command is selected.

The default is t.

GUI Equivalent

None

Examples

envGetVal("maestro.polo" "netlistSmartViewDSPFOnRecreateNetlist")

envSetVal("maestro.polo" "netlistSmartViewDSPFOnRecreateNetlist" 'boolean nil)

supportDspfMasterOption

maestro.polo supportDspfMasterOption boolean { t | nil }

Description

Lets the ADE netlister add -master options in the dspf_include statement to use the same DSPF file for multiple subcircuits.

The default is nil.

GUI Equivalent

None

Examples

envGetVal("maestro.polo" "supportDspfMasterOption")

envSetVal("maestro.polo" "supportDspfMasterOption" 'boolean t)

plotSensitivityDataInSeparateSubwindows

maestro.plotting plotSensitivityDataInSeparateSubwindows boolean {t | nil}

Description

Specifies whether to plot the results of sensitivity analysis in separate subwindows.

The default value is t, which indicates that the results of sensitivity analysis are plotted in separate subwindows.

If you set this environment variable to nil, the results are plotted in the same subwindow.

GUI Equivalent

None

Examples

envGetVal("maestro.plotting" "plotSensitivityDataInSeparateSubwindows")

envSetVal("maestro.plotting" "plotSensitivityDataInSeparateSubwindows" 'boolean nil)

maestro.simulation

interactiveE

Specifies whether the ICRPs need to submit points directly to a Spectre plugin. When a large number of sweep points or corners are used, this mode enhances the performance of a simulation run. This variable has the following valid values:

t—Each ICRP creates an initial netlist for the design and submits all the assigned points along with variable changes to a Spectre plugin. The plugin updates the netlist for each point by using the information about the variables. After the simulation for all the points is complete, Spectre plugin returns the results together for those points to the ICRP. This saves the overhead of Spectre startup, license checks, and netlisting separately for each point.
nil—Each ICRP handles simulation for a single point at a time. For each point, it starts a new session with Spectre, checks out a license, creates a netlist, and runs simulation. After the simulation for a point is complete, Spectre returns the results to the ICRP and kills the session. This involves an overhead of repetitive tasks for each point, and impacts the performance when a simulation run involves a large number of sweep points and corners.

This variable is applicable only for the Spectre simulator.

To set this variable in the .cdsinit file or CIW:

envSetVal("maestro.simulation" "interactiveE" 'boolean t)

Variable Type	boolean
Default Value	t
Acceptable Values	t, nil

interactiveRTT

Specifies whether the ICRPs need to submit points directly to a Spectre plugin when you are working in the real-time tuning mode. When a large number of sweep points or corners are used, this mode enhances the performance of a simulation run. This variable has the following valid values:

t—Each ICRP creates an initial netlist for the design and submits all the assigned points along with variable changes to a Spectre plugin. The plugin updates the netlist for each point by using the information about the variables. After the simulation for all the points is complete, Spectre plugin returns the results together for those points to the ICRP. This saves the overhead of Spectre startup, license checks, and netlisting separately for each point.
nil—Each ICRP handles simulation for a single point at a time. For each point, it starts a new session with Spectre, checks out a license, creates a netlist, and runs simulation. After the simulation for a point is complete, Spectre returns the results to the ICRP and kills the session. This involves an overhead of repetitive tasks for each point, and impacts the performance when a simulation run involves a large number of sweep points and corners.

This variable is applicable only when you use Spectre to perform real-time tuning.

To set this variable in the .cdsinit file or CIW:

envSetVal("maestro.simulation" "interactiveRTT" 'boolean t)

Variable Type	boolean
Default Value	t
Acceptable Values	t, nil

groupRunE

Enables or disables group submission of points to the available ICRP jobs. This variable has the following valid values:

t— Enables group submission of points. ADE Explorer divides the points to be simulated into groups and submits those to the available ICRP jobs at a time. Instead of communicating with ADE Assembler for each point individually, an ICRP runs the simulation for all the points in the group together and returns the results for the group. This enhances the performance of the simulation run.
When set to t, the points are grouped at the beginning of the simulation. Once the simulation is in progress, any updates made to the value of the Max. Jobs field in the Job Policy Setup form would not be reflected.
nil— Disables group submission of points. ADE Explorer submits a single point to an ICRP at a time.

To set this variable in the .cdsinit file or CIW:

envSetVal("maestro.simulation" "groupRunE" 'boolean t)

Variable Type	boolean
Default Value	`t`
Acceptable Values	`t`, `nil`

minGroupSizeSplitAcrossIdleJobs

Specifies the minimum number of pending points (jobs) with an ICRP awaiting to be run. If the number of idle points are more than this count, they are redistributed to other available ICRPs. This helps in enhancing the overall performance of the simulation run when certain ICRPs are running on slow resources. Therefore, you can set this variable to a value greater than 1 to enable reallocation of points.

For example, If a simulation has 100 points and the Max Jobs field on the Job Policy Setup form is set to 2, a set of 50 simulation points are allocated to each one of job1 and job2. If the simulations running on job1 are completed faster than those running on job2, job1 become idle. If you have specified the minimum size for a group of simulations to be considered for the reallocation of points to 5 and the number of points pending with job2 is greater than 5, some of the points are reallocated to job1. This improves the overall run time for simulations.

Note the following:

This variable is used when groupRunE is set to t in ADE Explorer and when groupRunA is set to t in ADE Assembler.
This variable is not used for the Monte Carlo run mode, which uses the adexl.monte minGroupSizeSplitAcrossIdleJobs.

To set this variable in the .cdsinit file or CIW:

envSetVal( "maestro.simulation" "minGroupSizeSplitAcrossIdleJobs" 'int t)

Variable Type	integer
Default Value	0
Acceptable Values	`0` or `1` - Reallocation of jobs is disabled. Any positive integer value greater than 1 - Reallocation of jobs is enabled when the group size is greater than the specified value.

checkSpectreStatus

Enables or disables checking of the status of Spectre processes running simulations. When this check is enabled, ADE Explorer or ADE Assembler periodically checks for the status of the Spectre processes. If a Spectre process is suspended because of the unavailability of resources, ADE Explorer or ADE Assembler also suspends the corresponding job connected to that process.

To set this variable in the .cdsinit file or CIW:

envSetVal("maestro.simulation" "checkSpectreStatus" 'boolean t)

Variable Type	boolean
Default Value	t
Acceptable Values	t, nil

maxRDBSyncWait

Specifies the maximum wait time (in seconds) for which ADE Explorer or ADE Assembler needs to wait for the results data to be used for the evaluation of calcVal expressions before reporting an evaluation error. ADE Assembler considers this variable only when the results for the corresponding point are not found in the results database when querying outputs for calcVal evaluation. This variable is particularly useful when the simulations are running over NFS and there could be a delay in retrieving the results

The wave comparison feature of ADE Assembler also uses calcVal internally. If the wave comparison results are not displayed correctly, you can use this variable to allow some time for data retireval before comparisons are done.

To set this variable in the .cdsenv:

maestro.simulation maxRDBSyncWait int 60

In .cdsinit or the CIW:

envSetVal( "maestro.simulation" "maxRDBSyncWait" 'int 60)

Variable Type	Integer
Default Value	60
Acceptable Values	A positive integer value between the range of `1` and `600`

addHostNameToDisplayPort

Specifies whether or not ADE Explorer or ADE Assembler must add a host name if it is missing from the DISPLAY shell environment variable. When you have multiple computer resources available to run simulation, you might skip the host name and provide only the port number, say :10.0, in the DISPLAY environment variable. In that case, the tool can use any remote machine to run simulation.

However, this value of DISPLAY may not be considered as complete for certain simulation mode and the tool displays an error. For example, an AMS simulation in interactive mode requires the complete information in the format hostName:portNumber. In such a case, if this environment variable is set to t, the tool can add the host name, which is the current host on which Virtuoso is running, to the display port.

To set this variable in the .cdsenv:

maestro.simulation addHostNameToDisplayPort boolean t

In .cdsinit or the CIW:

envSetVal( "maestro.simulation" "addHostNameToDisplayPort" 'boolean t)

Variable Type	boolean
Default Value	`t`
Acceptable Values	`t`: If the host name is missing in the value of DISPLAY, the tool adds the host name to the display port `nil`: If the host name is missing in the value of DISPLAY, the tool does not add the host name to the display port

maestroViewEnvName

maestro.simulation maestroViewEnvName string variableName

Description

Specifies the name of the shell variable that returns the UNIX path to a maestro cellview.

The default value is "".

This shell variable can then be used to specify the path to a model file in the Model Library Setup form.

For example, on specifying a model file path as $MAESTROVIEW/gdpdk045.scs means that the model file gdpdk045.scs is in the directory of the current maestro cellview. The path to this cellview is automatically evaluated through the shell variable $MAESTROVIEW.

GUI Equivalent

None

Examples

envSetVal("maestro.simulation" "maestroViewEnvName")

envSetVal("maestro.simulation" "maestroViewEnvName" 'string "$MAESTROVIEW")

cancelRunAfterRetries

maestro.simulation cancelRunAfterRetries int number_of_attempts

Description

Specifies the maximum number of unsuccessful attempts of successful simulation of a point after which you want to cancel the complete simulation run without attempting simulation of the remaining points. The default value is 0, which implies that ADE Explorer or ADE Assembler continues to retry failing simulations until the run is manually stopped.

GUI Equivalent

None

Examples

envGetVal("maestro.simulation" "cancelRunAfterRetries")

envSetVal("maestro.simulation" "cancelRunAfterRetries" 'int 10)

maestro.stimuli

maxStopTime

Specifies the max value of stop time for any new stimuli defined in the Stimuli Assignment form. It is used to prevent long simulations for waveform previews.

To set this variable in .cdsinit or CIW:

envSetVal("maestro.stimuli" "maxStopTime" 'string "1m")

Variable Type	string
Default Value	"1m"
Acceptable Values	Any string value

maestro.stimuliTool

stopTime

Specifies the stop time for any new stimuli defined in the Stimuli Assignment form.

To set this variable in .cdsinit or CIW:

envSetVal("maestro.stimuliTool" "stopTime" 'string "1n")

Variable Type	string
Default Value	"1n"
Acceptable Values	Any string value
GUI Equivalent	Field, STOP TIME, in the Stimuli Assignment form

isourceResistorValue

Specifies the resistance value of a resistor required to plot waveform from an isource component.

In .cdsinit or the CIW:

envSetVal( "maestro.stimuliTool" "isourceResistorValue" 'string "1k")

Variable Type	string
Default Value	"1k"
Acceptable Values	Valid column names, including user-defined column names

maestro.variables

autoSyncGlobalVarsToTestVars

Controls whether the value of global and local variables should be in synchronization when modified using ADE Explorer or Assembler.

When this variable is set to t, if you are working in ADE Assembler and change a global variable, then every test in ADE Assembler takes that global value to be the design value. If you change a design variable in Explorer and then go to ADE Assembler, then only the local value of design variable for that test is updated. While changing a variable value in ADE Explorer, the value of corresponding global variable is not updated; however, a yellow highlight appears on that global variable indicating that it has been overridden by the test-specific local value.

When this variable is set to nil, changing a global variable in ADE Assembler does not affect that variable in the tests. Similarly, changing a design variable in ADE Explorer changes the variable only for that test.

To set this variable in the .cdsinit file or CIW:

envSetVal("maestro.variables" "autoSyncGlobalVarsToTestVars" 'boolean t)

Variable Type	boolean
Default Value	nil
Acceptable Values	t, nil

Example

When you are in ADE Assembler, you can choose to use either global or local design variables. Suppose, you have two tests in ADE Assembler, Test1 and Test2 with a common variable, CAP. In Test1, CAP=220u, and in Test2, CAP=100u.

Case1: Global variable is not selected. The local values of tests are used in both ADE Assembler and ADE Explorer.

Case2: When you select the global variable, CAP=150u, the local values are striked-out showing that global value has been used for these tests.

Now, if you open Test1 in ADE Explorer, the value of CAP is 170u. If you change this value to 200u, the local value of this variable is changed to 200 in ADE Assembler and a yellow highlight appears on the global value indicating that the global value is overwritten by the local value for a test.

maestro.window

width

Sets the width (in pixels) of the ADE Explorer and ADE Assembler windows. When the width is 0, the width of the session window is used.

By default, the window is displayed at the pixel coordinates specified by the list (120:180 1520:980). Therefore, the default width of the window is 1400 pixels.

To set this variable in the .cdsinit file or CIW:

envSetVal("maestro.window" "width" 'int 1200)

Variable Type	integer
Default Value	`1400`
Acceptable Values	any integer value

height

Sets the height (in pixels) of the ADE Explorer and ADE Assembler windows. When the height is 0, the height of the session window is used.

By default, the window is displayed at the pixel coordinates specified by the list (120:180 1520:980). Therefore, the default height of the window is 800 pixels.

To set this variable in the .cdsinit file or CIW:

envSetVal("maestro.window" "height" 'int 600)

Variable Type	integer
Default Value	`800`
Acceptable Values	any integer value

Spectre

AC Match Analysis Environment Variables

Spectre.emirOpts

advancedTable

spectre.emirOpts advancedTable string any_string

Description

Specifies any additional options that Spectre supports for EMIR analysis.

For more information, refer to the EMIR Analysis section in the Spectre Classic Simulator, Spectre APS, Spectre X, and Spectre XPS User Guide.

The default value is "".

GUI Equivalent

Command:	EMIR Analysis Setup – Basic
Field:	Voltus-Fi - Base Name

Examples

envGetVal("spectre.emirOpts" "advancedTable")

envSetVal("spectre.emirOpts" "advancedTable" 'string "((t \"Tlife\" \"100000hours\") (t \"include\" \"settings.conf\"))")

anaType

spectre.emirOpts anaType string Dynamic

Description

Specifies the type of EMIR analysis to be used during simulation.

The valid values are:

Dynamic: Estimates the IR and EM current density by performing a DC or transient simulation.
Static: Enables you to evaluate IR drops and EM currents based on the specified current consumptions for subcircuit instances without running a transient or DC simulation. The specified currents are distributed to the tap devices based on the width and length ratios of devices in the design. The IR drop and EM current analysis is performed based on the current at each tap device.
SPGS: Used to calculate pin-to-tap resistances based on the description of a DSPF file and the options set in an EMIR configuration file. The resistances calculated by SPGS are electrically equivalent resistances, and not the sum of resistances.

The default value is Dynamic.

GUI Equivalent

Command	EMIR Analysis Setup – Basic
Field	Basic - Type

Examples

envGetVal("spectre.emirOpts" "anaType")

envSetVal("spectre.emirOpts" "anaType" 'string "Dynamic")

envSetVal("spectre.emirOpts" "anaType" 'string "Static")

envSetVal("spectre.emirOpts" "anaType" 'string "SPGS")

autoLoadVfiFile

spectre.emirOpts autoLoadVfiFile boolean { t | nil }

Description

Loads the Voltus-Fi setup from the previous EMIR Quantus xDSPF run.

The default value is nil.

GUI Equivalent

Command	EMIR Analysis Setup – Voltus-Fi
Field	Voltus-Fi - read settings from .vfiExtractDSPFGuiLast

Examples

envGetVal("spectre.emirOpts" "autoLoadVfiFile")

envSetVal("spectre.emirOpts" "autoLoadVfiFile" 'boolean nil)

envSetVal("spectre.emirOpts" "autoLoadVfiFile" 'boolean t)

dspfListBox

spectre.emirOpts dspfListBox string any_string

Description

Specifies the DSPF file to be used during the EMIR analysis. It contain the post-layout data of the design, including fingered devices and net parasitics, with the parasitic and instance sections describing the circuit to be analyzed.

GUI Equivalent

Command	EMIR Analysis Setup – Techfile
Field	Techfile - DSPF File

Examples

envGetVal("spectre.emirOpts" "dspfListBox")

envSetVal("spectre.emirOpts" "dspfListBox" 'string "((\"$WORKDIR/bias_amp.dspf\" \"\" \"\" \"Not Run\"))")

dynamicAnaSummaryBox

spectre.emirOpts dynamicAnaSummaryBox string any_string

Description

Specifies the type of analysis to be performed and the nets or instances for which the analysis is performed.

It is only effective when anaType is set to Dynamic.

GUI Equivalent

Command	EMIR Analysis Setup – Basic
Field	Basic - Analysis table

Examples

envGetVal("spectre.emirOpts" "dynamicAnaSummaryBox")

envSetVal("spectre.emirOpts" "dynamicAnaSummaryBox" 'string "((t \"instName\" \"\" \"\" \"\" \"\" \"\" \"\" nil \"\" \"\" \"\" \"\" \"\" \"\" \"\"))")

editSummaryInfoTable

spectre.emirOpts editSummaryInfoTable boolean { t | nil }

Description

Enables editing the summary information table.

The default value is nil.

GUI Equivalent

Command	EMIR Analysis Setup – Basic
Field	Basic - Edit Summary Information Table

Examples

envGetVal("spectre.emirOpts" "editSummaryInfoTable")

envSetVal("spectre.emirOpts" "editSummaryInfoTable" 'boolean nil)

envSetVal("spectre.emirOpts" "editSummaryInfoTable" 'boolean t)

emDataFile

spectre.emirOpts emDataFile string any_string

Description

Specifies the EM data file to be used during EMIR analysis.

It is only effective when techFileMode is set to emData File.

The default value is " ".

GUI Equivalent

Command	EMIR Analysis Setup – Techfile
Field	Techfile - EM Data File

Examples

envGetVal("spectre.emirOpts" "emDataFile")

envSetVal("spectre.emirOpts" "emDataFile" 'string "$WORKDIR/dev_checks.scs")

emOnlyIctFile

spectre.emirOpts emOnlyIctFile string any_string

Description

Specifies the EM Only ICT file to used during EMIR analysis.

This file provides the process and the EM model information for EM analysis. This is a text-based file, which means you can use any text editor to enter information in this file.

The default value is "".

GUI Equivalent

Command	EMIR Analysis Setup – Techfile
Field	Techfile - EM Only ICT File

Examples

envGetVal("spectre.emirOpts" "emOnlyIctFile")

envSetVal("spectre.emirOpts" "emOnlyIctFile" 'string "$WORKDIR/em.ict")

enableEMIRAna

spectre.emirOpts enableEMIRAna boolean { t | nil }

Description

Enables EMIR analysis during a simulation run.

The default value is nil, in which case EMIR analysis is not enabled.

GUI Equivalent

Command	EMIR Analysis Setup – Basic
Field	Basic - Enable EMIR Analysis in Transient or DC Simulation

Examples

envGetVal("spectre.emirOpts" "enableEMIRAna")

envSetVal("spectre.emirOpts" "enableEMIRAna" 'boolean nil)

envSetVal("spectre.emirOpts" "enableEMIRAna" 'boolean t)

hideAnalysesItems

spectre.emirOpts hideAnalysesItems string any_string

Description

Hides the columns corresponding to the specified analyses from the table displayed when you select the Dynamic analysis type in the Analysis section of the Basic tab.

Note the following:

The valid value is a space-separated list of analysis names.
The analysis names must be in lower case.
There should not be any space in the analysis names.

The default value is "".

GUI Equivalent

Command	EMIR Analysis Setup – Basic
Field	Basic - Analyses - Dynamic

Examples

envGetVal("spectre.emirOpts" "hideAnalysesItems")

envGetVal("spectre.emirOpts" "hideAnalysesItems" 'string "irmax iravg emmax emavg")

ictFile

spectre.emirOpts ictFile string any_string

Description

Specifies the ICT file to be used during EMIR analysis.

This is an editable text file that specifies the EM reliability rules for EM analysis.

The default value is "".

GUI Equivalent

Command	EMIR Analysis Setup – Techfile
Field	Techfile - ICT File

Examples

envGetVal("spectre.emirOpts" "ictFile")

envGetVal("spectre.emirOpts" "ictFile" 'string "$WOKRDIR/emData.txt")

includeFile

spectre.emirOpts includeFile string any_string

Description

Specifies any additional files that spectre supports for EMIR analysis.

For more information, refer to the EMIR Analysis section in the Spectre Classic Simulator, Spectre APS, Spectre X, and Spectre XPS User Guide.

The default value is "".

GUI Equivalent

Command	EMIR Analysis Setup – Techfile
Field	Techfile - Include File

Examples

envGetVal("spectre.emirOpts" "includeFile")

envGetVal("spectre.emirOpts" "includeFile" 'string "WORKDIR/static_ifile.txt")

layerName

spectre.emirOpts layerName string any_string

Description

Specifies the name of the name of the DSPF layer to be shorted.

The default value is "".

GUI Equivalent

Command	EMIR Analysis Setup – Basic
Field	Basic - LayerName

Examples

envGetVal("spectre.emirOpts" "layerName")

envGetVal("spectre.emirOpts" "layerName" 'string "Layer1")

netName

spectre.emirOpts netName string any_string

Description

Specifies the name of the net for which the static power grid solver analysis is to be performed.

It is only effective when anaType is set to SPGS.

The default value is "".

GUI Equivalent

Command	EMIR Analysis Setup – Basic
Field	Basic - Net Name

Examples

envGetVal("spectre.emirOpts" "netName")

envGetVal("spectre.emirOpts" "netName" 'string "net05")

qrcTechFile

spectre.emirOpts qrcTechFile string any_string

Description

Specifies the QRC techology file to be used during EMIR analysis.

This file contains the current limits for each process layer and is usually available through a foundry.

The default value is "".

GUI Equivalent

Command	EMIR Analysis Setup – Techfile
Field	Techfile - qrcTechFile

Examples

envGetVal("spectre.emirOpts" "qrcTechFile")

envGetVal("spectre.emirOpts" "qrcTechFile" 'string "$WORKDIR/em.ict")

short

spectre.emirOpts short string any_string

Description

Specifies the resistors that need to be shorted during static power grid analysis

It is only effective when anaType is set to SPGS.

The default value is "".

GUI Equivalent

Command	EMIR Analysis Setup – Basic
Field	Basic - short

Examples

envGetVal("spectre.emirOpts" "short")

envSetVal("spectre.emirOpts" "short" 'string "1.5")

shortResLayer

spectre.emirOpts shortResLayer string yes

Description

Confirms if the specified DSPF layer should be shorted or not.

It is only effective when anaType is set to SPGS.

The default value is yes.

GUI Equivalent

Command	EMIR Analysis Setup – Basic
Field	Basic - Short_res_layer

Examples

envGetVal("spectre.emirOpts" "shortResLayer")

envSetVal("spectre.emirOpts" "shortResLayer" 'string "yes")

envSetVal("spectre.emirOpts" "shortResLayer" 'string "no")

solverMethod

spectre.emirOpts solverMethod string Direct

Description

Specifies the solver method to be used for EMIR analysis. The valid values are:

Direct: When high accuracy is needed, a brute-force simulation of the entire system—circuit and parasitic resistances and capacitances—can be performed to accurately calculate EMIR for any net. This approach is also called the one-step method, where the EMIR simulation performance and capacity are subject to the limitations of the circuit simulator being used.
Iterated: To conduct EMIR simulation on circuits with much larger power and signal nets, within a shorter time, this alternative approach that involves decoupling the nonlinear circuit simulation from the linear RC net analysis. You can iterate the linear RC net analysis by modifying the layout. However, the nonlinear circuit simulation is done only once. This approach is also called the two-step method.

The default value is Direct.

GUI Equivalent

Command	EMIR Analysis Setup – Solver
Field	Solver - Solver Method

Examples

envSetVal("spectre.emirOpts" "solverMethod")

envSetVal("spectre.emirOpts" "solverMethod" 'string "Direct")

envSetVal("spectre.emirOpts" "solverMethod" 'string "Iterated")

solverMethodTable

spectre.emirOpts solverMethodTable string any_string

Description

Specifies the solver method options that spectre supports with EMIR analysis.

The default value is "".

GUI Equivalent

Command	EMIR Analysis Setup – Solver
Field	Solver - Solver Method table

Examples

envSetVal("spectre.emirOpts" "solverMethodTable")

envSetVal("spectre.emirOpts" "solverMethodTable" 'string "((t \"solver\" \"solverOptions\"))")

spgsAdvIRDrop

spectre.emirOpts spgsAdvIRDrop boolean { t | nil }

Description

Enables or disables the advanced IR drop analysis.

It is only effective when anaType is set to SPGS.

The default value is nil.

GUI Equivalent

Command	EMIR Analysis Setup – Basic
Field	Basic - Advanced IR Drop Analysis

Examples

envGetVal("spectre.emirOpts" "spgsAdvIRDrop")

envSetVal("spectre.emirOpts" "spgsAdvIRDrop" 'boolean t)

envSetVal("spectre.emirOpts" "spgsAdvIRDrop" 'boolean nil)

spgsFilterMoscap

spectre.emirOpts spgsFilterMoscap string no

Description

Specifies if the tap nodes connected to MOSFET devices should filtered out or not.

It is only effective when anaType is set to SPGS.

The default value is "no".

GUI Equivalent

Command	EMIR Analysis Setup – Basic
Field	Basic - filter moscap

Examples

envGetVal("spectre.emirOpts" "spgsFilterMoscap")

envSetVal("spectre.emirOpts" "spgsFilterMoscap" 'string "no")

envSetVal("spectre.emirOpts" "spgsFilterMoscap" 'string "yes")

staticAnaSummaryBox

spectre.emirOpts staticAnaSummaryBox string any_string

Description

Specifies the type of analysis to be performed and the nets or instances for which the analysis is performed.

It is effective only when anaType is set to Static.

The default value is "".

GUI Equivalent

Command	EMIR Analysis Setup – Basic
Field	Basic - Analysis table

Examples

envGetVal("spectre.emirOpts" "staticAnaSummaryBox")

envSetVal("spectre.emirOpts" "staticAnaSummaryBox" 'string "((t \"I0.*\" t t t \"additionalOptions\") (t \"<Click_To_Add>\" nil nil \"\")"))

summaryListBox

spectre.emirOpts summaryListBox string any_string

Description

Specifies the summary information in the summary information table.

It is only effective when editSummaryInfoTable is set to t.

The default value is "".

GUI Equivalent

Command	EMIR Analysis Setup – Summary
Field	Summary - Summary Information

Examples

envSetVal("spectre.emirOpts" "summaryListBox")

envSetVal("spectre.emirOpts" "summaryListBox" 'string "((t \"techfile=$WORKDIR/em.ict\" t t t \"value\") (t \"<Click_To_Add>\" nil nil \"\")"))

techFileMode

spectre.emirOpts techFileMode string qrcTechFile with external EM Only ICT File

Description

Specifies the mode to set up the EM technology files. The valid values are:

qrcTechFile with external EM only ICT File: Specifies a QRC technology and an EM only ICT file.
qrcTechFile with embedded emModel section: Specifies a QRC technology file.
ICT File with external EM only ICT File: Specifies an ICT file and an EM only ICT file.
ICT File with embedded emModel section: Specifies an ICT file.
ICT File with embedded emModel section: Specifies an EM data file.

The default value is qrcTechFile with external EM Only ICT File.

GUI Equivalent

Command	EMIR Analysis Setup – Techfile
Field	Techfile - Mode

Examples

envGetVal("spectre.emirOpts" "techFileMode")

envSetVal("spectre.emirOpts" "techFileMode" 'string "qrcTechFile with external EM Only ICT File")

envSetVal("spectre.emirOpts" "techFileMode" 'string "qrcTechFile with embedded emModel section")

envSetVal("spectre.emirOpts" "techFileMode" 'string "ICT File with external EM Only ICT File")

envSetVal("spectre.emirOpts" "techFileMode" 'string "ICT File with embedded emModel section")

envSetVal("spectre.emirOpts" "techFileMode" 'string "emData File")

timeWindowListBox

spectre.emirOpts timeWindowListBox string any_string

Description

Specifies the time period for which the EMIR analysis is to be run.

The default value is "".

GUI Equivalent

Command	EMIR Analysis Setup – Solver
Field	Solver - Time Window table

Examples

envGetVal("spectre.emirOpts" "timeWindowListBox")

envSetVal("spectre.emirOpts" "timeWindowListBox" 'string "((\"0\" \"100n\"))")

Spectre.envlpOpts

sweepmethod

spectre.envlpOpts sweepmethod string { coarse | fine | userdefined | adaptive }

Description

Controls the sweep algorithm during fast envelope circuit characterization.

coarse: Uses seven magnitude points and twelve phase points when the parameter fastmethod is set to baseband.
fine: Uses ten magnitude points and sixteen phase points when the parameter fastmethod is set to baseband.
userdefined: Lets you define the grid using the parameter sweepnum.
adaptive: Automatically determines the number of sweep points.

The default value is coarse.

GUI Equivalent

Command	Envelope Following Options—Accuracy
Field	sweepmethod

Examples

envGetVal("spectre.envlpOpts" "sweepmethod")

envSetVal("spectre.envlpOpts" "sweepmethid" 'string "fine")

Spectre.envOpts

case_sensitive

Enables case sensitivity in a regenerated netlist and adds case_sensitive = true in the dspf_include statement for a Smart View.

For more information, see DSPF Support.

To set this variable in the .cdsinit file or CIW, use the call:
envSetVal("spectre.envOpts" "case_sensitive" 'string "true")

To set this variable in the .cdsenv file, use the call:
spectre.envOpts case_sensitive 'string "true"

Variable Type	string
Default Value	`true`
Acceptable Values	`true`, `false`
GUI Equivalent	N/A

lsusp

Selects or deselects the check box Check in License When Suspended in the Environment Options form for Spectre.

To set this variable in the .cdsinit file or CIW, use the call:
envSetVal("spectre.envOpts" "lsusp" 'boolean nil)

To set this variable in the .cdsenv file, use the call:
spectre.envOpts lsusp boolean nil

Variable Type	boolean
Default Value	`nil`
Acceptable Values	`t`, `nil`
GUI Equivalent	Environment Options form — Check in License When Suspended

lsuspEnvOverridesState

Overrides the setting specified through lsusp.

In case you want to set this variable in the CIW, ensure that you do so before opening a maestro view.

To set this variable in the .cdsinit file or CIW, use the call:
envSetVal("spectre.envOpts" "lsuspEnvOverridesState" 'boolean nil)

To set this variable in the .cdsenv file, use the call:
spectre.envOpts lsuspEnvOverridesState boolean nil

Variable Type	boolean
Default Value	`nil`
Acceptable Values	`t`, `nil`
GUI Equivalent	N/A

setTopLevelAsSubckt

spectre.envOpts setTopLevelAsSubckt boolean { t | nil }

Description

Controls whether the top-level schematic should be netlisted as a subcircuit or not.

This variable is supported with the si batch mode flow and must be set in the .simrc file.

The default is nil.

GUI Equivalent

None

Examples

envGetVal("spectre.envOpts" "setTopLevelAsSubckt")

envSetVal("spectre.envOpts" "setTopLevelAsSubckt" 'boolean t)

Spectre.hb

dynchoice

spectre.hb dynchoice string { Parameter vector| Parameter file }

Description

Specifies the type of input dynamic parameter.

Parameter vector: Lets you specify the time and value for the specified parameter.
Parameter file: Lets you specify a parameter file.

The default value is Parameter vector.

GUI Equivalent

Command	Analyses—Choose—Choosing Analyses form
Field	Parameter

Examples

envGetVal("spectre.hb" "dynchoice")

envSetVal("spectre.hb" "dynchoice" 'string "Parameter file")

Spectre.opts

enable_dcsweep_op_info

spectre.opts enable_dcsweep_op_info string { "no" | "yes" }

Description

Specifies whether the Evaluate over DC Sweep check box in the Operating Region Specification form is selected or deselected by default.

The default is "no".

GUI Equivalent

Command	Operating Region assistant—Show All
Field	Evaluate over DC Sweep

Examples

envGetVal("spectre.opts" "enable_dcsweep_op_info")

envSetVal("spectre.opts" "enable_dcsweep_op_info" 'string "yes")

tranFilterExtreme

spectre.opts tranFilterExtreme boolean { t | nil }

Description

Selects or deselects the option extreme for the Filter field in the Transient tab of the Device Checking Options form.

This variable works only for newly created ADE Explorer or ADE Assembler views.

The default is nil.

GUI Equivalent

Command	Device Checking Options form —Transient tab — Filter
Field	extreme

Examples

envGetVal("spectre.opts" "tranFilterExtreme")

envSetVal("spectre.opts" "tranFilterExtreme" 'boolean t)

Spectre.pss

The following table lists the environment variables in the spectre.pss partition. These variables work exactly same as the variables in the spectre.hb partition.

spectre.pss environment variable	Corresponding spectre.hb environment variable
dynchoice	dynchoice

Spectre.tran

dynamicChoice

Specifies the dynamic parameter choice.

If set to Vector, the time value pairs specified in the table are used during simulation. On setting this variable to file, the parameter value is taken from the selected file.

To set this variable in the .cdsinit file or CIW, use the call:
envSetVal("spectre.tran" "dynamicChoice" 'string "Vector")

To set it in the .cdsenv file, add:
spectre.tran dynamicChoice 'string "Vector"

Variable Type	string
Default Value	`"Vector"`
Acceptable Values	`Vector`, `file`
GUI Equivalent	Choosing Analyses – Dynamic Parameter – Parameter or Parameter Set

dynamicParameter

Specifies the data type of the dynamic parameter.

To set this variable in the .cdsinit file or CIW, use the call:
envSetVal("spectre.tran" "dynamicParameter" 'string "Parameter")

To set it in the .cdsenv file, add:
spectre.tran dynamicParameter 'string "Parameter"

Variable Type	string
Default Value	`"Parameter"`
Acceptable Values	`Parameter`, `Parameter` `Set`
GUI Equivalent	Choosing Analyses – Dynamic Parameter

dynParamChoice

Specifies the transient analysis parameter to be varied with time, during a transient simulation.

If set to User-defined, you can manually add a parameter name.

This variable can be used when the value for the variable dynamicParameter is set to Parameter.

To set this variable in the .cdsinit file or CIW, use the call:
envSetVal("spectre.tran" "dynParamChoice" 'string "User-defined")

To set it in the .cdsenv file, add:
spectre.tran dynParamChoice 'string "User-defined"

Variable Type	string
Default Value	`"User-defined"`
Acceptable Values	`User-defined`, `errpreset`, `method`, `relref`, `maxstep`, `isnoisy`, `iteratio`, `reltol`, `residualtol`, `vabstol`, `iabstol`, `temp` and `tnom`
GUI Equivalent	Choosing Analyses – Dynamic Parameter – Parameter – Param

dynParamInput

When the variable, dynParamChoice is set to User-defined, this variable can be used to manually specify the name of the parameter to be varied.

This variable can be used when the value for the variable dynamicParameter is set to Parameter.

To set this variable in the .cdsinit file or CIW, use the call:
envSetVal("spectre.tran" "dynParamInput" 'string "")

To set it in the .cdsenv file, add:
spectre.tran dynParamInput 'string ""

Variable Type	string
Default Value	`""`
Acceptable Values	A user-defined string.
GUI Equivalent	Choosing Analyses – Dynamic Parameter – Parameter – Param

dynParamSetChoice

Specifies the transient analysis parameter to be varied with time, during a transient simulation.

If set to User-defined, you can manually add a parameter name.

This variable can be used when the value for the variable dynamicParameter is set to Parameter Set.

To set this variable in the .cdsinit file or CIW, use the call:
envSetVal("spectre.tran" "dynaramSetChoice" 'string "User-defined")

To set it in the .cdsenv file, add:
spectre.tran dynParamSetChoice 'string "User-defined"

Variable Type	string
Default Value	`"User-defined"`
Acceptable Values	`User-defined`, `errpreset`, `method`, `relref`, `maxstep`, `isnoisy`, `iteratio`, `reltol`, `residualtol`, `vabstol`, `iabstol`, `temp` and `tnom`
GUI Equivalent	Choosing Analyses – Dynamic Parameter – Parameter Set– Param

dynParamSetInput

When the variable, dynParamChoice is set to User-defined, this variable can be used to manually specify the name of the parameter to be varied.

This variable can be used when the value for the variable dynamicParameter is set to Parameter Set.

To set this variable in the .cdsinit file or CIW, use the call:
envSetVal("spectre.tran" "dynParamSetInput" 'string "")

To set it in the .cdsenv file, add:
spectre.tran dynParamSetInput 'string ""

Variable Type	string
Default Value	`""`
Acceptable Values	A user-defined string.
GUI Equivalent	Choosing Analyses – Dynamic Parameter – Parameter Set – Param

Spectre X

spectreXAdvanced

Displays or hides the advanced options, Preset Override and Parasitics Optimization in the High-Performance Simulation Options form.

To set this variable in the .cdsinit file or CIW, use the call:

envSetVal("spectre.turboOpts" "spectreXAdvanced" 'boolean nil)

Variable Type	boolean
Default Value	nil
Acceptable Values	`t` –Displays the advanced options on the High-Performance Simulation Options form `nil` –Hides the advanced options on the High-Performance Simulation Options form
GUI Equivalent	High-Performance Simulation Options–Advanced Options

spectreXPreset

Specifies the value of Preset for Spectre X.

To set this variable in the .cdsinit file or CIW, use the call:

envSetVal("spectre.turboOpts" "spectreXPreset" 'string "MX")

Variable Type	string
Default Value	"`MX`"
Acceptable Values	`CX` – When a golden simulation reference is needed `AX` – For high-precision analog applications `MX` – For most analog applications (default) `LX` – For power management and other relaxed analog applications `VX` – For custom IC verification
GUI Equivalent	High-Performance Simulation Options–Preset

spectreXMpOption

Defines the type of multi-processing. Spectre X allows distributed simulation, therefore, it can used more computer cores across multiple computer hosts to further speed up DC and transient run time of large to very large postlayout circuits. You can select the following methods for job distribution: Farm, SSH, and RSH.

To set this variable in the .cdsinit file or CIW, use the call:

envSetVal("spectre.turboOpts" "spectreXMpOption" 'string "SSH")

Variable Type	string
Default Value	"`SSH`"
Acceptable Values	`Farm`, `SSH`, `RSH`
GUI Equivalent	High-Performance Simulation Options–Multi-Processing

spectreXEnablePostLayout

Enables or disables the option to select parasitics optimization with the chosen preset option for the Spectre X simulation performance mode.

To set this variable in the .cdsinit file or CIW, use the call:

envSetVal("spectre.turboOpts" "spectreXEnablePostLayout" 'boolean nil)

Variable Type	boolean
Default Value	`nil`
Acceptable Values	`t` – Enables the parasitics optimization on the High-Performance Simulation Options form `nil` – Disables the parasitics optimization on the High-Performance Simulation Options form
GUI Equivalent	High-Performance Simulation Options–Parasitics Optimization

spectreXAccuracyScale

Specifies the value of Parasitics Optimization.

To set this variable in the .cdsinit file or CIW, use the call:

envSetVal("spectre.turboOpts" "spectreXAccuracyScale" 'string "MX")

Variable Type	string
Default Value	"`MX`"
Acceptable Values	`OFF` – When parasitics optimization is switched off `CX` – When a golden simulation reference is needed `AX` – For high-precision analog applications `MX` – For most analog applications (default) `LX` – For power management and other relaxed analog applications `VX` – For custom IC verification
GUI Equivalent	High-Performance Simulation Options–Parasitics Optimization

spectreXHosts

Specifies the machine name of the host. For example, sj-<username> or noi-<username>.

To set this variable in the .cdsinit file or CIW, use the call:

envSetVal("spectre.turboOpts" "spectreXHosts" 'string "<machine_name>")

Variable Type	string
Default Value	`""`
Acceptable Values	Name of the host to run Spectre X
GUI Equivalent	N/A

spectreXMpThreads

Specifies the number of threads when Multi-Processing is selected in Spectre X simulation performance mode.

To set this variable in the .cdsinit file or CIW, use the call:

envSetVal("spectre.turboOpts" "spectreXMpThreads" 'string "")

Variable Type	string
Default Value	`""`
Acceptable Values	Integer values passed as strings
GUI Equivalent	High-Performance Simulation Options–Multi-Processing

spectreXMtOption

Specifies the type of multi-threading in Spectre X simulation performance mode.

To set this variable in the .cdsinit file or CIW, use the call:

envSetVal("spectre.turboOpts" "spectreXMtOption" 'string "Auto")

Variable Type	string
Default Value	"`Auto`"
Acceptable Values	`Auto` – To automatically allocate the threads for simulation `Disable` – To disable multi-threading `Manual` – To manually allocate threads
GUI Equivalent	High-Performance Simulation Options–Multi-Threading

spectreXNumThreads

Specifies the number of threads for Multi-Threading in Spectre X simulation performance mode.

To set this variable in the .cdsinit file or CIW, use the call:

envSetVal("spectre.turboOpts" "spectreXNumThreads" 'string "")

Variable Type	string
Default Value	`""`
Acceptable Values	Integer values passed as strings
GUI Equivalent	High-Performance Simulation Options–# Threads

spectreXMTPOption

Specifies whether the type of Spectre X is multi-threading or multi-processing.

To set this variable in the .cdsinit file or CIW, use the call:

envSetVal("spectre.turboOpts" "spectreXMTPOption" 'string "Multi-Threading")

Variable Type	string
Default Value	"`Multi-Threading`"
Acceptable Values	"`Multi-Threading`", "`Multi-Processing`"
GUI Equivalent	N/A

uniMode

This variable is used to set the simulation performance modes for Spectre. The available modes are Spectre (default), APS, Spectre X, and Spectre FX.

To set this variable in the .cdsinit file or CIW, use the call:

envSetVal("spectre.turboOpts" "uniMode" 'string  "Spectre")

Variable Type	string
Default Value	`Spectre`
Acceptable Values	`Spectre`, `APS`, `Spectre` `X`, `Spectre FX`
GUI Equivalent	Setting up Explorer Environment– Setting up High-Performance Simulation Options

spectreVerilog

The following table lists the environment variables in the spectreVerilog partition. These variables work exactly same as the variables in the spectre partition.

spectreVerilog environment variable	Corresponding spectre environment variable
autoLoadVfiFile	autoLoadVfiFile
dspfListBox	dspfListBox
editSummaryInfoTable	editSummaryInfoTable
nportbbsversion	nportbbsversion
preserveSubcktTermNamesByOrder	preserveSubcktTermNamesByOrder

Ultrasim

voltus_fi.results

vfiEnableGUI

voltus_fi.results vfiEnableGUI boolean { t | nil }

Description

Specifies whether to hide or display the warning message about the deprecation of Voltus™-Fi Custom Power Integrity Solution in the next IC base release. This message appears when you open the EMIR Analysis Setup form.

The default value is nil.

GUI Equivalent

None

Examples

envGetVal("voltus_fi.results" "vfiEnableGUI")

envSetVal("voltus_fi.results" "vfiEnableGUI" 'boolean t)

Real Time Tuning Environment Variables

activeTimeout

Specifies the timeout in seconds for the RTT simulation. If the RTT assistant is inactive for longer than the specified timeout value, the simulator license gets checked in and the RTT simulation is stopped.

To set this variable in the .cdsinit file or CIW:

envSetVal("maestro.rtt" "activeTimeout" 'int 3600)

Variable Type	integer
Default Value	3600
Acceptable Values	Any integer value greater than 0
GUI Equivalent	N/A

timeoutShowLog

Specifies the timeout in seconds. If the RTT simulation does not complete by the specified time, a pop up message is displayed to show the latest status.

To set this variable in the .cdsinit file or CIW:

envSetVal("maestro.rtt" "timeoutShowLog" 'int 10)

Variable Type	integer
Default Value	10
Acceptable Values	Any integer value
GUI Equivalent	N/A

hostMode

Specifies the host as local or remote on which you want to run the RTT simulation.

To set this variable in the .cdsinit file or CIW:

envSetVal("maestro.rtt" "hostMode" 'string "local")

Variable Type	string
Default Value	local
Acceptable Values	remote, local
GUI Equivalent	N/A

host

If the host mode is set to remote, specify the host name in this variable that can be used to run the remote simulation.

To set this variable in the .cdsinit file or CIW:

envSetVal("maestro.rtt" "host" ’string "")

Variable Type	string
Default Value	NULL
Acceptable Values	Any string value

useCustomizedSimDir

Specifies the RTT simulation directory if you do not want to use the default directory, /dev/shm, or this default directory is not ready. When the value of this variable is NULL, that means the shared memory is used.

To set this variable in the .cdsinit file or CIW:

envSetVal("maestro.rtt" "useCustomizedSimDir" ’string "")

Variable Type	string
Default Value	NULL
Acceptable Values	Any string value

simulateOn

Specifies an event used to control the time lag that occurs between the change of values for variables and parameter adjustment and simulation run in RTT. By default, this variable is set to onMouseUp event, which starts the simulation when mouse button is released on slider.

To set this variable in the .cdsinit file or CIW:

envSetVal("maestro.rtt" "simulateOn" ’cyclic "onMouseUp")

Variable Type	string
Default Value	onMouseUp
Acceptable Values	onMouseUp, adaptiveDelay, and 500ms

showSimModeChangeDialog

When simulations in RTT cannot be run in interactive mode, displays a dialog in which you can choose whether you want to launch RTT or not. When this variable is set to nil, RTT is always launched irrespective of the interactive or batch mode.

To set this variable in the .cdsinit file or CIW:

envSetVal("maestro.rtt" "showSimModeChangeDialog" ’boolean t)

Variable Type	boolean
Default Value	t
Acceptable Values	t, nil

keepVariableDependency

Maintains the dependency of variable or parameters in the RTT mode, if it exists. When this variable is set to nil, the dependent values can also be tuned.

To set this variable in the .cdsinit file or CIW:

envSetVal("maestro.rtt" "keepVariableDependency" ’boolean t)

Variable Type	boolean
Default Value	t
Acceptable Values	t, nil

sliderOnMouseOver

Makes the multiple sliders visible in the RTT assistant. By default, this variable is set to t, which means slider appears only when you mouse-hover or click a variable or parameter. You can set this variable to nil to show the sliders for all the variables and parameters.

To set this variable in the .cdsinit file or CIW:

envSetVal("maestro.rtt" "sliderOnMouseOver" ’boolean t)

Variable Type	boolean
Default Value	t
Acceptable Values	t, nil

saveToMode

Controls the default option to backannotate variables and parameters from the RTT assistant to ADE Explorer and schematic from the Save back drop-down menu.

To set this variable in the .cdsinit file or CIW, use the following call:

envSetVal("maestro.rtt" "saveToMode" 'cyclic "explorer")

Variable Type	cyclic
Default Value	`explorer`
Acceptable Values	`explorer`: Updates the design variable and parameter values in the setup assistant. `schematic`: Updates the parameter values in the schematic. `explorerschematic` : Updates the values of the design variables and parameters in the setup assistant, and of the parameters in the schematic.
GUI Equivalent	Launch – Plugins – Real Time Tuning – Save back

Environment Variables

dimSameColor

Sets the color of traces in waveform info-balloons to match with the color of same traces in the ViVA Graph assistant.

Controls the color of waveforms that are previously plotted in waveform info-balloon and ViVA Graph assistant. When this variable is set to t, the color of existing waveforms becomes dimmer every time a new simulation run takes place. When this variable is set to nil, the waveforms may appear in different colors as defined in the ViVA color bank.

This variable works only for the RTT simulations.

To set this variable in the .cdsinit file or CIW:

envSetVal("viva.graph" "dimSameColor" 'string "true")

Variable Type	string
Default Value	true
Acceptable Values	true, false

dimOldTraces

Sets the color of existing traces to dim whenever a new trace is appended to the ViVA Graph window. The trace with brightest color is the most-recent trace in the graph window. When this variable is set to true, which is the default value, the colors of already existing traces in the graph are dimmer as compared to the newly-appended traces. When this variable is set to false, all the existing and new traces are displayed in the same color.

This variable works only for the RTT simulations.

To set this variable in the .cdsinit file or CIW:

envSetVal("viva.graph" "dimOldTraces" 'string "false")

Variable Type	string
Default Value	true
Acceptable Values	true, false

Example

When the variable is set to false:

When the variable is set to true:

innerSweepSwappableSizeLimit

Specifies the limit for the number of simulation points up to which the swapSweep function can be successfully run.

The swapSweep function swaps the X-axis value with the specified sweep variable. If the number of points are more than the limit specified by this variable, you need to input a particular X-axis point to be used for swapping.

To set this variable in the .cdsinit file or CIW:

envSetVal("asimenv.plotting" "innerSweepSwappableSizeLimit" 'int 500)

Variable Type	integer
Default Value	500
Acceptable Values	Any integer value greater than 0

allowSignalsExpressionInSameSubwindow

Plots signals and expressions in the same subwindow. This variable works when you select some expressions and/or signals from the results, right-click them, and choose Plot, Plot All, or quickPlotAll options. When this variable is set to t (default value), all signals and expression waveforms are plotted in a same subwindow. When this variable is set to nil, signals and expression waveforms are plotted in different subwindows.

To set this variable in the .cdsinit file or CIW:

envSetVal("asimenv" "allowSignalsExpressionInSameSubwindow" 'boolean t)

Variable Type	boolean
Default Value	t
Acceptable Values	t, nil

waveformReaderThreadCount

Specifies the number of threads that are computed by SRR while reading a parametric waveform data. The purpose of this variable is to achieve maximum throughput while loading a parametric waveform.

To set this variable in the .cdsinit file or CIW:

envSetVal("asimenv.plotting" "waveformReaderThreadCount" 'string "auto")

Variable Type	string
Default Value	auto
Acceptable Values	Any integer value

The default value, auto, indicates that number of threads are computed automatically. When you specify an integer value, it directs the SRR to start the specified number of threads. When you specify 0, it disables the SRR threading while reading the parametric data.

useQPDataToCreateDataSheet

Determines whether the quick plot data is to be used for printing waveforms in the datasheet. If this variable is set to t, the quick plot data is used for printing waveforms in the datasheet. In case the quick plot data does not exist and this variable is set to t, the quick plot data will be generated first.

If this variable is set to nil, the full waveform data is used and the Use Quickplot data option is disabled on the Create Datasheet form. The default value for this variable is t, which means quick plot data is used by default for printing waveforms in the datasheet.

To set this variable in the .cdsinit file or CIW:

envSetVal("asimenv.plotting" "useQPDataToCreateDataSheet" 'boolean t)

Variable Type	boolean
Default Value	t
Acceptable Values	t, nil

headerAlignmentSide

Controls the text alignment of the specification column headers in the Detail-Transpose view

To set this variable in the .cdsinit file or CIW:

envSetVal("adexl.gui" "headerAlignmentSide" 'string "Center")

Variable Type	string
Default Value	Center
Acceptable Values	Left, Right, Center

headerTruncationDirection

Specifies the direction along which the column header needs to be truncated. ADE Assembler, ADE Explorer, and ADE XL truncates the column header along the direction specified by this variable when this variable is used with the headerTruncationWidth variable, thus retaining the number of characters specified by headerTruncationWidth.

This variable also considers ellipses (...) while truncating the column header.

To set this variable in the .cdsinit file or CIW:

envSetVal("adexl.gui" "headerTruncationDirection" 'string "Left")

Variable Type	string
Default Value	Left
Acceptable Values	Left, Center, Right

Left	Truncates the column header from the left and leaves the characters from the right. For example, if `headerTruncationWidth` is set to 8 and `headerTruncationDirection` is set to Left, the column headers appear as shown below.
Center	Truncates the column header from the middle and leaves the characters from left and right, as shown in the example below
Right	Truncates the column header from the right and leaves the characters from the left, as shown in the example below.

headerTruncationWidth

Specifies character length of the test name that appears in the specification column headers in the Detail-Transpose view.

To set this variable in the .cdsinit file or CIW:

envSetVal("adexl.gui" "headerTruncationWidth" 'int 30)

Variable Type	integer
Default Value	24
Acceptable Values	Any positive integer

detailtransposeViewShowDefault

Specifies the default columns to be displayed in the Detail-Transpose results view.

To set this variable in the .cdsinit file or CIW:

envSetVal("adexl.gui" "detailtransposeViewShowDefault" 'string "\"Scalar Expressions\" \"Waveform Expressions\" \"Signals\" \"Corner Expressions\" \"Sweep Expressions\" \"Top Level Expressions\" \"Device Checks\" \"Test Name\" \"Fixed Parameters\"")

Variable Type

String

Default Value

"\"Scalar Expressions\" \"Waveform Expressions\" \"Signals\" \"Corner Expressions\" \"Sweep Expressions\" \"Top Level Expressions\" \"Any Expressions\" \"Device Checks\""

Acceptable Values

A space-separated list of one or more of the following types of columns:

"\"Scalar Expressions\": Shows or hides the columns that show the scalar results
\"Waveform Expressions\": Shows or hides the columns that show the waveform results
\"Signals\": Shows or hides the columns that show the scalar or waveform results of signals in the design
\"Corner Expressions\": Shows or hides the columns that display the results of outputs measured across corners
\"Sweep Expressions\": Shows or hides the columns that display the results of outputs measured across sweep points
\"Top Level Expressions\": Shows or hides the columns that display the results of outputs measured across all dimensions
\"Any Expressions\": Shows or hides the columns that display the results of outputs measured across any dimension
\"Device Checks": Shows or hides the columns that display the results of device checks
\"Test Name\": Shows or hides the test name in the column header of each output
\"Fixed Parameters\": Shows or hides the columns for the fixed parameters or variables in the left pane of the Detail-Transpose view

onHistoryNameCollision

Determines how ADE Explorer saves a history in case another history with the same name already exists. The default history names are ExplorerRun.0 for edit mode and ExplorerRORun.0.RO for read-only mode.

Variable Type	string
Default Value	"Overwrite"
Acceptable Values	"Error": ADE Explorer displays an error when the history name for the current simulation run already exists "Overwrite": ADE Explorer overwrites the history files, `ExplorerRun.0` and `ExplorerRORun.0.RO`, for every new simulation run "IncrementAsNew": ADE Explorer increments the history names for consecutive simulation runs. For example, `ExplorerRun.1`, `ExplorerRun.2`, `ExplorerRORun.1.RO`, and `ExplorerRORun.2.RO`

Important Points to Note

If you have set the adexl.historyNamePrefix showNameHistoryForm variable to t to display the Specify History Name form where you can specify a custom history name, ADE Explorer uses that name instead of ExplorerRun.0 or ExplorerRORun.0.RO. However, the rule to overwrite, increment, or show error in case of a history name conflict is decided based on the value of onHistoryNameCollision.
Related blog post: Virtuosity: Exploring Histories

CheckForNewCellviewVarsUponRun

Controls the check for new design variables before running simulations in the schematic hierarchy.

To set this variable in the .cdsenv:

adexl.test checkForNewCellviewVarsUponRun cyclic "Full"

In .cdsinit or the CIW:

envSetVal( "adexl.test" "checkForNewCellviewVarsUponRun" 'cyclic "Full")

Variable Type	cyclic
Default Value	`Full`
Acceptable Values	`"Full"` – Checks for all new design variables before running simulations. This prevents simulation errors by ensuring that the simulation is run with variables that have valid values. `"No"` – Defers the check for new variables. This improves the simulation performance when the simulation hierarchy contains large number of instances. When `checkForNewCellviewVarsUponRun` is set to `No`, new variables added in the hierarchy since the last simulation are not identified. This can result in simulation failure. `"SimInfoParameters"` – Checks for only those variables that are defined in the CDF `simInfo` section and are related to netlisting or simulation.

alwaysNameTerminalOutputs

Specifies whether to always use the _I suffix in the names of outputs that save current data.

To set this variable in .cdsinit or CIW:

envSetVal("auCore.selection" "alwaysNameTerminalOutputs" 'boolean nil)

Variable Type	boolean
Default Value	nil
Acceptable Values	`t` — Adds the _I suffix to all current type of signal outputs `nil` — Does not add the _I suffix

terminalSelectionType

Specifies the type of data–current, voltage, or both–to be saved or plotted for a terminal selected for an output.

To set this variable in .cdsinit or CIW:

envSetVal("auCore.selection" "terminalSelectionType" 'cyclic "current")

Variable Type	cyclic
Default Value	"current"
Acceptable Values	"current" — Saves only current values for the selected terminals "voltage" — Saves only voltage values for the selected terminals "both" — Saves both current and voltage values for the selected terminals "prompt" — Prompts you to select the type of output to be saved for the selected terminals
GUI Equivalent	Terminal Selection Type drop-down list on the ADE Explorer Plotting/Printing Options form

exportFormat

Specifies the format to save the results exported from ADE Explorer or ADE Assembler. You can choose to export the result values without units, values with units in separate columns, or values with units in the same column as displayed on the Results tab.

To set this variable in the .cdsenv:

adexl.results exportFormat cyclic "numbersOnly"

In .cdsinit or the CIW:

envSetVal( "adexl.results" "exportFormat" 'cyclic "numbersOnly")

Variable Type	cyclic
Default Value	"`numbersOnly`"
Acceptable Values	"`numbersOnly`" — Exports the results without units. For example, if a result value for UGF is displayed in the Results table as 8.829 MHz, its unit is not saved in the exported Excel file, as shown below. "`valuesAsInGUI`" — Exports the results with units in the same column, as shown below. "`numberAndUnit`" — Exports the result values and units in separate columns, as shown below.

Return to top

Virtuoso ADE Explorer User GuideProduct Version IC23.1, November 2023

B

Environment Variables

Simulation Environment

LBS Distributed Processing Environment

Simulator-Specific Environment Variables

Environment Variables for Distributed Processing

userDefinedJobName

Example

copyModeDir

hostMode

autoJobSubmit

bypassNetlist

hostName

startTime

mailTo

stateFile

showMessages

startDay

expTime

expDay

timeLimit

emailNotify

logsInEmail

daysBeforeExpire

block

loginShell

puttogetherqueue

copyNetlist

logsDir

mailAllLogs

logsInPsf

shellCmd

listMode

deleteJob

removeJobData

Environment Variables for Distributed Processing with LBS

lsfResourceString

selectLsfResourceString

drmsCommand

queueName

queueNameExclusionList

queueNameInclusionList

remoteShell

remoteCopy

queueName

lsfApplicationProfile

selectLsfApplicationProfile

lsfNoOfProcessors

selectLsfNoOfProcessors

sgeNoOfProcessors

sgeParallelEnvName

sgeSoftResources

sgeHardResources

sgePriority

adexl.monte

additionalNetlistOptions

Description

GUI Equivalent

Examples

applySaveOptionsToNetlist

Description

Examples

createStatisticalCornerType

Description

Examples

enableMonteCarloOverStatisticalCorners

Description

Examples

incrementalUpdate

Description

Examples

iterationUpdates

Description

Examples

minGroupSizeSplitAcrossIdleJobs

Description

Examples

numberOfPointsToview

Description

Virtuoso ADE Explorer User Guide
Product Version IC23.1, November 2023