Skip to main content

gsim 0.8.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.8.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.8.0
File Size Uploaded Provenance
gsim-0.8.0.tar.gz 613.4 kB With provenance Details

Built distribution (wheel)

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

Total release size: 1.3 MB

Release files / gsim-0.8.0.tar.gz

Download URL gsim-0.8.0.tar.gz
Size 613.4 kB
Tags Source
SHA-256 checksum
How to use checksums
2addfc30197d86973c241806cd9959d69663b61e580b24bbc662f1784653dda1
BLAKE2b-256 checksum
How to use checksums
53ef53c4f6be8bc717af09609a0596018833407e66f5269afe03120cf7783e4f
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 Oct 22, 2026.

Transparency log

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

Download URL gsim-0.8.0-py3-none-any.whl
Size 664.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
81bcb8115d738d5b41b9d3decd89e2d2bc8e36e4d1c8de51e9adf99003d820c4
BLAKE2b-256 checksum
How to use checksums
367e5ab2f23e03c357b21f8ac5aa6b69ae6ec6fe15ec09d1df60151d3a84a7fd
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 Oct 22, 2026.

Transparency log

Security for gsim 0.8.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

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for gsim-0.8.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 Oct 22, 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.

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