Metadata-Version: 2.1
Name: femwell
Version: 0.0.12
Summary: Mode solver for photonic and electric waveguides based on FEM
Home-page: https://github.com/HelgeGehring/femwell
License: GPLv3
Keywords: integrated photonics,silicon photonics,mode solving,finite element analysis
Author: Helge Gehring
Requires-Python: >=3.8
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Requires-Dist: gmsh
Requires-Dist: matplotlib
Requires-Dist: pygmsh
Requires-Dist: scikit-fem (>=8.0.0)
Requires-Dist: shapely (>=2.0.0)
Project-URL: Documentation, https://HelgeGehring.github.io/femwell/
Description-Content-Type: text/markdown

# Femwell

![logo](https://raw.githubusercontent.com/HelgeGehring/femwell/main/logo_inline.svg)

[![Docs](https://github.com/helgegehring/femwell/actions/workflows/docs.yml/badge.svg)](https://HelgeGehring.github.io/femwell/)
[![Build](https://github.com/helgegehring/femwell/actions/workflows/build.yml/badge.svg)](https://github.com/HelgeGehring/femwell/actions/workflows/build.yml)
[![PiPy](https://img.shields.io/pypi/v/femwell)](https://pypi.org/project/femwell/)
[![Downloads](https://static.pepy.tech/badge/femwell/month)](https://pepy.tech/project/femwell)

Finite element based simulation tool for integrated circuits, electric and photonic!
The documentation is lagging behind the state of code,
so there's several features for which there are only examples in the code.

**You can try out the examples in the browser!**
**Hover the rocket at the top on the example pages and click live code!**
(Might take some time to load)

## Features

- Photonic eigenmode solver
- Periodic photonic eigenmode solver
- Electric eigenmode solver
- Thermal mode solver (static and transient)
- Coulomb solver

## Possible Simulations

- Eigenmodes of waveguides and determining their effective refractive index
- Eigenmodes of bent waveguides
- Calculation of the group velocity and its dispersion
- Calculation of overlap-integrals and confinement-factors
- Bragg grating cells
- Grating coupler cells
- Eigenmode of a coaxial cable and its specific impedance
- Eigenmodes of electric transmission lines
  and determining their propagation constant (in work)
- Static thermal profiles
- Transient thermal behavior
- Static electric fields
- Overlap integrals between waveguide modes
- Overlap integral between a waveguide mode and a fiber mode
- Coupled mode theory - coupling between adjacent waveguides
- Heat based photonic phase shifters
- Pockels based photonic phase shifters

## Contributors

- Helge Gehring (Google): Maintainer
- Simon Bilodeau (Google): Meshes everything
- Joaquin Matres (Google): Code simplifications

Happy about every form of contribution -
pull requests, feature requests, issues, questions, ... :)

