simInitEnvWithArgs

simInitEnvWithArgs( 
t_runDirName 
t_libName | nil
t_cellName | nil
t_viewName | nil
t_simulatorName | nil
g_forceInit
) 
=> t / nil 

Description

Initializes the simulation environment within the Cadence graphics environment. In addition to defining the SKILL environment needed for SE and the target application, the run directory is created and initialized as needed.

Arguments

t_runDirName	The name of the simulation run directory to use.
t_libName	The name of the library containing the top-level cellview of the design to be analyzed.
t_cellName	The cell name of the top-level cellview of the design to be analyzed.
t_viewName	The view name of the top-level cellview of the design to be analyzed.
t_simulatorName
	The name of the analysis tool to use.
g_forceInit	If the function returns t, and the specified run directory exists but is not initialized, the run directory is initialized with the specified parameters. If the function returns nil, there is an error.

The arguments can be used to overwrite the simulation environment variables. If the run directory exists, all arguments except for t_runDirName can be nil. The contents of the run directory are then used to initialize the environment.

The si.env file is used to initialize a run directory for storing the values of the simulation environment variables. The arguments above can be used to change the simulation environment variables before the run directory is initialized. The arguments are processed according to the following rules:

• If the specified run directory does not already exist, the argument is not used, and the current graphics environment library path is stored in the new run directory.
• If t_simulatorName is not nil, assign it to the simSimulator environment variable.
• If t_libName is not nil, assign it to the simLibName environment variable.
• If t_cellName and t_viewName are not nil, assign them to the simCellName and simViewName environment variables, respectively.

Therefore, the t_libName argument cannot be nil if the t_cellName or t_viewName arguments are used (not nil).

If the si.env file exists in the run directory, it is loaded first, followed by the steps above. This will override what is stored in the run directory. Otherwise, the steps above are applied first, and the si.env file is created. Therefore, it is important that you determine the existence of the run directory before calling the simInitEnvWithArgs function. Parameters should be passed in if the directory does not exist, but should normally not be passed if it does exist.

Value Returned

t	The command is successful.
nil	The command was unsuccessful.

Examples

simInitEnvWithArgs( "/mnt/dave/chip1/spice.run1"
"myLib" "fast_mux" "schematic"
"spice" nil ) 

simInitEnvWithArgs(    "/mnt/user1/chip1/spice.run1"
nil nil nil nil nil ) 

Related Topics

OSS Functions

Return to top