SpiceParser.build_circuit() does not build subcircuits

[jimzenn]

Environment (OS, Python version, PySpice version, simulator)

OS: Linux zealoft 5.11.0-1006-gcp #6-Ubuntu SMP Wed Apr 14 21:09:18 UTC 2021 x86_64 x86_64 x86_64 GNU/Linux
Python version: 3.9.4
PySpice version: 1.4.3
Simulator: ngSpice

Related Code

class ParallelResistor2(SubCircuit):
    __nodes__ = ('n1', 'n2')
    def __init__(self, name, R1=1@u_Ω, R2=2@u_Ω):
        SubCircuit.__init__(self, name, *self.__nodes__)
        self.R(1, 'n1', 'n2', R1)
        self.R(2, 'n1', 'n2', R2)

circuit = Circuit('Test')
circuit.subcircuit(ParallelResistor2('pr1', R2=2@u_Ω))
circuit.X('1', 'pr1', 1, circuit.gnd)
circuit.subcircuit(ParallelResistor2('pr2', R2=3@u_Ω))
circuit.X('2', 'pr2', 1, circuit.gnd)

source = str(circuit)

parser = SpiceParser(source=source)
bootstrap_circuit = parser.build_circuit()
bootstrap_source = str(bootstrap_circuit)

print(bootstrap_source)

assert bootstrap_source == source

Expected Behaviour

.title Test
.subckt pr1 n1 n2
R1 n1 n2 1Ohm
R2 n1 n2 2Ohm
.ends pr1

.subckt pr2 n1 n2
R1 n1 n2 1Ohm
R2 n1 n2 3Ohm
.ends pr2
X1 1 0 pr1
X2 1 0 pr2

Actual Behaviour

.title Test
X1 1 0 pr1
X2 1 0 pr2

It seems this feature is not implemented?

https://github.com/FabriceSalvaire/PySpice/blob/e459acbad6adac20d73a82dce324fb94efefa1ce/PySpice/Spice/Parser_jmgc.py#L1440

[Bigbadboybob]

Bump

[dontillman]

Hi.

I'm having the same problem; the build_circuit() operation is completely ignoring subcircuits.

I think I see what's going on... It appears to be testing the wrong class of subcircuit statements.

You can patch it in place and get work done:

diff PySpice/Spice/Parser.py~ PySpice/Spice/Parser.py
1008c1008
<             elif isinstance(statement, SubCircuit):
---
>             elif isinstance(statement, SubCircuitStatement):

I'm unfamiliar with PySpice development customs and protocols, so it would be great if someone could patch this in for us. Thanks!

-- Don

[0range0range]

Hello,

Still not clear how to do it. Latest commit on devel also does not allow old way of import:

from PySpice.Spice.Parser import SpiceParser # does not work

from PySpice.Spice.Parser.Parser import SpiceParser # works

I am not sure if second way is a desired way.

But if importring with second way SpiceParser constructor does not have path= parameter anymore, also no source=. Not fully clear how to pass existing ngspice netlists.

What is the plan with it? I could help implement it, if it will be accepted eventually.

[Kreijstal]

ahh spiceparser is probably kinda shit

[tapegoji]

Checkout my development branch of PySpice. It can handle many cases. Even skywater pdk can be run with pyspice now.

I am not sure in subcircuit but I can fix it if still is an issue. Try it and let me know

[Kreijstal]

Checkout my development branch of PySpice. It can handle many cases. Even skywater pdk can be run with pyspice now.

I am not sure in subcircuit but I can fix it if still is an issue. Try it and let me know

tbh your development branch has lots of directories hardcoded on your home drive

[tapegoji]

really? only some of the examples, I thought. Is there any specific one that is causing issue?

[Kreijstal]

also consider opening issues on your fork

[0range0range]

Hi @tapegoji

Checkout my development branch of PySpice. It can handle many cases. Even skywater pdk can be run with pyspice now.

I am not sure in subcircuit but I can fix it if still is an issue. Try it and let me know

I tried on your development branch, but the issue persists. It is the same problem as in original post. Instances of subcirucits are being parsed, but not the actual subcircuit definition.

