circuit-json-to-spice 0.0.1

package/docs/SPICE_SUMMARY.txt

@@ -0,0 +1,248 @@
+> From http://www.ecircuitcenter.com/SPICEsummary.htm
+
+BRIEF SPICE SUMMARY
+Here's a brief reference of the SPICE devices and statements. Parameters enclosed by braces { } are required, while, those in brackets [ ] are optional. Parameters followed by an asterisk { }\* should be repeated as necessary. Each SPICE vendor may have other parameters or commands unique to their version of SPICE. (For more information see Books on SPICE)
+
+DEVICES
+
+C device - Capacitor.
+C{name} {+node} {-node} [{model}] {value} [IC={initial}]
+Examples:
+CLOAD 15 0 20pF
+CFDBK 3 33 CMOD 10pF IC=1.5v
+
+D device - Diode.
+D{name} {+node} {-node} {model} [area]
+Examples:
+DCLAMP 14 0 DMOD
+
+I device - Current Source.
+I{name} {+node} {-node} [[DC] {value}] [AC {mag} [{phase}]]
+Examples:
+IBIAS 13 0 2.3mA
+IAC 2 3 AC .001
+IPULSE 1 0 PULSE(-1mA 1mA 2ns 2ns 2ns 50ns 100ns)
+I3 26 77 AC 1 SIN(.002 .002 1.5MEG)
+See Input Sources for PULSE, SIN and more.
+Top ↑
+J device - Junction FET.  
+ J{name} {d} {g} {s} {model} [{area]}  
+ Examples:
+JIN 100 1 0 JFAST
+
+K device - Inductor Coupling.  
+ K{name} L{name} { L{name} }\* {coupling}
+Examples:
+KTUNED L3OUT L4IN .8
+KXFR1 LPRIM LSEC .99
+
+L device - Inductor.  
+ L{name} {+node} {-node} [model] {value} [IC={initial}]  
+ Examples:
+LLOAD 15 0 20mH
+L2 1 2 .2e-6
+LSENSE 5 12 2uH IC=2mA
+
+M device - MOSFET.  
+ M{name} {d} {g} {s} {sub} {mdl} [L={value}] [W={value}] + [AD={value}] [AS={value}] + [PD={value}] [PS={value}] + [NRD={value}] [NRS={value}]
+
+    Examples:
+    M1  14  2  13  0 PNOM L=25u W=12u
+    M13 15  3   0  0 PSTRONG
+
+Q device - Bipolar Transistor.  
+ Q{name} {c} {b} {e} [{subs}] {model} [{area}]  
+ Examples:
+Q1 14 2 13 PNPNOM
+Q13 15 3 0 1 NPNSTRONG 1.5
+
+R device - Resistor.  
+ R{name} {+node} {-node} [{model}] {value}  
+ Examples:
+RLOAD 15 0 2k
+
+S device - Voltage-Controlled Switch.  
+ S{name} {+node} {-node} {+control} {-control} {model}
+Examples:
+S12 13 17 2 0 SMOD
+
+T device - Transmission Line.  
+ T{name} {A+} {A-} {B+} {B-} Z0={value}
+[TD={val} | F={val}[NL={val}]]
+Examples:
+T1 1 2 3 4 Z0=220 TD=115ns
+T2 1 2 3 4 Z0=50 F=5MEG NL=0.5
+
+V device - Voltage Source.  
+ V{name} {+node} {-node} [[DC] {value}] [AC {mag} [{phase}]]
+Examples:
+VBIAS 13 0 2.3mV
+VAC 2 3 AC .001
+VPULSE 1 0 PULSE(-1mV 1mV 2ns 2ns 2ns 50ns 100ns)
+V3 26 77 AC 1 SIN(.002 .002 1.5MEG)
+See Input Sources for PULSE, SIN and more.
+
+X device - Subcircuit Call.  
+ X{name} [{node}]\* {subcircuit name}
+Examples:
+X12 100 101 200 201 DIFFAMP
+Top ↑
+
+CONTROLLED SOURCES
+E device - Voltage Controlled Voltage Source VCVS.
+E{name} {+node} {-node} {+cntrl} {-cntrl} {gain}
+E{name} {+node} {-node} POLY({value}) {{+cntrl} {-cntrl}}_ {{coeff}}_
+Examples:
+EBUFF 1 2 10 11 1.0
+EAMP 13 0 POLY(1) 26 0 500
+
+F device - Current Controlled Current Source CCCS.  
+ F{name} {+node} {-node} {vsource name} {gain}  
+ Examples:
+FSENSE 1 2 VSENSE 10.0
+
+G device - Voltage Controlled Current Source VCCS.  
+ G{name} {+node} {-node} {+control} {-control} {gain}
+Examples:
+GBUFF 1 2 10 11 1.0
+H device - Current Controlled Voltage Source CCVS.  
+ H{name} {+node} {-node} {vsource name} {gain}
+H{name} {+node} {-node} POLY({value}) { {vsource name} }_ {{coeff}}_
+Examples:
+HSENSE 1 2 VSENSE 10.0
+HAMP 13 0 POLY(1) VIN 500
+Top ↑
+
+    INPUT SOURCES
+
+EXPONENTIAL
+EXP( {v1} {v2} {trise_delay} {tau_rise} {tfall_delay} {tau_fall) )
+PULSE
+PULSE( {v1} {v2} {tdelay} {trise} {tfall} {width} {period} )
+PIECE WISE LINEAR
+PWL( {time1} {v1} {time2} {v2} ... {time3} {v3} )
+SINGLE FREQUENCY FM
+SFFM( {voffset} {vpeak} {fcarrier} {mod_index} {fsignal} )
+SINE WAVE
+SIN( {voffset} {vpeak} {freq} {tdelay} {damp_factor} {phase} )
+Top ↑
+
+ANALOG BEHAVIORAL MODELING
+VALUE
+E|G{name} {+node} {-node} VALUE {expression}
+Examples:
+GMULT 1 0 VALUE = { V(3)*V(5,6)*100 }
+ERES 1 3 VALUE = { I(VSENSE)\*10K }
+
+TABLE
+E|G{name} {+node} {-node} TABLE {expression} = (invalue, outvalue)_
+Examples:
+ECOMP 3 0 TABLE {V(1,2)} = (-1MV 0V) (1MV, 10V)
+LAPLACE
+E|G{name} {+node} {-node} LAPLACE {expression} {s expression}
+Examples:
+ELOPASS 4 0 LAPLACE {V(1)} {10 / (s/6800 + 1)}
+FREQ
+E|G{name} {+node} {-node} FREQ {expression} (freq, gain, phase)_
+Examples:
+EAMP 5 0 FREQ {V(1)} (1KZ, 10DB, 0DEG) (10KHZ, 0DB, -90DEG)
+
+STATEMENTS
+
+.AC - AC Analysis.  
+ .AC [LIN][OCT][DEC] {points} {start} {end}  
+ Examples:
+.AC LIN 101 10Hz 200Hz
+.AC DEC 20 1MEG 100MEG
+
+.DC - DC Analysis.
+.DC [LIN] {varname} {start} {end} {incr}
+.DC [OCT][DEC] {varname} {start} {end} {points}
+Examples:
+.DC VIN -.25 .25 .05
+.DC LIN I2 5mA -2mA 0.1mA VCE 10V 15V 1V
+
+.FOUR - Fourier Analysis.  
+ .FOUR {freq} {output var}\*  
+ Examples:
+.FOUR 10KHz v(5) v(6,7)
+
+.IC - Initial Transient Conditions.  
+ .IC { {vnode} = {value} }\*  
+ Examples:
+.IC V(2)=3.4 V(102)=0
+
+.MODEL – Device Model.  
+ .MODEL {name} {type}
+Typename Devname Devtype
+CAP Cxxx capacitor
+IND Lxxx inductor
+RES Rxxx resistor
+D Dxxx diode
+NPN Qxxx NPN bipolar
+PNP Qxxx PNP bipolar
+NJF Jxxx N-channel JFET
+PJF Jxxx P-channel JFET
+NMOS Mxxx N-channel MOSFET
+PMOS Mxxx P-channel MOSFET
+VSWITCH Sxxx voltage controlled switch
+
+    Examples:
+    .MODEL RMAX RES (R=1.5 TC=.02 TC2=.005)
+    .MODEL QDRIV NPN (IS=1e-7 BF=30)
+
+Top ↑
+.NODESET – Initial bias point guess.  
+ .NODESET { {node}={value} }\*  
+ Examples:
+.NODESET V(2)=3.4 V(3)=-1V
+
+.NOISE - Noise Analysis.  
+ .NOISE {output variable} {name} [{print interval}]  
+ Examples:
+.NOISE V(5) VIN
+
+.PLOT – Plot Output.  
+ .PLOT [DC][AC][NOISE][TRAN] [ [{output variable}*]
+Examples:
+.PLOT DC V(3) V(2,3) V(R1) I(VIN)
+.PLOT AC VM(2) VP(2) VG(2)
+
+.PRINT – Print Output.  
+ .PRINT [DC][AC][NOISE][TRAN] [{output variable}*]  
+ Examples:
+.PRINT DC V(3) V(2,3) V(R1) IB(Q13)
+.PRINT AC VM(2) VP(2) VG(5) II(7)
+Top ↑
+.PROBE – Save simulation output PSPICE COMMAND.  
+ .PROBE [output variable]\*
+Examples:
+.PROBE
+.PROBE V(3) VM(2) I(VIN)
+
+.SENS - Sensitivity Analysis.  
+ .SENS {output variable}\*  
+ Examples:
+.SENS V(9) V(4,3) I(VCC)
+
+.SUBCKT - Subcircuit Definition.  
+ .SUBCKT {name} [{node}*]
+Examples:
+.SUBCKT OPAMP 1 2 101 102
+
+.TEMP – Temperature Analysis.  
+ .TEMP {value}\*  
+ Examples:
+.TEMP 0 27 125
+
+.TF – DC Transfer Function.  
+ .TF {output variable} {input source name}
+Examples:
+.TF V(5) VIN
+
+.TRAN - Transient Analysis.  
+.TRAN {print step value} {final time} [{no print time}
+[{step ceiling value}]] [UIC]  
+ Examples:
+.TRAN 5NS 100NS
+Top ↑

package/lib/index.ts

@@ -0,0 +1 @@
+console.log("Hello via Bun!");

package/lib/spice-classes/SpiceNetlist.ts

@@ -0,0 +1,9 @@
+import { convertSpiceNetlistToString } from "../spice-utils/convertSpiceNetlistToString"
+
+export class SpiceNetlist {
+  title?: string
+
+  toSpiceString() {
+    return convertSpiceNetlistToString(this)
+  }
+}

package/lib/spice-classes/SpiceNode.ts

@@ -0,0 +1 @@
+export class SpiceNode {}

package/lib/spice-commands/BJTCommand.ts

@@ -0,0 +1,34 @@
+import type { BaseSpiceCommand } from "./BaseSpiceCommand"
+
+export interface BJTCommandProps {
+  name: string
+  collector: string
+  base: string
+  emitter: string
+  substrate?: string
+  model: string
+  area?: string
+}
+
+export class BJTCommand implements BaseSpiceCommand {
+  commandName = "bjt" as const
+  props: BJTCommandProps
+
+  constructor(props: BJTCommandProps) {
+    this.props = props
+  }
+
+  toSpiceString(): string {
+    const { name, collector, base, emitter, substrate, model, area } =
+      this.props
+    let spiceString = `Q${name} ${collector} ${base} ${emitter}`
+    if (substrate) {
+      spiceString += ` ${substrate}`
+    }
+    spiceString += ` ${model}`
+    if (area) {
+      spiceString += ` ${area}`
+    }
+    return spiceString
+  }
+}

package/lib/spice-commands/BaseSpiceCommand.ts

@@ -0,0 +1,6 @@
+export interface BaseSpiceCommand {
+  commandName?: string
+  statementName?: string
+
+  toSpiceString(): string
+}

package/lib/spice-commands/CapacitorCommand.ts

@@ -0,0 +1,41 @@
+import type { BaseSpiceCommand } from "./BaseSpiceCommand"
+
+export interface CapacitorCommandProps {
+  name: string
+  positiveNode: string
+  negativeNode: string
+  modelName?: string
+  value: string
+  initialCondition?: string
+}
+
+export class CapacitorCommand implements BaseSpiceCommand {
+  commandName = "capacitor" as const
+
+  props: CapacitorCommandProps
+
+  constructor(props: CapacitorCommandProps) {
+    this.props = props
+  }
+
+  toSpiceString(): string {
+    const {
+      name,
+      positiveNode,
+      negativeNode,
+      modelName,
+      value,
+      initialCondition,
+    } = this.props
+
+    let spiceString = `C${name} ${positiveNode} ${negativeNode}`
+    if (modelName) {
+      spiceString += ` ${modelName}`
+    }
+    spiceString += ` ${value}`
+    if (initialCondition) {
+      spiceString += ` IC=${initialCondition}`
+    }
+    return spiceString
+  }
+}

package/lib/spice-commands/CurrentSourceCommand.ts

@@ -0,0 +1,35 @@
+import type { BaseSpiceCommand } from "./BaseSpiceCommand"
+
+export interface CurrentSourceCommandProps {
+  name: string
+  positiveNode: string
+  negativeNode: string
+  value?: string
+  acMagnitude?: string
+  acPhase?: string
+}
+
+export class CurrentSourceCommand implements BaseSpiceCommand {
+  commandName = "current_source" as const
+  props: CurrentSourceCommandProps
+
+  constructor(props: CurrentSourceCommandProps) {
+    this.props = props
+  }
+
+  toSpiceString(): string {
+    const { name, positiveNode, negativeNode, value, acMagnitude, acPhase } =
+      this.props
+    let spiceString = `I${name} ${positiveNode} ${negativeNode}`
+    if (value) {
+      spiceString += ` ${value}`
+    }
+    if (acMagnitude) {
+      spiceString += ` AC ${acMagnitude}`
+      if (acPhase) {
+        spiceString += ` ${acPhase}`
+      }
+    }
+    return spiceString
+  }
+}

package/lib/spice-commands/DiodeCommand.ts

@@ -0,0 +1,27 @@
+import type { BaseSpiceCommand } from "./BaseSpiceCommand"
+
+export interface DiodeCommandProps {
+  name: string
+  positiveNode: string
+  negativeNode: string
+  model: string
+  area?: string
+}
+
+export class DiodeCommand implements BaseSpiceCommand {
+  commandName = "diode" as const
+  props: DiodeCommandProps
+
+  constructor(props: DiodeCommandProps) {
+    this.props = props
+  }
+
+  toSpiceString(): string {
+    const { name, positiveNode, negativeNode, model, area } = this.props
+    let spiceString = `D${name} ${positiveNode} ${negativeNode} ${model}`
+    if (area) {
+      spiceString += ` ${area}`
+    }
+    return spiceString
+  }
+}

package/lib/spice-commands/InductorCommand.ts

@@ -0,0 +1,33 @@
+import type { BaseSpiceCommand } from "./BaseSpiceCommand"
+
+export interface InductorCommandProps {
+  name: string
+  positiveNode: string
+  negativeNode: string
+  model?: string
+  value: string
+  initialCondition?: string
+}
+
+export class InductorCommand implements BaseSpiceCommand {
+  commandName = "inductor" as const
+  props: InductorCommandProps
+
+  constructor(props: InductorCommandProps) {
+    this.props = props
+  }
+
+  toSpiceString(): string {
+    const { name, positiveNode, negativeNode, model, value, initialCondition } =
+      this.props
+    let spiceString = `L${name} ${positiveNode} ${negativeNode}`
+    if (model) {
+      spiceString += ` ${model}`
+    }
+    spiceString += ` ${value}`
+    if (initialCondition) {
+      spiceString += ` IC=${initialCondition}`
+    }
+    return spiceString
+  }
+}

package/lib/spice-commands/InductorCouplingCommand.ts

@@ -0,0 +1,21 @@
+import type { BaseSpiceCommand } from "./BaseSpiceCommand"
+
+export interface InductorCouplingCommandProps {
+  name: string
+  inductors: string[]
+  coupling: string
+}
+
+export class InductorCouplingCommand implements BaseSpiceCommand {
+  commandName = "inductor_coupling" as const
+  props: InductorCouplingCommandProps
+
+  constructor(props: InductorCouplingCommandProps) {
+    this.props = props
+  }
+
+  toSpiceString(): string {
+    const { name, inductors, coupling } = this.props
+    return `K${name} ${inductors.join(" ")} ${coupling}`
+  }
+}

package/lib/spice-commands/JFETCommand.ts

@@ -0,0 +1,28 @@
+import type { BaseSpiceCommand } from "./BaseSpiceCommand"
+
+export interface JFETCommandProps {
+  name: string
+  drain: string
+  gate: string
+  source: string
+  model: string
+  area?: string
+}
+
+export class JFETCommand implements BaseSpiceCommand {
+  commandName = "jfet" as const
+  props: JFETCommandProps
+
+  constructor(props: JFETCommandProps) {
+    this.props = props
+  }
+
+  toSpiceString(): string {
+    const { name, drain, gate, source, model, area } = this.props
+    let spiceString = `J${name} ${drain} ${gate} ${source} ${model}`
+    if (area) {
+      spiceString += ` ${area}`
+    }
+    return spiceString
+  }
+}

package/lib/spice-commands/MOSFETCommand.ts

@@ -0,0 +1,67 @@
+import type { BaseSpiceCommand } from "./BaseSpiceCommand"
+
+export interface MOSFETCommandProps {
+  name: string
+  drain: string
+  gate: string
+  source: string
+  substrate: string
+  model: string
+  length?: string
+  width?: string
+  drainArea?: string
+  sourceArea?: string
+  drainPerimeter?: string
+  sourcePerimeter?: string
+  drainResistance?: string
+  sourceResistance?: string
+}
+
+export class MOSFETCommand implements BaseSpiceCommand {
+  commandName = "mosfet" as const
+  props: MOSFETCommandProps
+
+  constructor(props: MOSFETCommandProps) {
+    this.props = props
+  }
+
+  toSpiceString(): string {
+    const {
+      name,
+      drain,
+      gate,
+      source,
+      substrate,
+      model,
+      length,
+      width,
+      drainArea,
+      sourceArea,
+      drainPerimeter,
+      sourcePerimeter,
+      drainResistance,
+      sourceResistance,
+    } = this.props
+
+    let spiceString = `M${name} ${drain} ${gate} ${source} ${substrate} ${model}`
+
+    const params: Record<string, string | undefined> = {
+      L: length,
+      W: width,
+      AD: drainArea,
+      AS: sourceArea,
+      PD: drainPerimeter,
+      PS: sourcePerimeter,
+      NRD: drainResistance,
+      NRS: sourceResistance,
+    }
+
+    Object.entries(params).forEach(([key, value]) => {
+      if (value) {
+        spiceString += ` ${key}=${value}`
+      }
+    })
+
+    return spiceString
+  }
+}

package/lib/spice-commands/ResistorCommand.ts

@@ -0,0 +1,28 @@
+import type { BaseSpiceCommand } from "./BaseSpiceCommand"
+
+export interface ResistorCommandProps {
+  name: string
+  positiveNode: string
+  negativeNode: string
+  model?: string
+  value: string
+}
+
+export class ResistorCommand implements BaseSpiceCommand {
+  commandName = "resistor" as const
+  props: ResistorCommandProps
+
+  constructor(props: ResistorCommandProps) {
+    this.props = props
+  }
+
+  toSpiceString(): string {
+    const { name, positiveNode, negativeNode, model, value } = this.props
+    let spiceString = `R${name} ${positiveNode} ${negativeNode}`
+    if (model) {
+      spiceString += ` ${model}`
+    }
+    spiceString += ` ${value}`
+    return spiceString
+  }
+}

package/lib/spice-commands/SubcircuitCallCommand.ts

@@ -0,0 +1,21 @@
+import type { BaseSpiceCommand } from "./BaseSpiceCommand"
+
+export interface SubcircuitCallCommandProps {
+  name: string
+  nodes: string[]
+  subcircuitName: string
+}
+
+export class SubcircuitCallCommand implements BaseSpiceCommand {
+  commandName = "subcircuit_call" as const
+  props: SubcircuitCallCommandProps
+
+  constructor(props: SubcircuitCallCommandProps) {
+    this.props = props
+  }
+
+  toSpiceString(): string {
+    const { name, nodes, subcircuitName } = this.props
+    return `X${name} ${nodes.join(" ")} ${subcircuitName}`
+  }
+}

package/lib/spice-commands/TransmissionLineCommand.ts

@@ -0,0 +1,46 @@
+import type { BaseSpiceCommand } from "./BaseSpiceCommand"
+
+export interface TransmissionLineCommandProps {
+  name: string
+  aPositive: string
+  aNegative: string
+  bPositive: string
+  bNegative: string
+  impedance: string
+  delay?: string
+  frequency?: string
+  normalizedLength?: string
+}
+
+export class TransmissionLineCommand implements BaseSpiceCommand {
+  commandName = "transmission_line" as const
+  props: TransmissionLineCommandProps
+
+  constructor(props: TransmissionLineCommandProps) {
+    this.props = props
+  }
+
+  toSpiceString(): string {
+    const {
+      name,
+      aPositive,
+      aNegative,
+      bPositive,
+      bNegative,
+      impedance,
+      delay,
+      frequency,
+      normalizedLength,
+    } = this.props
+    let spiceString = `T${name} ${aPositive} ${aNegative} ${bPositive} ${bNegative} Z0=${impedance}`
+    if (delay) {
+      spiceString += ` TD=${delay}`
+    } else if (frequency) {
+      spiceString += ` F=${frequency}`
+      if (normalizedLength) {
+        spiceString += ` NL=${normalizedLength}`
+      }
+    }
+    return spiceString
+  }
+}

package/lib/spice-commands/VoltageControlledSwitchCommand.ts

@@ -0,0 +1,31 @@
+import type { BaseSpiceCommand } from "./BaseSpiceCommand"
+
+export interface VoltageControlledSwitchCommandProps {
+  name: string
+  positiveNode: string
+  negativeNode: string
+  positiveControl: string
+  negativeControl: string
+  model: string
+}
+
+export class VoltageControlledSwitchCommand implements BaseSpiceCommand {
+  commandName = "voltage_controlled_switch" as const
+  props: VoltageControlledSwitchCommandProps
+
+  constructor(props: VoltageControlledSwitchCommandProps) {
+    this.props = props
+  }
+
+  toSpiceString(): string {
+    const {
+      name,
+      positiveNode,
+      negativeNode,
+      positiveControl,
+      negativeControl,
+      model,
+    } = this.props
+    return `S${name} ${positiveNode} ${negativeNode} ${positiveControl} ${negativeControl} ${model}`
+  }
+}