Vlsir Tools

Python-based tools and utilites for working with the Vlsir IC design schema.

Netlisting

FIXME! Details here.

Spice-Class Simulation

VlsirTools includes drivers and result-parsers for popular spice-class simulation engines including:

class SupportedSimulators(Enum):
    """Enumerated, Internally-Defined Spice-Class Simulators"""

    SPECTRE = "spectre"
    XYCE = "xyce"
    NGSPICE = "ngspice"

The primary entry-point for simulation is vlsirtools.spice.sim. By default, sim runs your chosen simulator in parallel over the list of SimInputs provided as inp.

def sim(
    inp: OneOrMore[vsp.SimInput], opts: Optional[SimOptions] = None
) -> OneOrMore[SimResultUnion]:

The sim function takes as input one or more vlsir.spice.SimInputs and a set of simulation options (vlsirtools.spice.SimOptions), and returns one of two result-types depending on its input options.

class ResultFormat(Enum):
    """Enumerated Result Formats"""

    SIM_DATA = "sim_data" 
    VLSIR_PROTO = "vlsir_proto" 

The VLSIR_PROTO result-format returns a vlsir.spice.SimResult object, which is a protobuf-encoded representation of the simulation results. The SIM_DATA format instead uses the types defined in vlsirtools.spice.sim_data, a python-native combination of dataclasses and numpy arrays. The former is generally more convenient for sharing with other programs, and the latter for further in-Python processing.

Simulator and Analysis Support

Each spice-class simulator includes its own netlist syntax and opinions about the specification for analyses. The vlsir.spice schema