General question is: what is the state of the project? I see that your development pull request already diverged from master. Will it be developed further? I could help with some issues, but of course if noone is merging, then...

[tapegoji]

Fabrice, seems to not have enough time to work on it. He might be working on it. I am not sure. Or the project is left abandoned. it might be dead. I plan to work on this and fix the bugs for my own needs.

Let me see what is going on. It appears that build_circuit is no longer in the SpiceParse. SpiceParse has been completely re-written.

[tapegoji]

There is a temp fix for it now. look into the example/spice-parser/parse-subcircuit-example.py

`
import PySpice.Logging.Logging as Logging
logger = Logging.setup_logging()

####################################################################################################

from PySpice import Circuit, SubCircuit, SubCircuitFactory
from PySpice.Spice.Parser.HighLevelParser import SpiceSource
from PySpice.Spice.Parser import Translator
from PySpice.Unit import *

class ParallelResistor2(SubCircuit):
nodes = ('n1', 'n2')
def init(self, name, R1=1@u_Ω, R2=2@u_Ω):
SubCircuit.init(self, name, *self.nodes)
self.R(1, 'n1', 'n2', R1)
self.R(2, 'n1', 'n2', R2)

circuit = Circuit('Test')
circuit.R('1', 'input', 'n1', 1@u_Ω)
circuit.subcircuit(ParallelResistor2('pr1', R2=2@u_Ω))
circuit.X('1', 'pr1', 1, circuit.gnd)
circuit.subcircuit(ParallelResistor2('pr2', R2=3@u_Ω))
circuit.X('2', 'pr2', 1, circuit.gnd)

source = str(circuit)
print(circuit)

spice_source = SpiceSource(source=source, title_line=False)
bootstrap_circuit = Translator.Builder().translate(spice_source)
bootstrap_source = str(bootstrap_circuit)

print(bootstrap_source)

assert bootstrap_source == source
`

[Kreijstal]

@tapegoji if I understand this corerectly. you conver this to spice, then convert it back to circuit, this is undesirable, I'd like to use the pyspice api as it was, without going through this hacks. Otherwise I'd just use spice without pyspice...

[0range0range]

There is a temp fix for it now. look into the example/spice-parser/parse-subcircuit-example.py

` import PySpice.Logging.Logging as Logging logger = Logging.setup_logging()

####################################################################################################

from PySpice import Circuit, SubCircuit, SubCircuitFactory from PySpice.Spice.Parser.HighLevelParser import SpiceSource from PySpice.Spice.Parser import Translator from PySpice.Unit import *

class ParallelResistor2(SubCircuit): nodes = ('n1', 'n2') def init(self, name, R1=1@u_Ω, R2=2@u_Ω): SubCircuit.init(self, name, *self.nodes) self.R(1, 'n1', 'n2', R1) self.R(2, 'n1', 'n2', R2)

circuit = Circuit('Test') circuit.R('1', 'input', 'n1', 1@u_Ω) circuit.subcircuit(ParallelResistor2('pr1', R2=2@u_Ω)) circuit.X('1', 'pr1', 1, circuit.gnd) circuit.subcircuit(ParallelResistor2('pr2', R2=3@u_Ω)) circuit.X('2', 'pr2', 1, circuit.gnd)

source = str(circuit) print(circuit)

spice_source = SpiceSource(source=source, title_line=False) bootstrap_circuit = Translator.Builder().translate(spice_source) bootstrap_source = str(bootstrap_circuit)

print(bootstrap_source)

assert bootstrap_source == source `

Hi,

