Skip to main content

python library to generate GDS layouts

Project description

gdsfactory 6.20.2

docs PyPI Conda Version Dockerhub PyPI Python issues forks GitHub stars Downloads Downloads Downloads MIT codecov black Binder Colab

logo

GDSfactory is a design automation tool for photonics and analog circuits.

You can describe your circuits in code (python or YAML), verify them (DRC, simulation) and analyze them.

It provides you with an end to end flow for building chips.

workflow

You can:

  • Design (Layout, Simulation, Optimization)
    • define parametric cells (PCells) functions in python or YAML. Define routes between component ports.
    • Test component settings, ports and geometry to avoid unwanted regressions.
    • Capture design intent in a schematic.
  • Verificate (DRC, DFM, LVS)
    • Run simulations directly from the layout thanks to the simulation interfaces. No need to draw the geometry more than once.
      • Run Component simulations (solve modes, FDTD, EME, TCAD, thermal ...)
      • Run Circuit simulations from the Component netlist (Sparameters, Spice ...)
      • Build Component models and study Design For Manufacturing.
    • Create DRC rule decks in Klayout.
    • Make sure complex layouts match their design intent (Layout Versus Schematic).
  • Validate
    • Make sure that as you define the layout you define the test sequence, so when the chips come back you already know how to test them.
    • Model extraction: extract the important parameters for each component.
    • Build a data pipeline from raw data, to structured data and dashboards for monitoring your chip performance.

As input, you write python or YAML code.

As output you write a GDSII or OASIS file that you can send to your foundry for fabrication. It also exports component settings (for measurement and data analysis) and netlists (for circuit simulations).

layout_to_components

flow

It provides you a common syntax for design (KLayout, gdstk, Ansys Lumerical, tidy3d, MEEP, MPB, DEVSIM, SAX, ...), verification and validation.

tool interfaces

Multiple Silicon Photonics foundries have gdsfactory PDKs available. Talk to your foundry to access their gdsfactory PDK.

You can also access:

Installation

Installation for new python users

If you don't have python installed on your system you can download the gdsfactory installer that includes python3, miniconda and all gdsfactory plugins.

Installation for new gdsfactory users

Open Mamba, Miniconda or Anaconda Prompt and then install using pip

anaconda prompt

pip install gdsfactory --upgrade
gf tool install

Installation for developers

For developers you need to fork the GitHub repository, git clone it (download it), git add, git commit, git push your improvement. Then pull request your changes to the main branch from the GitHub website. For that you can install gdsfactory locally on your computer in -e edit mode.

git clone https://github.com/gdsfactory/gdsfactory.git
cd gdsfactory
pip install -e . pre-commit
pre-commit install
gf tool install

Then you need to restart Klayout to make sure you activate the klayout gdsfactory integration.

Getting started

Acks

Contributors (in chronological order):

  • Joaquin Matres (Google): maintainer.
  • Damien Bonneau (PsiQuantum): cell decorator, Component routing functions, Klayout placer.
  • Pete Shadbolt (PsiQuantum): Klayout auto-placer, Klayout GDS interface (klive).
  • Troy Tamas (Rockley): get_route_from_steps, netlist driven flow (from_yaml).
  • Floris Laporte (Rockley): netlist extraction and circuit simulation interface with SAX.
  • Alec Hammond (Meta Reality Labs Research): Meep and MPB interface.
  • Simon Bilodeau (Princeton): Meep FDTD write Sparameters, TCAD device simulator.
  • Thomas Dorch (Freedom Photonics): for Meep's material database access, MPB sidewall angles, and add_pin_path.
  • Jan-David Fischbach (Black semiconductor): for improvements in pack_doe.
  • Igal Bayn (Google): for documentation improvements and suggestions.
  • Alex Sludds (MIT): for tiling fixes.
  • Momchil Minkov (Flexcompute): for tidy3d plugin.
  • Skandan Chandrasekar (BYU): for simphony, SiPANN plugins, A-star router.
  • Helge Gehring (Google): for simulation plugins (FEM heat solver), improving code quality and new components (spiral paths).
  • Tim Ansell (Google): for documentation improvements.
  • Ardavan Oskoii (Google): for Meep plugin documentation improvements.
  • Marc de Cea (MIT): for ge_detector, grating_coupler_dual, mmi_90degree_hybrid, coherent transceiver, receiver.
  • Bradley Snyder (PHIX): for grating_coupler snap to grid fixes.
  • Jonathan Cauchon (Ciena): for measurement database.
  • Raphaël Dubé-Demers (EXFO): for measurement database.
  • Bohan Zhang (Boston University): for grating coupler improvements.
  • Niko Savola (IQM): for optimization, notebook and code improvements.

Open source heroes:

  • Matthias Köfferlein: for Klayout
  • Lucas Heitzmann (University of Campinas, Brazil): for gdstk
  • Adam McCaughan (NIST): for phidl. Inspiration for geometry manipulation.
  • Alex Tait (Queens University): for lytest
  • Thomas Ferreira de Lima (NEC): for pip install klayout python API.
  • Juan Sanchez: for DEVSIM

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

gdsfactory-6.20.2.tar.gz (776.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gdsfactory-6.20.2-py3-none-any.whl (1.3 MB view details)

Uploaded Python 3

File details

Details for the file gdsfactory-6.20.2.tar.gz.

File metadata

  • Download URL: gdsfactory-6.20.2.tar.gz
  • Upload date:
  • Size: 776.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.1

File hashes

Hashes for gdsfactory-6.20.2.tar.gz
Algorithm Hash digest
SHA256 98cc518b2fdf7bf4b792edd95100ae9a1593cadc68685b7687e02893d97a9ffd
MD5 00108f6b3bad6f71cb218cf6e152d197
BLAKE2b-256 46820c530dc83a005ed328beb1fe1c7eed3b216501d5bed5f810156a5ab994d3

See more details on using hashes here.

File details

Details for the file gdsfactory-6.20.2-py3-none-any.whl.

File metadata

  • Download URL: gdsfactory-6.20.2-py3-none-any.whl
  • Upload date:
  • Size: 1.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.1

File hashes

Hashes for gdsfactory-6.20.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a2e5035f35ba339b38f12e76d3b9ca9d2e614bbfba84b208e3a564e7ed4cd533
MD5 3e40e6b0130f5b4da18b68fbd65c5567
BLAKE2b-256 8addc2cd135c5926df750f7cfcf6064fcf068ed105f580245ce3413f32ad6822

See more details on using hashes here.

Supported by

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