https://gdsfactory.github.io/gplugins/

gdsfactory plugins
https://gdsfactory.github.io/gplugins/

cad circuit circuit-simulation eda electronics-tools gds gdsii klayout oasis pcb-layout photonics verification

Last synced: about 1 month ago
JSON representation

gdsfactory plugins

• Host: GitHub
• URL: https://gdsfactory.github.io/gplugins/
• Owner: gdsfactory
• License: mit
• Created: 2023-08-01T12:10:54.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-11T23:22:48.000Z (8 months ago)
• Last Synced: 2024-04-13T21:01:35.092Z (8 months ago)
• Topics: cad, circuit, circuit-simulation, eda, electronics-tools, gds, gdsii, klayout, oasis, pcb-layout, photonics, verification
• Language: Python
• Homepage: https://gdsfactory.github.io/gplugins/
• Size: 1.98 MB
• Stars: 27
• Watchers: 3
• Forks: 26
• Open Issues: 30
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome_photonics - gplugins

README

        
# gplugins 1.0.2

[![docs](https://github.com/gdsfactory/gplugins/actions/workflows/pages.yml/badge.svg)](https://gdsfactory.github.io/gplugins/)

[![PyPI](https://img.shields.io/pypi/v/gplugins)](https://pypi.org/project/gplugins/)

[![PyPI Python](https://img.shields.io/pypi/pyversions/gplugins.svg)](https://pypi.python.org/pypi/gplugins)

[![MIT](https://img.shields.io/github/license/gdsfactory/gplugins)](https://choosealicense.com/licenses/mit/)

[![codecov](https://img.shields.io/codecov/c/github/gdsfactory/gplugins)](https://codecov.io/gh/gdsfactory/gdsfactory/tree/main/gplugins)

gdsfactory plugins:

- `devsim` TCAD device simulator.

- `meow` Eigen Mode Expansion (EME).

- `femwell` Finite Element Method Solver (heaters, modes, TCAD, RF waveguides).

- `gmsh` mesh structures.

- `tidy3d` Finite Difference Time Domain (FDTD) simulations on the cloud using GPU.

- `lumerical` For Ansys FDTD and Circuit interconnect.

- `klayout` for fill, dataprep and testing.

- `ray` for distributed computing and optimization.

- `sax` S-parameter circuit solver.

- `schematic`: for bokeh schematic editor and `path_length_analysis`.

- `meep` for FDTD.

- `mpb` for MPB mode solver.

- `elmer` for electrostatic (capacitive) simulations.

- `palace` for full-wave driven (S parameter) and electrostatic (capacitive) simulations.

- `vlsir` for parsing GDS-extracted circuit netlists into Spice, Spectre and Xyce Schematic File formats.

## Installation

You can install most plugins with:

```bash

pip install "gdsfactory[full]" --upgrade

```

or

```bash

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

```

Or install only the plugins you need. For example:

```bash

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)](https://learn.microsoft.com/en-us/windows/wsl/install) with `conda install pymeep=*=mpi_mpich_* -c conda-forge -y`

- For Elmer, refer to [Elmer FEM – Installation](https://www.elmerfem.org/blog/binaries/) 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](https://awslabs.github.io/palace/stable/install/) for compilation instructions using Spack or Singularity. Gplugins assumes `palace` is available in your PATH environment variable.

## Getting started

- [Read docs](https://gdsfactory.github.io/gplugins/)

- [Read gdsfactory docs](https://gdsfactory.github.io/gdsfactory/)

- [![Join the chat at https://gitter.im/gdsfactory-dev/community](https://badges.gitter.im/gdsfactory-dev/community.svg)](https://gitter.im/gdsfactory-dev/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)