Thanks a lot, it did work on development branch! (pip install git+https://github.com/tapegoji/PySpice@development)

I got some warning at this line: spice_source = SpiceSource(source=source, title_line=False)

WARNING: Token 'STRING' defined, but not used
WARNING: There is 1 unused token
Generating LALR tables
WARNING: 57 shift/reduce conflicts
WARNING: 1 reduce/reduce conflict
WARNING: reduce/reduce conflict in state 58 resolved using rule (expression_list_space -> expression)
WARNING: rejected rule (expression_list_comma -> expression) in state 58

I do not know what they mean / if they are relevant

[0range0range]

Unfortunately when parsing circuit of interest another error occured:

2025-04-17 13:04:03,200 - PySpice.Spice.Parser.Parser.SpiceParser.p_error - ERROR - Syntax error at ','

---------------------------------------------------------------------------
NameError                                 Traceback (most recent call last)
File ......venvs/ngspice-python-export/lib/python3.13/site-packages/PySpice/Spice/Parser/HighLevelParser.py:1084, in SpiceSource.parse(self)
   1083 try:
-> 1084     ast = self._parser.parse(line.command)
   1085     self._ast_lines.append(ast)

File ......Python/venvs/ngspice-python-export/lib/python3.13/site-packages/PySpice/Spice/Parser/Parser.py:587, in SpiceParser.parse(self, line)
    586 # self._parser.defaulted_states = {}
--> 587 return self._parser.parse(line, lexer=self._lexer, debug=False)

File ......Python/venvs/ngspice-python-export/lib/python3.13/site-packages/ply/yacc.py:333, in LRParser.parse(self, input, lexer, debug, tracking, tokenfunc)
    332 else:
--> 333     return self.parseopt_notrack(input, lexer, debug, tracking, tokenfunc)

File ......Python/venvs/ngspice-python-export/lib/python3.13/site-packages/ply/yacc.py:1201, in LRParser.parseopt_notrack(self, input, lexer, debug, tracking, tokenfunc)
   1200 self.state = state
-> 1201 tok = call_errorfunc(self.errorfunc, errtoken, self)
   1202 if self.errorok:
   1203     # User must have done some kind of panic
   1204     # mode recovery on their own.  The
   1205     # returned token is the next lookahead

File ......Python/venvs/ngspice-python-export/lib/python3.13/site-packages/ply/yacc.py:192, in call_errorfunc(errorfunc, token, parser)
    191 _restart = parser.restart
--> 192 r = errorfunc(token)
    193 try:

File ......Python/venvs/ngspice-python-export/lib/python3.13/site-packages/PySpice/Spice/Parser/Parser.py:499, in SpiceParser.p_error(self, p)
    498     self._logger.error(f"Syntax error at '{p.value}'")
--> 499     raise NameError('Syntax Error')
    500 else:

NameError: Syntax Error

During handling of the above exception, another exception occurred:

ParseError                                Traceback (most recent call last)
Cell In[26], line 1
----> 1 parser1 = SpiceSource(source=source_divider, title_line=False)

File  .....Python/venvs/ngspice-python-export/lib/python3.13/site-packages/PySpice/Spice/Parser/HighLevelParser.py:983, in SpiceSource.__init__(self, source, title_line)
    981 self.reset()
    982 if source is not None:
--> 983     self.parse_string(source, title_line)

File ......Python/venvs/ngspice-python-export/lib/python3.13/site-packages/PySpice/Spice/Parser/HighLevelParser.py:1180, in SpiceSource.parse_string(self, source, title_line)
   1178 generator = enumerate(source.splitlines())
   1179 self.read(generator, title_line)
-> 1180 self._parse()

File ......Python/venvs/ngspice-python-export/lib/python3.13/site-packages/PySpice/Spice/Parser/HighLevelParser.py:1172, in SpiceSource._parse(self)
   1171 def _parse(self) -> None:
-> 1172     self.parse()
   1173     self.analyse()

File ......Python/venvs/ngspice-python-export/lib/python3.13/site-packages/PySpice/Spice/Parser/HighLevelParser.py:1088, in SpiceSource.parse(self)
   1086     self._logger.debug(os.linesep + str(ast.pretty_print()))
   1087 except NameError as e:
-> 1088     raise ParseError(str(e))

ParseError: Syntax Error

Here is the source of the circuit:

* Qucs 25.1.1  ...
.INCLUDE "/usr/share/qucs-s/xspice_cmlib/include/ngspice_mathfunc.inc"

.SUBCKT SpiceOpamp_LM358 	gnd 1 2 3 4 5
*
C1   11 12 5.544E-12
C2    6  7 20.00E-12
DC    5 53 DX
DE   54  5 DX
DLP  90 91 DX
DLN  92 90 DX
DP    4  3 DX
EGND 99  0 POLY(2) (3,0) (4,0) 0 .5 .5
FB    7 99 POLY(5) VB VC VE VLP VLN 0 15.91E6 -20E6 20E6 20E6 -20E6
GA    6  0 11 12 125.7E-6
GCM   0  6 10 99 7.067E-9
IEE   3 10 DC 10.04E-6
HLIM 90  0 VLIM 1K
Q1   11  2 13 QX
Q2   12  1 14 QX
R2    6  9 100.0E3
RC1   4 11 7.957E3
RC2   4 12 7.957E3
RE1  13 10 2.773E3
RE2  14 10 2.773E3
REE  10 99 19.92E6
RO1   8  5 50
RO2   7 99 50
RP    3  4 30.31E3
VB    9  0 DC 0
VC 3 53 DC 2.100
VE   54  4 DC .6
VLIM  7  8 DC 0
VLP  91  0 DC 40
VLN   0 92 DC 40
.MODEL DX D(IS=800.0E-18)
.MODEL QX PNP(IS=800.0E-18 BF=250)
.ENDS
  
.SUBCKT Power_amp_arduino_subscheme Vout gnd Vin VCC 
QX2N2222A_1 VCC Vopamp Vout QMOD_X2N2222A_1 AREA=1
.MODEL QMOD_X2N2222A_1 npn (Is=14.34F Nf=1 Nr=1 Ikf=0.2847 Ikr=0 Vaf=74.03 Var=0 Ise=14.34F Ne=1.307 Isc=0 Nc=2 Bf=255.9 Br=6.092 Rbm=0 Irb=0 Rc=1 Re=0 Rb=10 Cje=22.01P Vje=0.75 Mje=0.377 Cjc=7.306P Vjc=0.75 Mjc=0.3416 Xcjc=1 Cjs=0 Vjs=0.75 Mjs=0 Fc=0.5 Tf=411.1P Xtf=3 Vtf=0 Itf=0.6 Tr=46.91N Kf=0 Af=1 Ptf=0 Xtb=1.5 Xti=3 Eg=1.11 Tnom=26.85 )
RG 0 _net2  100K
XOP1 0  Vin _net2 VCC 0 Vopamp SpiceOpamp_LM358
Rf _net2 Vout  1K 
RG1 Vin 0  100K
.ENDS
Rsh Vin _net0  1K
V2 VCC 0 DC 8
V4 Vin 0 DC 2
XSUB1 _net4 0 _net0 VCC Power_amp_arduino_subscheme
QX2N2222A_1 _net5 Vbase 0 QMOD_X2N2222A_1 AREA=1
.MODEL QMOD_X2N2222A_1 npn (Is=14.34F Nf=1 Nr=1 Ikf=0.2847 Ikr=0 Vaf=74.03 Var=0 Ise=14.34F Ne=1.307 Isc=0 Nc=2 Bf=255.9 Br=6.092 Rbm=0 Irb=0 Rc=1 Re=0 Rb=10 Cje=22.01P Vje=0.75 Mje=0.377 Cjc=7.306P Vjc=0.75 Mjc=0.3416 Xcjc=1 Cjs=0 Vjs=0.75 Mjs=0 Fc=0.5 Tf=411.1P Xtf=3 Vtf=0 Itf=0.6 Tr=46.91N Kf=0 Af=1 Ptf=0 Xtb=1.5 Xti=3 Eg=1.11 Tnom=26.85 )
VIb _net4 OutV DC 0
Rsh2 Vbase OutV  1K

.endc
.END

is it related to this line: EGND 99 0 POLY(2) (3,0) (4,0) 0 .5 .5?

[Kreijstal]

exactly, the parser has lots of errors, therefore it is undesirable to convert the circuit to spice then parse it, we dont want to parse it we want to simulate it, and parser just means throwing errors... therefore the previous method was better