gplugins

library2.1.0pypypi✓ verified 80d ago

Plugins for gdsfactory, a Python library for photonic chip design. Provides simulation (meep, tidy3d), netlist extraction, and DFM checks. Current stable version: 2.0.1, release cadence is irregular. Requires Python >=3.11.

data

pip install gplugins

package ↗homepage ↗

INSTALL

IMPORT

SIG · GPLUGINS

gplugins

datapythonv2.1.0

Install

17.7s avg

Import

—

Disk

819MB

Pass rate

6/ 10

Env Coverage6 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v2.1.0 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

glibc

py 3.10

✕ build_error

py 3.11

✓ 0.1s

✓ 36.9s

py 3.12

✓ 0.1s

✓ 34s

py 3.13

✓ 0.1s

✓ 35s

py 3.9

✕ build_error

819MB installed

● package 819MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

meep

✓ import gplugins

✗ import gplugins.meep as gm

Basic meep simulation using gplugins. Requires gdsfactory and meep installed.

import gdsfactory as gf import gplugins.meep as gm c = gf.c.straight_heater_metal(length=5, width=0.5) # Simulate using meep sim_settings = { "resolution": 20, "wavelength": 1.55, "duration": 1e-12, } gm.write_sparameters_meep(c, filepath="sparams.h5", **sim_settings)

Debug

Known issues

breakingVersion 2.0.0 renamed all submodules (e.g., 'meep' became 'gplugins.meep') and removed top-level imports. Old code using `from gplugins import *` or `import gplugins.meep as meep` will break.

fix

Update imports: `import gplugins.meep as gm` instead of `from gplugins import meep`. Use submodule-specific aliases.

affects: >=2.0.0

gotchaThe `write_sparameters_meep` function requires the component to be a full path to a GDS file or a Component with a GDS file written. In-memory components not written to file cause silent errors.

fix

Call `c.write_gds('temp.gds')` before simulation or provide a component that is already linked to a file.

affects: all

gotchaTidy3d plugin requires an API key set via `TIDY3D_API_KEY` environment variable or tidy3d config. Simulation will fail with a vague authentication error if missing.

fix

Set environment variable `TIDY3D_API_KEY` or configure tidy3d via `tidy3d.config.api_key = '...'` before using the plugin.

affects: all

Upgrade

Version history

2.1.0latest on PyPI · released May 17, 2026

Audit

Dependencies

gdsfactoryrequiredPrimary dependency; gplugins extends gdsfactory.

meepoptionalFor FDTD simulations via the meep plugin.

tidy3doptionalFor FDTD simulations via the tidy3d plugin.

devsimoptionalFor TCAD device simulation.

nkoptionalFor material dispersion fitting.

Agent activity

10 hits · last 30 days

node

Resources

packagehttps://pypi.org/project/gplugins/ ↗

homepagehttps://gdsfactory.com ↗