https://github.com/mpasson/lekkersim

Scattering Matrix Linear Simulator for Photonic Circuits
https://github.com/mpasson/lekkersim

Last synced: about 2 months ago
JSON representation

Scattering Matrix Linear Simulator for Photonic Circuits

• Host: GitHub
• URL: https://github.com/mpasson/lekkersim
• Owner: mpasson
• License: agpl-3.0
• Created: 2023-05-12T16:11:06.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-07-12T16:49:42.000Z (6 months ago)
• Last Synced: 2024-08-03T03:06:42.666Z (5 months ago)
• Language: Python
• Homepage: https://lekkersim.readthedocs.io
• Size: 13.9 MB
• Stars: 7
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome_photonics - lekkersim

README

        
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![Documentation Status](https://readthedocs.org/projects/lekkersim/badge/?version=latest)](https://lekkersim.readthedocs.io/en/latest/?badge=latest)

[![PyPI version](https://badge.fury.io/py/lekkersim.svg)](https://badge.fury.io/py/lekkersim)

# LekkerSIM package

LekkerSIM is a open source package for linear simulation of photonic circuit, based on the well known scattering matrix method.

Its features include:

- Easy calculation of S-parameters of a photonic circuit;

- A collection of pre-defined building blocks for easy definition of circuits;

- Parametric building blocks;

- Hierarchical circuit definition;

- Monitors inside the circuit for calculation of power flow.

## Installation

You can install LekkerSIM directly from pypi by running:

    pip install lekkersim

## Documentation

Full documentation is available on [Read the Docs](https://lekkersim.readthedocs.io).