# Gdspy’s Documentation

gdspy is a Python module that allows the creation of GDSII stream files.

Most features of the GDSII format are implemented, including support for polygons with any number of vertices.

GDSII format references:

- http://boolean.klaasholwerda.nl/interface/bnf/gdsformat.html

- http://www.artwork.com/gdsii/gdsii/

- http://www.buchanan1.net/stream_description.html

For installation instructions and other information, please check out the GitHub repository or the README file included with the source.

Table of Contents

- Getting Started
  - First GDSII
  - Polygons
    - Holes
    - Circles
    - Curves
    - Transformations
    - Layer and Datatype
  - References
  - Paths
    - Polygonal-Only Paths
    - Flexible Paths
    - Robust Paths
  - Text
  - Geometry Operations
    - Boolean Operations
    - Slice Operation
    - Offset Operation
    - Fillet Operation
  - GDSII Library
    - Units in GDSII
    - Saving a GDSII File
    - Loading a GDSII File
  - Examples
    - Integrated Photonics
    - Using System Fonts
- API Reference
  - Geometry Construction
    - PolygonSet
    - Polygon
    - Rectangle
    - Round
    - Text
    - Path
    - PolyPath
    - L1Path
    - FlexPath
    - RobustPath
    - Curve
    - Label
    - boolean
    - offset
    - slice
    - inside
    - copy
  - GDSII Library
    - Cell
    - CellReference
    - CellArray
    - GdsLibrary
    - GdsWriter
    - LayoutViewer
    - write_gds
    - gdsii_hash
    - get_binary_cells
    - get_gds_units

## Support

Help support the development of gdspy by donating: