report_sim_env - 2025.1 English - UG835

Vivado Design Suite Tcl Command Reference Guide (UG835)
Document ID
UG835
Release Date
2025-06-16
Version
2025.1 English

Print simulator environment settings for the current target simulator

Syntax

report_sim_env [‑version] [‑file <arg>] [‑quiet] [‑verbose]

Returns

Message

Usage

Name Description
[-version] Print supported simulator/GCC version for the current Vivado release
[-file] Write the report to the specified file
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution

Categories

Description

This command prints simulation environment settings for the current target simulator. It extracts simulation settings from the OS shell/Tcl console environment and prints the information in the Tcl console. The settings include simulator/GCC version, simulator and GNU tools path, simulator specific environment variables, and simulation compiled library information. The command also performs certain validation checks to ensure that the current settings are aligned for running simulation.

The command determines the following:
  • Simulator version based on the settings and reports status as VALID or INVALID depending on the detected version match with the offical simulator version supported for the current Vivado release
  • Simulator GCC version and report the status
  • Simulator and GNU tools path from the PATH environment variable.
The command prints the following:
  • Value of the simulator settings based on the simulator type:environment variable.
    • ModelSim Questa: MODELTECH
    • Xcelium: CDS_INST_DIR, CDS_LICENSE_DIR
    • VCS: VCS_HOME, VG_GNU_PACKAGE
  • Compiled library path using the project setting and performs the validation checks like empty directory, simulator/GCC version that was used to compile the library
  • Other miscellaneous information, for example, simulation top, current simulation fileset, simulation run mode, and design compile mode.

Arguments

-version - (Optional) Print supported simulator/GCC version and OS platform in the current Vivado release.

-file <arg> - (Optional) Write the report to the specified file. The specified file is overwritten if one already exists.

-quiet - (Optional) Execute the command quietly, returning no messages from the command. The command also returns TCL_OK regardless of any errors encountered during execution.
Note: Any errors encountered on the command-line, while launching the command, will be returned. Only errors occurring inside the command will be trapped.
-verbose - (Optional) Temporarily override any message limits and return all messages from this command.
Note: Message limits can be defined with the set_msg_config command.

Examples

The following example reports the simulator environment of the current project:

report_sim_env

See Also