masque/masque
2023-07-17 21:30:30 -07:00
..
builder Update comments 2023-07-17 21:30:30 -07:00
file don't keep track of y-mirroring separately from x 2023-04-14 22:20:40 -07:00
shapes Update comments 2023-07-17 21:30:30 -07:00
traits remove TODO labels from mypy #3004 comments 2023-07-17 21:30:30 -07:00
utils Update comments 2023-07-17 21:30:30 -07:00
__init__.py renderpather, get_bounds includes repetitions, Boundable 2023-04-13 17:54:52 -07:00
abstract.py don't keep track of y-mirroring separately from x 2023-04-14 22:20:40 -07:00
error.py add @oneshot decorator 2023-04-07 16:33:23 -07:00
label.py renderpather, get_bounds includes repetitions, Boundable 2023-04-13 17:54:52 -07:00
library.py add mutate_other arg 2023-07-17 21:30:30 -07:00
LICENSE.md Move from setuputils and setup.py to hatch and pyproject.toml 2023-01-11 17:37:36 -08:00
pattern.py add has_ports() 2023-07-17 21:30:30 -07:00
ports.py find_ptransform -> find_port_transform 2023-07-17 21:30:30 -07:00
py.typed add py.typed to enable type checking for downstream 2020-05-19 00:15:51 -07:00
README.md Move from setuputils and setup.py to hatch and pyproject.toml 2023-01-11 17:37:36 -08:00
ref.py speed up get_bounds when called on a manhattan ref 2023-07-17 21:30:30 -07:00
repetition.py remove TODO labels from mypy #3004 comments 2023-07-17 21:30:30 -07:00

Masque README

Masque is a Python module for designing lithography masks.

The general idea is to implement something resembling the GDSII file-format, but with some vectorized element types (eg. circles, not just polygons) and the ability to output to multiple formats.

Installation

Requirements:

  • python >= 3.11
  • numpy
  • klamath (optional, used for gdsii i/o)
  • matplotlib (optional, used for visualization functions and text)
  • ezdxf (optional, used for dxf i/o)
  • fatamorgana (optional, used for oasis i/o)
  • svgwrite (optional, used for svg output)
  • freetype (optional, used for text)

Install with pip:

pip install 'masque[visualization,oasis,dxf,svg,text]'

Alternatively, install from git

pip install git+https://mpxd.net/code/jan/masque.git@release

Glossary

  • Library: OASIS or GDS "library" or file (a collection of named cells)
  • Pattern: OASIS or GDS "Cell", DXF "Block"
  • Ref: GDS "AREF/SREF", OASIS "Placement"
  • Shape: OASIS or GDS "Geometry element", DXF "LWPolyline" or "Polyline"
  • repetition: OASIS "repetition". GDS "AREF" is a Ref combined with a Grid repetition.
  • Label: OASIS, GDS, DXF "Text".
  • annotation: OASIS or GDS "property"

TODO

  • Better interface for polygon operations (e.g. with pyclipper)
    • de-embedding
    • boolean ops
  • DOCS DOCS DOCS
  • Tests tests tests
  • check renderpather
  • pather and renderpather examples