Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/amccaugh/phidl

Python GDS layout and CAD geometry creation
https://github.com/amccaugh/phidl

boolean cad gds gdsii geometry layout python

Last synced: 3 months ago
JSON representation

Python GDS layout and CAD geometry creation

Lists

README 

        
[![pytest](https://github.com/amccaugh/phidl/actions/workflows/pytest.yml/badge.svg)](https://github.com/amccaugh/phidl/actions/workflows/pytest.yml)

[![pre-commit](https://github.com/amccaugh/phidl/actions/workflows/pre-commit.yml/badge.svg)](https://github.com/amccaugh/phidl/actions/workflows/pre-commit.yml)



# PHIDL

GDS scripting for Python that's intuitive, fast, and powerful.



- [**Installation / requirements**](#installation--requirements)

- [**Tutorial + examples**](https://phidl.readthedocs.io/en/latest/tutorials.html) (or [try an interactive notebook](https://mybinder.org/v2/gh/amccaugh/phidl/master?filepath=phidl_tutorial_example.ipynb))

- [**Geometry library + function documentation**](https://phidl.readthedocs.io/en/latest/geometry_reference.html)

- [Changelog](https://github.com/amccaugh/phidl/blob/master/CHANGELOG.md) (latest update 1.6.3 on July 20, 2023)

    - New `pg.fill_rectangle()` [examples and documentation](https://phidl.readthedocs.io/en/latest/geometry_reference.html#Fill-tool)



# Citation



If you found PHIDL useful, please consider citing it in (just one!) of your publications -- we appreciate it greatly. ([BibTeX](https://raw.githubusercontent.com/amccaugh/phidl/master/CITATION.bib))

 - McCaughan, A. N., et. al. PHIDL: Python-based layout and geometry creation for nanolithography. *J. Vac. Sci. Technol. B* 39, 062601 (2021). http://dx.doi.org/10.1116/6.0001203



# Gallery



           



# Installation / requirements

- Install or upgrade with `pip install -U phidl`

- Python version >=3.6

- If you are on Windows or Mac and don't already have `gdspy` installed, you will need a C++ compiler

    - For Windows + Python 3, install ["Build Tools for Visual Studio"](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2019) (make sure to check the "C++ build tools" checkbox when installing)

    - For Mac, install "Xcode" from the App Store, then run the command `xcode-select --install` in the terminal



# About PHIDL



*fiddle (verb) - /ˈfidl/ - to make minor manual movements, especially to adjust something*



PHIDL is an open-source GDS-based CAD tool for Python that significantly extends the excellent [gdspy](https://github.com/heitzmann/gdspy).  The base installation includes a large library of simple shapes (e.g. rectangles, circles), photonic structures (e.g. sine curve waveguides), and superconducting nanowire shapes (e.g. single photon detectors) that are fully parameterized. It also has a built-in quick-plotting function based on matplotlib (or Qt) that allows you view the state of any GDS object, useful when scripting geometry-making functions. It also has a [__geometry library reference__](https://phidl.readthedocs.io/) and a set of [__very thorough tutorials__](https://phidl.readthedocs.io/en/latest/tutorials.html) that will walk you through the process of getting acquainted with PHIDL.



The goal is to bring the usability of Illustrator / Inkscape drawing programs to the GDS scripting world. Like Python itself, it aims to be readable, and intuitive.  For instance, when building a geometry you don't have to worry about what the exact coordinates are anymore. If you want to separate two ellipses in the x direction by 5 units, you can do things like this:



`ellipse1.xmin = ellipse2.xmax + 5`



or if you want to move then rotate one ellipse by 45 degrees you can do



`ellipse2.move([1,7]).rotate(45)`



There's a few dozen shortcuts like this that make life easier built into PHIDL--they're simple, but they make a world of difference when you just want to e.g. space a ring resonator some distance from a waveguide without having to track each and every coordinate of the shape.



[](http://amccaugh.github.io/phidl)



![phidl example image](https://amccaugh.github.io/phidl/readme_1.png)



There's also a "port" functionality that allows you to snap together geometry like Legos without caring about where exactly the absolute coordinates of either geometry is.  For instance, connecting the above misaligned rectangles is a two-line command:



![phidl example image](https://amccaugh.github.io/phidl/readme_2.png)



It also allows you to do things like add text and create smooth or straight routing curves between "ports" of different devices, convenient for making electrical or optical connections:



![phidl example image](https://amccaugh.github.io/phidl/readme_3.png)

![phidl example image](https://amccaugh.github.io/phidl/readme_4.png)



Other useful functionality available are standard operations like booleans:



![phidl example image](https://amccaugh.github.io/phidl/readme_8.png)



 and less standard ones like creating outlines. A whole layout can be outlined directly in the GDS without requiring you to use Beamer (useful for positive-tone resist structures):



`pg.outline(D, distance = 0.7, layer = 4)`



![phidl example image](https://amccaugh.github.io/phidl/readme_5.png)



The geometry library also has useful resolution test-structures built into it, for instance



```

pg.litho_calipers(num_notches = 7, offset_per_notch = 0.1)

pg.litho_steps(line_widths = [1,2,4,8,16])

pg.litho_star(num_lines = 16, line_width = 3)

```



![phidl example image](https://amccaugh.github.io/phidl/readme_7.png)



There are also handy functions to help pack shapes into as small an area as possible:



```

pg.packer(D_list, spacing = 1.25, aspect_ratio = (2,1))

```



![phidl example image](https://amccaugh.github.io/phidl/packer.png)