I read raw netlist text and let you include that in your circuit.

If you construct me with a file path, I will read netlist text from that file and use it as my netlist. In that mode, I do exactly what the Ngspice .INCLUDE statement does, with raw, unparsed netlist text.

You can also specify the file path in a subclass with the circuitFile class attribute.

With no constructor argument and no circuitFile attribute, I use the docstring of your subclass as my raw netlist content. Don't worry about indentation; all that is stripped out because there is no such thing in SPICE format.

Yet another option is for you to set the rawLines attribute of your instance of me to a list of raw text lines.

In all cases, the first line is not disregarded.

It makes no sense to write your own setup method for me, and doing so will disable my internal setup process.

Method

__init__

Undocumented

Inherited from NodeStuff:

Instance Variable	shunts	A dict of current sensing V elements with the pairs of nodes they connect.
Class Variable	debug	A `Bag` that gets set `True` for all instances to log info about each `setup` call.
Class Method	autoName	Undocumented
Method	setupResults	Undocumented
Method	fill	Undocumented
Method	nodeCheck	Call with the circuit building tool f and a sequence of nodes provided to this `Include` or `Subcircuit`.
Method	setup	Included or subcircuit setup. You'll usually override this in a subclass.
Method	rawNetlist	Get lines of a raw netlist from a search hierarchy of possible sources.
Method	shunt	Call to insert a current-measuring shunt and add an entry to my `Elements` baton's dict of shunts.
Method	raw	See `Elements.raw`.
Method	iNode	See `Elements.iNode`.
Method	ground	See `Elements.ground`.
Method	sca	See `Elements.sca`.
Method	sca6	See `Elements.sca6`.
Class Method	_libDir	Undocumented
Method	_strippedLines	Undocumented
Method	_call_setup	Calls my `setup` method (almost always your override of that method, actually) and processes any return value.

def __init__(self, f, circuitFile=None):

Undocumented

API Documentation for pingspice, generated by pydoctor at 2021-09-18 08:41:11.

pingspice.circuit.netlist.RawInclude(NodeStuff) class documentation

`pingspice.circuit.netlist.RawInclude(NodeStuff)` class documentation