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: 17 days ago
JSON representation
gdsfactory plugins
- Host: GitHub
- URL: https://gdsfactory.github.io/gplugins/
- Owner: gdsfactory
- License: mit
- Created: 2023-08-01T12:10:54.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-11T23:22:48.000Z (about 1 year ago)
- Last Synced: 2024-04-13T21:01:35.092Z (about 1 year 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.3.3
[](https://gdsfactory.github.io/gplugins/)
[](https://pypi.org/project/gplugins/)
[](https://pypi.python.org/pypi/gplugins)
[](https://choosealicense.com/licenses/mit/)
[](https://codecov.io/gh/gdsfactory/gdsfactory/tree/main/gplugins)
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:
```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.
## Installation for contributors
We recommend `uv` for installing GDSFactory:
```bash
# On macOS and Linux.
curl -LsSf https://astral.sh/uv/install.sh | sh
```
```bash
# On Windows.
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```
Then you can install gdsfactory with:
```bash
uv venv --python 3.11
uv sync --extra docs --extra dev
```
## Getting started
- [Read docs](https://gdsfactory.github.io/gplugins/)
- [Read gdsfactory docs](https://gdsfactory.github.io/gdsfactory/)
- [](https://gitter.im/gdsfactory-dev/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)