gsim 0.3.0

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.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, install the optional prebuilt binary separately:

pip install "palacetoolkit-palace-cpu @ https://github.com/EpsilonForge/PalaceToolkit/releases/download/palace-cpu-v0.1.2/palacetoolkit_palace_cpu-0.1.0-py3-none-linux_x86_64.whl"

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

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

2 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for Flaport from gravatar.com Flaport Avatar for photonwrangler from gravatar.com photonwrangler

Credits

Author: GDSFactory

License

Apache Software License (Apache-2.0)

Requires

Python ~=3.12.0

Classifiers

Report project as malware

Download files

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

Source Distribution

gsim-0.3.0.tar.gz (288.7 kB view details)

Uploaded Source

Built Distribution

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

gsim-0.3.0-py3-none-any.whl (315.1 kB view details)

Uploaded Python 3

File details

Details for the file gsim-0.3.0.tar.gz.

File metadata

  • Download URL: gsim-0.3.0.tar.gz
  • Upload date:
  • Size: 288.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for gsim-0.3.0.tar.gz
Algorithm Hash digest
SHA256 4a8cddbc65b65cde7c0ee614ec68f713b606826ea9197dfa22e4ec6a9e2bb56b
MD5 1424d1e3c5d48715659aedf7860348fa
BLAKE2b-256 38aa347a6ed9458d1b50b00b4dafebdfadc9f73555f5975273f1d0498c204f75

See more details on using hashes here.

Provenance

The following attestation bundles were made for gsim-0.3.0.tar.gz:

Publisher: release.yml on gdsfactory/gsim

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

File details

Details for the file gsim-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: gsim-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 315.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for gsim-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 43915f01b470c32081bf7f535aa64b232f6d606ef3ed3a2cc0263cbc0ef8d6f9
MD5 0614231bf0dc1329b0c5cb88bbf116bc
BLAKE2b-256 a6ba07292d6b9e961415d4e913ef315510b833421b814e71deb51a70dad1bf6f

See more details on using hashes here.

Provenance

The following attestation bundles were made for gsim-0.3.0-py3-none-any.whl:

Publisher: release.yml on gdsfactory/gsim

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 Sentry Error logging StatusPage Status page