Skip to main content

gsim 0.10.0

codecov

Electromagnetic simulation for photonics and electronics, powered by GDSFactory+

gsim-logo

Overview

gsim connects GDSFactory layout designs to multiple EM solvers for photonic and electronic simulation. It handles geometry extraction, mesh generation, port configuration, and cloud execution so you can go from GDS to S-parameters with minimal boilerplate.

Solvers

Module Solver Method Use Case
gsim.fdtd GDSFactory FDTD FDTD PDK-native mesh and runtime configuration generation
gsim.palace Palace FEM RF/microwave, impedance extraction, driven simulations
gsim.meep Meep FDTD Photonic components, S-parameters, mode propagation

Features

  • Layer stack extraction — build 3D geometry from PDK layer stacks
  • Port configuration — convert GDSFactory ports into solver-compatible definitions
  • Mesh generation — GMSH finite-element meshes with configurable quality presets (Palace)
  • Cloud execution — upload, run, and download results via gsim.gcloud
  • Visualization — solver-agnostic 3D/2D component preview (PyVista, Matplotlib)

Installation

pip install gsim

For local Palace execution on Linux x86_64, gsim can auto-download and cache a prebuilt Palace CPU binary on first use. No additional package installation is required. If you prefer to supply a binary yourself, set PALACE_BIN (path to an executable) or put palace on your PATH; a Palace SIF image may be given via PALACE_SIF for Apptainer-based runs.

For development (requires uv):

git clone https://github.com/gdsfactory/gsim
cd gsim
uv sync --dev

Or use the justfile:

just dev

Documentation

See the documentation for API reference and examples.

License

Apache-2.0

Metadata

Release files for gsim 0.10.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gsim 0.10.0
File Size Uploaded Provenance Actions
gsim-0.10.0.tar.gz 844.0 kB With provenance Details for gsim-0.10.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for gsim 0.10.0
File Interpreter ABI Platform Actions
gsim-0.10.0-py3-none-any.whl Python 3 none any Details for gsim-0.10.0-py3-none-any.whl

Total release size: 1.8 MB

Release files / gsim-0.10.0.tar.gz

Download URL gsim-0.10.0.tar.gz
Size 844.0 kB
Tags Source
SHA-256 checksum
How to use checksums
5366adead9f17c47ed05f602d82318e4948f7081848d04574660066ae318a44f
BLAKE2b-256 checksum
How to use checksums
b0c83364df04ef6d116720818767303dc92e098a642b61cab32aeaba2f463103
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 13, 2026.

Transparency log

Release files / gsim-0.10.0-py3-none-any.whl

Download URL gsim-0.10.0-py3-none-any.whl
Size 908.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4e5933d8f192c5679c4b334f8fead1159cd92f0e1015007bf7ea66c43c951cb6
BLAKE2b-256 checksum
How to use checksums
756ad92cbde8917a7b1b3386b182f320d92d2dec92cd30105b43045a861c6f22
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 13, 2026.

Transparency log

Security for gsim 0.10.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for gsim-0.10.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 13, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page