Merge pull request #87 from amccaugh/dev

1.4.3

Author: amccaugh

CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 1.4.3 (Dec 11, 2020)
+
+### New features
+- Added `open_ports` argument to `pg.outline`, which allows you to cut holes in the outline at Port locations on a Device. See the [outline reference here](https://phidl.readthedocs.io/en/latest/geometry_reference.html#Outline)
+
+![phidl example image](https://amccaugh.github.io/phidl/outline_open_port.png)
+
+- Easier-to-read quickstart tutorial
+- Added `num_squares` to `info` dictionary of `pg.optimal_step` (thanks Ekkehart Schmidt)
+
+### Bugfixes
+- Fixed bug in `pp.smooth()` that forced paths to start out traveling to the right (orientation = 0 degrees) (thanks to Sebastian Pauka @spauka)
+
+
 ## 1.4.2 (Oct 7, 2020)
 
 Bugfix release

MANIFEST.in

@@ -0,0 +1 @@
+include LICENSE

README.md

@@ -6,7 +6,7 @@ GDS scripting that's intuitive, fast, and powerful.  For Python 2 and 3.
 - [**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/)
-- [Changelog](https://github.com/amccaugh/phidl/blob/master/CHANGELOG.md) (latest update 1.4.2 (Oct 7, 2020))
+- [Changelog](https://github.com/amccaugh/phidl/blob/master/CHANGELOG.md) (latest update 1.4.3, Dec 12, 2020)
   - Added font support to `pg.text()` [more info here](https://phidl.readthedocs.io/en/latest/geometry_reference.html#Text)
   - Added waypoint-based pathing `pp.smooth()`  [more info here](https://phidl.readthedocs.io/en/latest/tutorials/waveguides.html#Waypoint-based-path-creation)
   - You can now easily [`Group` objects together](https://phidl.readthedocs.io/en/latest/tutorials/group.html)

docs/geometry_reference.ipynb

@@ -6,6 +6,8 @@
 #==============================================================================
 # Minor TODO
 #==============================================================================
+# Add Group.get_polygons()
+# Allow Boolean to use Groups
 # Add Paths to quickplot2
 # Add pp.delay_sine(distance = 10, length = 20, num_periods = 2)
 # add wire_basic to phidl.routing.  also add endcap parameter
@@ -53,7 +55,7 @@
 import gdspy.library
 gdspy.library.use_current_library = False
 
-__version__ = '1.4.2'
+__version__ = '1.4.3'
 
 
 #==============================================================================

docs/tutorials/quickstart.ipynb

@@ -579,10 +579,9 @@ def boolean(A, B, operation, precision = 1e-4, num_divisions = [1, 1],
          for polygon in polygons]
     return D
 
-
 def outline(elements, distance = 1, precision = 1e-4, num_divisions = [1, 1],
             join = 'miter', tolerance = 2, join_first = True,
-            max_points = 4000, layer = 0):
+            max_points = 4000, open_ports = False, layer = 0):
     """ Creates an outline around all the polygons passed in the `elements`
     argument. `elements` may be a Device, Polygon, or list of Devices.
 
@@ -611,8 +610,13 @@ def outline(elements, distance = 1, precision = 1e-4, num_divisions = [1, 1],
         adjacent polygon sides.
     max_points : int
         The maximum number of vertices within the resulting polygon.
+    open_ports : bool or float
+        If not False, holes will be cut in the outline such that the Ports are
+        not covered. If True, the holes will have the same width as the Ports.
+        If a float, the holes will be be widened by that value (useful for fully
+        clearing the outline around the Ports for positive-tone processes
     layer : int, array-like[2], or set
-        Specific layer(s) to put polygon geometry on.
+        Specific layer(s) to put polygon geometry on.)
 
     Returns
     -------
@@ -621,18 +625,37 @@ def outline(elements, distance = 1, precision = 1e-4, num_divisions = [1, 1],
     """
     D = Device('outline')
     if type(elements) is not list: elements = [elements]
+    port_list = []
     for e in elements:
-        if isinstance(e, Device): D.add_ref(e)
+        if isinstance(e, Device):
+            D.add_ref(e)
+            port_list += list(e.ports.values())
         else: D.add(e)
     gds_layer, gds_datatype = _parse_layer(layer)
 
     D_bloated = offset(D, distance = distance, join_first = join_first,
                        num_divisions = num_divisions, precision = precision,
                        max_points = max_points, join = join,
                        tolerance = tolerance, layer = layer)
-    Outline = boolean(A = D_bloated, B = D, operation = 'A-B',
+
+    Trim = Device()
+    if open_ports is not False:
+        if open_ports is True:
+            trim_width = 0
+        else:
+            trim_width = open_ports*2
+        for port in port_list:
+            trim = compass(size=(distance + 6*precision,
+                                 port.width + trim_width))
+            trim_ref = Trim << trim
+            trim_ref.connect('E', port, overlap = 2*precision)
+
+    Outline = boolean(A = D_bloated, B = [D,Trim], operation = 'A-B',
                       num_divisions = num_divisions, max_points = max_points,
                       precision = precision, layer = layer)
+    if open_ports is not False and len(elements) == 1:
+        for port in port_list:
+            Outline.add_port(port=port)
     return Outline
 
 
@@ -4407,6 +4430,9 @@ def fh(eta):
 
         ypts[-1] = end_width
         ypts[0] = start_width
+        y_num_sq = np.array(ypts)
+        x_num_sq = np.array(xpts)
+
         if symmetric == False:
             xpts.append(xpts[-1])
             ypts.append(0)
@@ -4445,6 +4471,7 @@ def fh(eta):
         D.add_port(name = 2, midpoint = [max(xpts), 0], width = end_width,
                    orientation = 0)
 
+    D.info['num_squares'] = np.sum(np.diff(x_num_sq) /((y_num_sq[:-1] + y_num_sq[1:])/2) )
     return D
 
 

phidl/device_layout.py

@@ -351,7 +351,9 @@ def smooth(
     new_points.append( [points[-1,:]] )
     new_points = np.concatenate(new_points)
 
-    P = Path(new_points)
+    P = Path()
+    P.rotate(theta[0])
+    P.append(new_points)
     P.move(points[0,:])
 
     return P

phidl/geometry.py

@@ -18,7 +18,7 @@
 
 
 setup(name='phidl',
-      version='1.4.2',
+      version='1.4.3',
       description='PHIDL',
       long_description = long_description,
       long_description_content_type='text/markdown',