bag.design.netlist

netlist processing utilities.

Module Contents

Classes

NetlistNode	Helper class that provides a standard way to create an ABC using
Netlist	Helper class that provides a standard way to create an ABC using
Header	Helper class that provides a standard way to create an ABC using
Instance	Helper class that provides a standard way to create an ABC using
Subcircuit	Helper class that provides a standard way to create an ABC using
Parser	Helper class that provides a standard way to create an ABC using
ParserCDL	Helper class that provides a standard way to create an ABC using
ParserSpectre	Helper class that provides a standard way to create an ABC using

Functions

guess_netlist_type(→ pybag.enum.DesignOutput)
parse_netlist(→ Netlist)
add_mismatch_offsets(→ Dict[str, Any])
add_internal_sources(→ Dict[str, Any])
_read_lines(→ List[str])	Reads the given Spectre or CDL netlist.

bag.design.netlist.guess_netlist_type(netlist_in: Union[pathlib.Path, str]) → pybag.enum.DesignOutput

bag.design.netlist.parse_netlist(netlist_in: Union[pathlib.Path, str], netlist_type: pybag.enum.DesignOutput) → Netlist

bag.design.netlist.add_mismatch_offsets(netlist_in: Union[pathlib.Path, str], netlist_out: Union[pathlib.Path, str], netlist_type: pybag.enum.DesignOutput) → Dict[str, Any]

bag.design.netlist.add_internal_sources(netlist_in: Union[pathlib.Path, str], netlist_out: Union[pathlib.Path, str], netlist_type: pybag.enum.DesignOutput, ports: List[str]) → Dict[str, Any]

class bag.design.netlist.NetlistNode

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

abstract netlist(stream: TextIO, netlist_type: pybag.enum.DesignOutput) → None

abstract netlist_with_offset(stream: TextIO, used_names: Set[str], offset_map: Dict[str, str], netlist_type: pybag.enum.DesignOutput, ports: List[str], bag_mos: Set[str], pdk_mos: Set[str]) → None

class bag.design.netlist.Netlist(header: Header, subckts: List[Subcircuit])

Bases: NetlistNode

Helper class that provides a standard way to create an ABC using inheritance.

property used_names: Set[str]

netlist(stream: TextIO, netlist_type: pybag.enum.DesignOutput) → None

netlist_with_offset(stream: TextIO, used_names: Set[str], offset_map: Dict[str, str], netlist_type: pybag.enum.DesignOutput, ports: List[str], bag_mos: Set[str], pdk_mos: Set[str]) → None

class bag.design.netlist.Header(lines: List[str])

Bases: NetlistNode

Helper class that provides a standard way to create an ABC using inheritance.

netlist(stream: TextIO, netlist_type: pybag.enum.DesignOutput) → None

netlist_with_offset(stream: TextIO, used_names: Set[str], offset_map: Dict[str, str], netlist_type: pybag.enum.DesignOutput, ports: List[str], bag_mos: Set[str], pdk_mos: Set[str]) → None

class bag.design.netlist.Instance(inst_name: str, cell_name: str, ports: List[str], params: List[str])

Bases: NetlistNode

Helper class that provides a standard way to create an ABC using inheritance.

netlist(stream: TextIO, netlist_type: pybag.enum.DesignOutput) → None

netlist_with_offset(stream: TextIO, used_names: Set[str], offset_map: Dict[str, str], netlist_type: pybag.enum.DesignOutput, ports: List[str], bag_mos: Set[str], pdk_mos: Set[str]) → None

class bag.design.netlist.Subcircuit(name: str, ports: List[str], items: List[Union[str, Instance]])

Bases: NetlistNode

Helper class that provides a standard way to create an ABC using inheritance.

property name: str

netlist(stream: TextIO, netlist_type: pybag.enum.DesignOutput) → None

netlist_with_offset(stream: TextIO, used_names: Set[str], offset_map: Dict[str, str], netlist_type: pybag.enum.DesignOutput, ports: List[str], bag_mos: Set[str], pdk_mos: Set[str]) → None

_netlist_helper(stream, netlist_type: pybag.enum.DesignOutput, fun: Callable[[NetlistNode], None]) → None

class bag.design.netlist.Parser

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

abstract classmethod is_subckt_start(line: str) → bool

abstract classmethod is_subckt_end(line: str) → bool

abstract classmethod is_comment(line) → bool

abstract classmethod parse_instance(tokens: List[str]) → Instance

classmethod parse_netlist(lines: List[str]) → Netlist

classmethod parse_header(lines: List[str], start: int, stop: int) → Header

classmethod parse_subcircuit(lines: List[str], start: int, stop: int) → Subcircuit

class bag.design.netlist.ParserCDL

Bases: Parser

Helper class that provides a standard way to create an ABC using inheritance.

prim_prefix

classmethod is_subckt_start(line: str) → bool

classmethod is_subckt_end(line: str) → bool

classmethod is_comment(line) → bool

classmethod parse_instance(tokens: List[str]) → Instance

class bag.design.netlist.ParserSpectre

Bases: Parser

Helper class that provides a standard way to create an ABC using inheritance.

classmethod is_subckt_start(line: str) → bool

classmethod is_subckt_end(line: str) → bool

classmethod is_comment(line) → bool

classmethod parse_instance(tokens: List[str]) → Instance

bag.design.netlist._read_lines(netlist: pathlib.Path) → List[str]

Reads the given Spectre or CDL netlist.

This function process line continuation and comments so we don’t have to worry about it.