Skip to main content

Photonic circuit network simulator

Project description

Photonflux 0.2.0

PyPI PyPI Python issues forks GitHub stars Downloads Downloads Downloads MIT

Photonflux is a photonic circuit simulation tool for simple, extensible simulation of large active photonic systems.

It solves the problem that existing simulation tools are unable to capture many important phenomena that are key to creating working products including:

  • Complex active component models
  • Component variation and Monte-Carlo simulation
  • Thermal crosstalk between components
  • Fabry-Perot reflections from on-chip components

Here, we build a circuit simulator on NetworkX, a complex network solver, to enable arbitrarily reconfigurable circuit models and systems. As opposed to other approaches, circuits / schematics are defined using a netlist generated from a layout. The primary reason for this is that photon designers typically do not use a idea -> schematic -> layout -> fabrication flow, but often skip the schematic step entirely (idea -> layout -> fabrication). The reason for this is that layouts in photonics are expressive and contain far more detail about the operation of systems than a schematic would capture.

Layouts for simulation in photonflux are defined in a yaml markup format that can be automatically generated using gdsfactory.

To see examples of what is possible in photonflux please see our examples.

For more information on the future of the package see our roadmap.

Installation

Installation for new photonflux users

It's as simple as:

python -m pip install photonflux --upgrade

Installation for developers

First install the package from github using:

git clone https://github.com/alexsludds/photonflux.git

Then, navigate to the download directory and install as an editable python package

python -m pip install -e .

Getting started

We include several examples in the examples folder, but if your usecase is not there please create an github issue and we can work together on it.

Acks

Contributors (in chronological order):

  • Alex Sludds (MIT): Initial code and documentation.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

photonflux-0.2.0.tar.gz (20.7 MB view details)

Uploaded Source

Built Distribution

photonflux-0.2.0-py3-none-any.whl (20.6 MB view details)

Uploaded Python 3

File details

Details for the file photonflux-0.2.0.tar.gz.

File metadata

  • Download URL: photonflux-0.2.0.tar.gz
  • Upload date:
  • Size: 20.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.1

File hashes

Hashes for photonflux-0.2.0.tar.gz
Algorithm Hash digest
SHA256 4930a7df65b86cc69436bbb0df751f65f391b8ef00a0e8c593d095c2b8b3d116
MD5 8a98fa49bf12722e9a3c1308d9eb071f
BLAKE2b-256 e044f42037b1024f60f444c25819849fa5206f89bfceb208b16a0efa977c8881

See more details on using hashes here.

File details

Details for the file photonflux-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: photonflux-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 20.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.1

File hashes

Hashes for photonflux-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6e1fe680010df4a6d237217d1a6af6ca9643d23ceeb7bc87b00e26b4afc1cbd4
MD5 d987044fb77eaa04685d2ffeddf2234a
BLAKE2b-256 f0937b21b9eb1baedc5acfde3460b5642f3e98e729eaa4494924adfd3788cc26

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page