Skip to content

Commit 743f32d

Browse files
committed
updated docs
1 parent 79e5930 commit 743f32d

File tree

1 file changed

+23
-12
lines changed

1 file changed

+23
-12
lines changed

docs/index.rst

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,40 @@
1-
**************************************
2-
Welcome to gdshelpers's documentation!
3-
**************************************
1+
*****************************************
2+
Welcome to the gdshelpers' documentation!
3+
*****************************************
44

5-
The gdshelper is primarily a design help for gds files, developed primarily for integrated optics design. It builds
6-
on the shoulder of the `Shapely <http://toblerity.org/shapely/index.html>`_ project. Please make sure that you have an initial understanding of this. Afterwards this package should be simple to understand.
5+
The gdshelpers-package is a design framework for lithography-pattern files, developed primarily for integrated optics.
6+
It builds on the shoulder of the `Shapely <http://toblerity.org/shapely/index.html>`_ project.
7+
Please make sure that you have an initial understanding of this.
8+
Afterwards this package should be simple to understand.
79

8-
It includes adapters to convert any Shapely object to gdsCAD/gdspy objects - including correct fracturing of polygons and
10+
It includes adapters to convert any Shapely objects to gdsCAD/gdspy objects - including correct fracturing of polygons and
911
lines in elements with less than 200 points. An archaic restriction of the GDII file format.
10-
Furthermore, it allows to save the design in the more recent OASIS-format, which allows smaller files-sizes and has less restrictions.
11-
The user can use an abstraction layer above these libraries, which allows convenient exchange of the underlying library and therefore changing the export-format by a simple command.
12+
Furthermore, it allows to save the design in the more recent OASIS-format using the fatamorgana-library, which allows smaller files-sizes and has less restrictions.
13+
The user can use an abstraction layer above these libraries, which allows convenient exchange of the underlying library and therefore changing the export-format by a parameter.
1214

1315
In addition it includes a growing selection of optical and superconducting parts, including:
1416

1517
* A waveguide part, allowing easy chaing of bends and straight waveguides.
1618

1719
- Includes parameterized paths and Bézier curves.
1820
- Automatic smooth connection to a target point/port
19-
* Y-splitter, MMI-splitters, Directional splitter
21+
- The size of the waveguide can be tapered (linear or by a user defined function), which can e.g. be used for optical edge coupling or electronic contact pads
22+
* Different types of splitters:
23+
24+
- Y-splitter
25+
- MMI-splitters
26+
- Directional splitter
2027
* Couplers
28+
29+
- Grating couplers (allowing apodized gratings)
30+
- Tapers for hybrid 3D-integration
2131
* Ring and racetrack resonators
22-
* Mach-Zehnder interferometer
32+
* Mach-Zehnder interferometers
2333
* Spirals
2434
* Superconducting nanowire single photon detectors (SNSPDs)
25-
* Superconducting nanoscale Transistors
26-
* Different types of markers, QRcodes
35+
* Superconducting nanoscale Transistors (NTRONs)
36+
* Different types of markers
37+
* QRcodes
2738
* A possibility to include images
2839
* Text-elements for labeling the structures
2940

0 commit comments

Comments
 (0)