Skip to main content

gdsfactory plugins

Project description

gplugins 1.4.0

docs PyPI PyPI Python MIT codecov

GDSFactory plugins:

  • Device simulators
    • Meshing
    • FDTD
      • Ansys Lumerical
      • tidy3d
      • Luminescent
      • FDTDz
      • MEEP
    • FEM
      • femwell Finite Element Method Solver (heaters, modes, TCAD, RF waveguides).
      • elmer for electrostatic (capacitive) simulations.
      • palace for full-wave driven (S parameter) and electrostatic (capacitive) simulations.
    • EME
      • meow Eigen Mode Expansion (EME).
    • Mode Solver
      • Tidy3d
      • Femwell
      • MPB
    • TCAD
      • devsim TCAD device simulator.
  • Circuit simulations
    • sax S-parameter circuit solver.
    • vlsir for parsing GDS-extracted circuit netlists into Cadence Spectre, NgSpice and Xyce Schematic File formats.

Installation

You can install most plugins with:

pip install "gdsfactory[full]" --upgrade

or

pip install "gplugins[devsim,femwell,gmsh,schematic,meow,meshwell,sax,tidy3d]" --upgrade

Or install only the plugins you need. For example:

pip install "gplugins[schematic,femwell,meow,sax,tidy3d]" --upgrade

Non-pip plugins

The following plugins require special installation as they can't be installed with pip:

  • For Meep and MPB you need to use conda or mamba on MacOS, Linux or Windows WSL (Windows Subsystem for Linux) with conda install pymeep=*=mpi_mpich_* -c conda-forge -y
  • For Elmer, refer to Elmer FEM – Installation for installation or compilation instructions each platform. Gplugins assumes ElmerSolver, ElmerSolver_mpi, and ElmerGrid are available in your PATH environment variable.
  • For Palace, refer to Palace – Installation for compilation instructions using Spack or Singularity. Gplugins assumes palace is available in your PATH environment variable.

Installation for contributors

We recommend uv for installing GDSFactory:

# On macOS and Linux.
curl -LsSf https://astral.sh/uv/install.sh | sh
# On Windows.
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Then you can install gdsfactory with:

uv venv --python 3.11
uv sync --extra docs --extra dev

Getting started

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

gplugins-1.4.0.tar.gz (537.6 kB view details)

Uploaded Source

Built Distribution

gplugins-1.4.0-py3-none-any.whl (664.8 kB view details)

Uploaded Python 3

File details

Details for the file gplugins-1.4.0.tar.gz.

File metadata

  • Download URL: gplugins-1.4.0.tar.gz
  • Upload date:
  • Size: 537.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for gplugins-1.4.0.tar.gz
Algorithm Hash digest
SHA256 7d6855dfb9f5393449d9716283f6b70deb6f9fd8478de3fcd0adb3efd9204ab7
MD5 3650c059f6f62510d0985a59a139d038
BLAKE2b-256 ca5522bf3fc3ab55755ca231dfe8245b8b52fa0f7b13294db28ffe16860b3180

See more details on using hashes here.

File details

Details for the file gplugins-1.4.0-py3-none-any.whl.

File metadata

  • Download URL: gplugins-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 664.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for gplugins-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6fbffe3fdccfcb9f9482ec79f1e8c9abad83712f8043bd7c16e39e71ddb55d75
MD5 d9641a75158ce224b48d846d58d17d0c
BLAKE2b-256 19cf0e0b1b88525f3499c0e685d6e7213adfc75ac0517b472f1683f95f8930fd

See more details on using hashes here.

Supported by

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