simetrix¶

SIMetrix and SIMetrix/SIMPLIS Python Support¶

Provides a Python interface to the SIMetrix/SIMPLIS application.

Subpackages¶

script.functions: Implementation of all SIMetrix script functions. See simetrix.script.functions
script.commands: Implementation of all SIMetrix script commands. See simetrix.script.commands
dvm: Design Verificaton Module (DVM) functionality. See simetrix.dvm

Functions

`currentGraph`()	Returns the currently active graph.
`currentGroup`()	Returns the current DataGroup object.
`currentSchematic`()	Returns the currently active schematic.
`getSchematicFromHandle`(handle)	Returns a Schematic object with the given handle.
`graphs`()	Returns a list of open `Graph` objects
`groups`()	Returns all DataGroup objects.
`newGraph`(title)	Creates a new graph sheet and returns a `PlotReturnData` object providing the X `Axis`, Y `Axis` and `Grid` objects.
`openSchematic`(path[, options])	Opens a schematic from a path and returns a Schematic object.
`plotData`(ydata, xdata, ylabel, xlabel[, ...])	Creates a SIMetrix graph from the given X & Y data.
`plotVector`(vector[, ylabel, xlabel, yunit, ...])	Creates a SIMetrix graph from the given X & Y data.
`processEvents`()	Processes the GUI event loop and tests for an abort request.
`schematics`()	Returns a list of schematics currently open in the GUI.
`ver`()

Classes

`AbstractDataVector`()	Deprecated.
`AbstractXYDataVector`()	Deprecated.
`AnalysisEnable`(*values)	Enable/disable an analysis line.
`AnalysisType`(*values)	Defines a simulation analysis type.
`Axis`()	Represents an axis within a `Graph`.
`AxisOptions`(*values)	Enum for specifying logarithmic or linear axis options.
`BoundsOptions`(*values)	Options for `Element.bounds()` method.
`ComplexDataVector`()	Deprecated.
`ComplexXYDataVector`()	Deprecated.
`Curve`(obj)	Represents a curve within a Graph.
`CurveData`(obj)	Associated with SIMetrix CurveData object.
`DataGroup`()	Reference to a SIMetrix data group.
`DescendHierarchyItem`()	Return value from `Schematic.descendHierarchy()`
`Element`()	Represents any schematic object.
`ElementType`(*values)	Type of Schematic `Element`
`FileForensic`(*values)	Code indication reason for file open failure.
`Graph`()	Represents a graph.
`GraphObject`()	Base class for objects contained within a Graph.
`GraphObjectType`(*values)	Flag for specifying the type for a `GraphObject`.
`GraphProperty`()	Property for a `GraphObject`.
`GraphPropertyType`(*values)	Data type of a `GraphProperty`.
`Grid`()	Represents a grid within a `Graph`.
`GridOptions`(*values)	Enum for specifying options for creating a new Graph grid.
`GroupVector`([groupName, vectorName])	The GroupVector class is the main class used to access SIMetrix and SIMPLIS simulation data.
`GroupVectorDivision`()	Provides access to a single division of a `GroupVector`.
`HierarchyRef`()	Reference to a hierarchy item.
`HierarchyReferenceType`(*values)	Access method for hierarchy references.
`InstanceOrientation`(*values)	Defines the orientation of a schematic instance.
`InstancePin`()	Represents a pin of a schematic Instance.
`InstancePosition`()	Class used to define the location and orientation of a schematic instance.
`LegacyCurveData`()	Deprecated, for new code see `CurveData`.
`LocationOptions`(*values)	Relative or absolute location option.
`ModelParseMode`(*values)	Parse option for methods that return model lines, for example `Schematic.getF11Lines()`.
`NetlistReturn`()	Return data from `Schematic.netlist()` method.
`NumericValueType`(*values)	Deprecated.
`PathOptions`(*values)	Options for path names such as names for hierarchical objects.
`PhysicalType`(*values)	Enum describes a data item's physical type, for example, Volts, Amps etc.
`Pin`()	Class defines a pin of a schematic instance.
`PlotReturnData`()	Object returned by the following methods to report new objects created: `plotData()` `newGraph()` `Graph.newGrid()` `Grid.plotData()` `Grid.plotVector()`
`Point`()	Class defines a point on a schematic in X-Y coordinates.
`ProgressBox`(numSteps, displayMessage, ...[, ...])	Intended to be used with Python's `with` statement, this class manages a progress box used to display the progress of an operation.
`ProgressBoxAbortMethod`(*values)	Abort method for `ProgressBox` object
`Property`()	Data structure representing a property used by `Schematic` and `Element` objects.
`RealDataVector`()	Deprecated.
`RealXYDataVector`()	Deprecated.
`Rect`()	Class defines a rectangle.
`RunStatus`(*values)
`Schematic`()	Represents a schematic.
`SchematicOptions`(*values)	Options for `Schematic` methods.
`SchematicStatus`(*values)	Status return value for some schematic methods.
`SelectionOptions`(*values)	Options used by functions that return information about selected items.
`SetComponentValueResult`()	Return value from `SetComponentValue()` and `GetComponentValue()` methods.
`SetComponentValueStatus`(*values)	Status values for `SetComponentValue()` and `GetComponentValue()`.
`SimetrixDataType`(*values)	Defines data types for objects returned from GroupVector methods.
`Simulation`()	Object returned by methods that perform a simulation.
`Simulator`(*values)	Defines a simulator type.
`TitleBlockInfo`()	Return data from `Schematic.getTitleBlockInfo()` method.
`VectorData`()	Basic object to access `GroupVector` data.
`Version`()	Program version information.

Modules

`dvm`	Design Verification Module (DVM) - (simetrix.dvm)
`script`	simetrix.script