CIRCT 23.0.0git
Loading...
Searching...
No Matches
Classes | Functions | Variables
simulator Namespace Reference

Classes

class  SimProcess
 
class  Simulator
 
class  SourceFiles
 

Functions

bool is_port_open (port)
 
List[str] supported_simulators ()
 
bool is_simulator_available (str name)
 
List[str] available_simulators ()
 
Simulator get_simulator (str name, SourceFiles sources, Path rundir, bool debug, bool save_waveform=False)
 

Variables

 _thisdir = Path(__file__).parent
 
 CosimCollateralDir = _thisdir
 
tuple _SUPPORTED_SIMULATORS = ("verilator", "questa")
 

Function Documentation

◆ available_simulators()

List[str] simulator.available_simulators ( )
Return the known simulator backends available in this environment.

Definition at line 52 of file simulator.py.

◆ get_simulator()

Simulator simulator.get_simulator ( str  name,
SourceFiles  sources,
Path  rundir,
bool  debug,
bool   save_waveform = False 
)

Definition at line 515 of file simulator.py.

◆ is_port_open()

bool simulator.is_port_open (   port)
Check if a TCP port is open locally.

Definition at line 21 of file simulator.py.

◆ is_simulator_available()

bool simulator.is_simulator_available ( str  name)
Return True if the requested simulator backend is usable.

This checks the executable and environment conventions used by the Python
cosim backends, so pytest callers can skip simulator-backed tests before
generating or compiling hardware collateral.

Definition at line 34 of file simulator.py.

◆ supported_simulators()

List[str] simulator.supported_simulators ( )
Return the simulator backends known to the ESI cosim runtime.

Definition at line 29 of file simulator.py.

Variable Documentation

◆ _SUPPORTED_SIMULATORS

tuple simulator._SUPPORTED_SIMULATORS = ("verilator", "questa")
protected

Definition at line 18 of file simulator.py.

◆ _thisdir

simulator._thisdir = Path(__file__).parent
protected

Definition at line 16 of file simulator.py.

◆ CosimCollateralDir

simulator.CosimCollateralDir = _thisdir

Definition at line 17 of file simulator.py.