Skip to main content

Differentiable circuit simulator based on JAX

Project description

Circulax

logo

A differentiable circuit simulator built on JAX. Define netlists, run transient / DC / AC / harmonic-balance analysis, and differentiate through the solver for gradient-based optimization and inverse design. Circulax aims to be flexible multi-disciplined circuit simulator offering a similar interface to the linear s-parameter solver SAX.

Read the Documentation here

Installation

pip install circulax

Quickstart

Simulate an underdamped LCR circuit in the time domain:

LCR transient animation

import jax, jax.numpy as jnp
from circulax import compile_circuit
from circulax.components.electronic import Capacitor, Inductor, Resistor, VoltageSource

jax.config.update("jax_enable_x64", True)

net_dict = {
    "instances": {
        "GND": {"component": "ground"},
        "V1":  {"component": "source_voltage", "settings": {"V": 1.0, "delay": 0.25e-9}},
        "R1":  {"component": "resistor",        "settings": {"R": 10.0}},
        "C1":  {"component": "capacitor",       "settings": {"C": 1e-11}},
        "L1":  {"component": "inductor",        "settings": {"L": 5e-9}},
    },
    "connections": {
        "GND,p1": ("V1,p2", "C1,p2"),
        "V1,p1": "R1,p1",  "R1,p2": "L1,p1",  "L1,p2": "C1,p1",
    },
}

models = {
    "resistor": Resistor, "capacitor": Capacitor,
    "inductor": Inductor, "source_voltage": VoltageSource, "ground": lambda: 0,
}

circuit = compile_circuit(net_dict, models)
y_op    = circuit.dc()

sol = circuit.transient(
    t0=0.0, t1=3e-9, dt0=3e-12, y0=y_op,
    saveat=jnp.linspace(0, 3e-9, 500),
    max_steps=100_000,
)

v_cap = circuit.port(sol.ys, "C1,p1")  # capacitor voltage over time

Common analyses use the same compiled object:

op = circuit.dc()
op_sweep = circuit.dc(params={"R1.R": 20.0, "wavelength_nm": 1310.0})
S = circuit.ac(ports=["C1,p1"], freqs=jnp.logspace(6, 10, 101), y_dc=op)
y_time, y_freq = circuit.hb(freq=1e6, harmonics=5, y0=op)
v_out = circuit.port(op, "C1,p1")

Parameter keys like "R1.R" update one instance. Keys without a dot, such as "wavelength_nm", are broadcast to every component that declares the parameter.

Defining Components

Components are plain Python functions — no boilerplate, no subclassing:

from circulax.components.base_component import component, Signals, States

@component(ports=("p1", "p2"))
def Resistor(signals: Signals, s: States, R: float = 1e3):
    i = (signals.p1 - signals.p2) / R
    return {"p1": i, "p2": -i}, {}          # (currents, charges)

@component(ports=("p1", "p2"))
def Capacitor(signals: Signals, s: States, C: float = 1e-12):
    q = C * (signals.p1 - signals.p2)
    return {}, {"p1": q, "p2": -q}          # dq/dt becomes current automatically

Non-linear opto-electronic components are just as simple — the Jacobian is computed automatically via Automatic Differentiation:

@component(ports=("optical_in", "anode", "cathode"))
def Photodetector(signals: Signals, s: States,
                  responsivity: float = 0.8, dark_current: float = 1e-9):
    optical_power = jnp.abs(signals.optical_in) ** 2           # non-linear
    i_photo = responsivity * optical_power + dark_current
    i_reflect = -0.01 * signals.optical_in                     # small back-reflection
    return {"optical_in": i_reflect, "anode": i_photo, "cathode": -i_photo}, {}

Existing SAX models plug in directly — reuse your photonic PDK as-is:

import sax
from circulax.s_transforms import sax_component

Straight = sax_component(sax.models.straight)   # that's it — ready to simulate

Features

  • Transient — implicit ODE stepping via Diffrax; handles stiff circuits.
  • DC operating point — Newton-Raphson root-finding via Optimistix.
  • Harmonic Balance — periodic steady state directly in the frequency domain.
  • AC sweep — linearise at DC op-point, sweep frequency, return S-parameters.
  • OSDI compact models — load OpenVAF-compiled Verilog-A models through bosdi.
  • Automatic differentiation — differentiate through the solver for gradient-based inverse design.
  • Hardware-agnostic — CPU, GPU, or TPU with no code changes.
  • Mixed-domain — electronic and photonic circuits in a single netlist.

Comparison to SPICE

Circulax is a SPICE-like simulator but built with modern tooling so users can easily create their own models in a language they know.

SPICE circulax
Model definition Verilog-A / hardcoded C++ Python functions
Derivatives Hardcoded or compiler-generated Automatic differentiation
Solver Fixed/heuristic stepping Adaptive ODE (Diffrax)
Hardware CPU-only CPU / GPU / TPU

Inverse Design via Back-propagation

Because the entire solver is written in JAX, gradients flow end-to-end from a loss function back through the simulation and into component parameters. Use jax.grad and standard optimizers to automatically tune circuit designs — the cost is one forward + one backward pass regardless of parameter count.

See the Inverse Design guide for a comparison with finite differences and worked examples.


Copyright © 2026 Chris Daunt — Apache-2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

circulax-0.2.0.tar.gz (4.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

circulax-0.2.0-py3-none-any.whl (414.1 kB view details)

Uploaded Python 3

File details

Details for the file circulax-0.2.0.tar.gz.

File metadata

  • Download URL: circulax-0.2.0.tar.gz
  • Upload date:
  • Size: 4.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for circulax-0.2.0.tar.gz
Algorithm Hash digest
SHA256 0a4e69f274c6f3e11cebde2e8faad3fb210173ab50e89d8d7a10631c7c7b088e
MD5 c7bfe41a196f65290e1901d53a50e62a
BLAKE2b-256 0909db3985902aa09510a703c1859b19f41d613b5269958759e606b1e4669c44

See more details on using hashes here.

Provenance

The following attestation bundles were made for circulax-0.2.0.tar.gz:

Publisher: publish.yaml on gdsfactory/circulax

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file circulax-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: circulax-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 414.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for circulax-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 de5190ba64b23ce6baea6c7927c81836d1983812b9c8c3624bedd4b02455280d
MD5 844b787a86b5dd45861314dbcb68a32f
BLAKE2b-256 81e288eeb55f90350cc85f89643c632ea19701b225c6a6cb3d9ee46e11ce1cc0

See more details on using hashes here.

Provenance

The following attestation bundles were made for circulax-0.2.0-py3-none-any.whl:

Publisher: publish.yaml on gdsfactory/circulax

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page