zeropdk

Zero PDK: python-based support for open source PDKs

https://github.com/lightwave-lab/zeropdk

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
    Links to: ieee.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.6%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Zero PDK: python-based support for open source PDKs

Basic Info
  • Host: GitHub
  • Owner: lightwave-lab
  • License: mit
  • Language: Python
  • Default Branch: master
  • Size: 4.57 MB
Statistics
  • Stars: 26
  • Watchers: 7
  • Forks: 8
  • Open Issues: 3
  • Releases: 3
Created over 7 years ago · Last pushed over 3 years ago
Metadata Files
Readme License Citation

README.md

ZeroPDK

This is a pure-python PDK factory that enables klayout scripted layout. It assists in photonic integrated circuit layout, which relies on having specialized curved waveguides and non-square-corner shapes.

Installation

This package is heavily based on python's klayout package, still in beta version as of this writing (Jul 2019).

Installation with pip (virtual environment is highly recommended):

bash pip install zeropdk

Installation from source:

bash python setup.py install

Features

KLayout extension

By importing zeropdk, klayout is patched with a few useful functionalities. For example:

```python import klayout.db as kdb import zeropdk

layout = kdb.Layout() plogo = layout.readcell(cellname='princetonlogo', filepath='gdslibrary/princetonlogo_simple.gds')

plogo is a cell in the current layout. It can be inserted in the top cell.

```

Easy technology layers definition

Based on a KLayout's layout properties file (.lyp) containing layer definitions, it is easy to import and use all layers. For example:

```python

from zeropdk import Tech lyppath = "examples/EBeam.lyp" EBeam = Tech.loadfromxml(lyppath) layerM1 = EBeam.layers["M1"] print(layerM1, type(layerM1)) # M1 (41/0) ```

The file above belongs to a project called SiEPIC EBeam PDK, used in passive silicon photonic foundries.

Advanced PCell definition

PCells can be hierarchical, as described in Sec. IV.C of this article. One PCell can use another PCell in its definition, and the parent pcell should, in this case, inherit the child's parameters. an example taken from zeropdk.default_library.io is:

```python class DCPadArray(DCPad): params = ParamContainer(padarraycount, padarraypitch)

def draw(self, cell):
    # ...
    for i in range(cp.pad_array_count):
        dcpad = DCPad(name=f"pad_{i}", params=cp)
    return cell, ports

```

In this case, DCPadArray simply places an array of DCPad Pcells, and contains parameters pad_array_count and also pad_array_pitch, but also the parameters belonging to DCPad, such as layer_metal and layer_opening.

In the EBeam PDK example, one can edit adapt a standard library of pcells to its own parameter sets. For example, EBeam PDK uses particular layers for its metal deposition and oxide etch steps. So the DCPadArray can be changed via the following:

```python

class DCPadArray(DCPadArray): params = ParamContainer( PCellParameter( name="layermetal", type=TypeLayer, description="Metal Layer", default=EBeam.layers["M1"], ), PCellParameter( name="layeropening", type=TypeLayer, description="Open Layer", default=EBeam.layers["13_MLopen"], ), ) ```

TODO: adapt example provided here to zeropdk.

Photonics-inspired layout functions

Several assistive tools for handling photonic shapes. For example, it is desired, sometimes, to draw a waveguide with progressive widths (a taper).

python from zeropdk.layout import layout_waveguide wav_polygon = layout_waveguide(cell, layer, points_list, width)

Developer notes

This project is still under development phase. See the development notes for more information.

Acknowledgements

This material is based in part upon work supported by the National Science Foundation under Grant Number E2CDA-1740262. Any opinions, findings, and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation.

Owner

  • Name: Lightwave Lab
  • Login: lightwave-lab
  • Kind: organization
  • Location: Princeton University

Research Group advised by Prof. Paul Prucnal

Citation (CITATION.cff)

# YAML 1.2
---
abstract: "This is a pure-python PDK factory that enables klayout scripted layout. It assists in photonic integrated circuit layout, which relies on having specialized curved waveguides and non-square-corner shapes."
authors:
  -
    family-names: "Ferreira de Lima"
    given-names: Thomas
cff-version: "1.1.0"
date-released: 2022-08-22
license: MIT
message: "If you use this software, please cite it using these metadata."
repository-code: "https://github.com/lightwave-lab/zeropdk"
title: zeropdk
version: "22.08"
...

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 2
  • Total pull requests: 7
  • Average time to close issues: 28 days
  • Average time to close pull requests: 2 months
  • Total issue authors: 1
  • Total pull request authors: 3
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.57
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • thomaslima (2)
Pull Request Authors
  • thomaslima (4)
  • joamatab (2)
  • simbilod (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 29 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 7
  • Total maintainers: 1
pypi.org: zeropdk

PDK factory for klayout

  • Versions: 7
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 29 Last month
Rankings
Dependent packages count: 10.1%
Stargazers count: 12.4%
Forks count: 12.6%
Dependent repos count: 21.6%
Average: 22.8%
Downloads: 57.4%
Maintainers (1)
Last synced: 10 months ago

Dependencies

dev-requirements.txt pypi
  • klayout * development
  • mypy * development
  • numpy * development
  • pytest * development
  • pytest-cov * development
  • scipy * development
setup.py pypi
  • numpy *
.github/workflows/python-publish.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/python-test.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite