Metadata-Version: 2.1
Name: gplugins
Version: 0.9.6
Summary: gdsfactory plugins
Keywords: python
Author-email: gdsfactory <contact@gdsfactory.com>
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Operating System :: OS Independent
Requires-Dist: gdsfactory[cad]>=7.8.1
Requires-Dist: pint
Requires-Dist: dagster ; extra == "dagster"
Requires-Dist: dagit ; extra == "dagster"
Requires-Dist: pre-commit ; extra == "dev"
Requires-Dist: pytest ; extra == "dev"
Requires-Dist: pytest-cov ; extra == "dev"
Requires-Dist: pytest_regressions ; extra == "dev"
Requires-Dist: jsondiff ; extra == "dev"
Requires-Dist: mypy ; extra == "dev"
Requires-Dist: pyswarms ; extra == "dev"
Requires-Dist: autograd ; extra == "dev"
Requires-Dist: hyperopt ; extra == "dev"
Requires-Dist: tbump ; extra == "dev"
Requires-Dist: towncrier ; extra == "dev"
Requires-Dist: ray ; extra == "dev"
Requires-Dist: devsim ; extra == "devsim"
Requires-Dist: pyvista<=0.40 ; extra == "devsim"
Requires-Dist: tidy3d==2.5.0rc3 ; extra == "devsim"
Requires-Dist: jupytext ; extra == "docs"
Requires-Dist: matplotlib ; extra == "docs"
Requires-Dist: jupyter-book==0.15.1 ; extra == "docs"
Requires-Dist: pyvista[jupyter]<=0.40 ; extra == "docs"
Requires-Dist: femwell>=0.1.6,<0.2 ; extra == "femwell"
Requires-Dist: meshwell>=1.0.0,<1.1 ; extra == "femwell"
Requires-Dist: gmsh ; extra == "gmsh"
Requires-Dist: h5py ; extra == "gmsh"
Requires-Dist: mapbox_earcut ; extra == "gmsh"
Requires-Dist: meshio ; extra == "gmsh"
Requires-Dist: pygmsh ; extra == "gmsh"
Requires-Dist: pyvista<=0.40 ; extra == "gmsh"
Requires-Dist: trimesh ; extra == "gmsh"
Requires-Dist: shapely ; extra == "gmsh"
Requires-Dist: meshwell>=1.0.0,<1.1.0 ; extra == "gmsh"
Requires-Dist: kfactory[git,ipy]>=0.9.3,<0.10 ; extra == "klayout"
Requires-Dist: pyvis<=0.3.1 ; extra == "klayout"
Requires-Dist: jaxlib ; extra == "meow"
Requires-Dist: jax ; extra == "meow"
Requires-Dist: meow-sim>0.8,<0.9 ; extra == "meow"
Requires-Dist: tidy3d==2.5.0rc3 ; extra == "meow"
Requires-Dist: jaxlib ; extra == "sax"
Requires-Dist: jax ; extra == "sax"
Requires-Dist: sax>=0.10.3,<0.11.0 ; extra == "sax"
Requires-Dist: scikit-learn ; extra == "sax"
Requires-Dist: bokeh ; extra == "schematic"
Requires-Dist: natsort ; extra == "schematic"
Requires-Dist: tidy3d==2.5.0rc3 ; extra == "tidy3d"
Requires-Dist: meshio ; extra == "tidy3d"
Requires-Dist: meshwell>=1.0.0,<1.1 ; extra == "tidy3d"
Requires-Dist: vlsir>=4.0.0,<6.0.0 ; extra == "vlsir"
Requires-Dist: vlsirtools>=4.0.0,<6.0.0 ; extra == "vlsir"
Provides-Extra: dagster
Provides-Extra: dev
Provides-Extra: devsim
Provides-Extra: docs
Provides-Extra: femwell
Provides-Extra: gmsh
Provides-Extra: klayout
Provides-Extra: meow
Provides-Extra: sax
Provides-Extra: schematic
Provides-Extra: tidy3d
Provides-Extra: vlsir

# gplugins 0.9.6

[![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]`

```

### 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)

