prefab 1.1.5__py3-none-any.whl → 1.1.6__py3-none-any.whl

prefab/shapes.py

@@ -1,21 +1,23 @@
 """Contains functions for creating various shapes as Device objects."""
 
+from typing import Optional
+
 import numpy as np
 from skimage.draw import polygon
 
 from .device import Device
 
 
-def rectangle(width: int = 200, height: int = None, **kwargs) -> Device:
+def rectangle(width: int = 200, height: Optional[int] = None, **kwargs) -> Device:
     """
     Create a Device object with a rectangular shape.
 
     Parameters
     ----------
-    width : int, optional
+    width : int
         The width of the rectangle. Defaults to 200.
-    height : int, optional
-        The height of the rectangle. Defaults to the value of width.
+    height : Optional[int]
+        The height of the rectangle. Defaults to the value of width if None.
     **kwargs : dict
         Additional keyword arguments to be passed to the Device constructor.
 
@@ -26,24 +28,23 @@ def rectangle(width: int = 200, height: int = None, **kwargs) -> Device:
     """
     if height is None:
         height = width
-    rectangle = np.zeros((height, width))
-    rectangle[:, :] = 1
+    rectangle = np.ones((height, width))
     return Device(device_array=rectangle, **kwargs)
 
 
 def window(
-    width: int = 200, height: int = None, border_width: int = 60, **kwargs
+    width: int = 200, height: Optional[int] = None, border_width: int = 60, **kwargs
 ) -> Device:
     """
-    Create a Device object with a window shape (hollow square).
+    Create a Device object with a window shape (hollow rectangle).
 
     Parameters
     ----------
-    width : int, optional
+    width : int
         The overall width of the window. Defaults to 200.
-    height : int, optional
+    height : Optional[int]
         The overall height of the window. Defaults to the value of width.
-    border_width : int, optional
+    border_width : int
         The width of the window border. Defaults to 60.
     **kwargs : dict
         Additional keyword arguments to be passed to the Device constructor.
@@ -64,18 +65,18 @@ def window(
 
 
 def cross(
-    width: int = 200, height: int = None, arm_width: int = 60, **kwargs
+    width: int = 200, height: Optional[int] = None, arm_width: int = 60, **kwargs
 ) -> Device:
     """
     Create a Device object with a cross shape.
 
     Parameters
     ----------
-    width : int, optional
+    width : int
         The overall width of the cross. Defaults to 200.
-    height : int, optional
+    height : Optional[int]
         The overall height of the cross. Defaults to the value of width.
-    arm_width : int, optional
+    arm_width : int
         The width of the cross arms. Defaults to 60.
     **kwargs : dict
         Additional keyword arguments to be passed to the Device constructor.
@@ -97,18 +98,18 @@ def cross(
 
 
 def target(
-    width: int = 200, height: int = None, arm_width: int = 60, **kwargs
+    width: int = 200, height: Optional[int] = None, arm_width: int = 60, **kwargs
 ) -> Device:
     """
     Create a Device object with a target shape (cross with center removed).
 
     Parameters
     ----------
-    width : int, optional
+    width : int
         The overall width of the target. Defaults to 200.
-    height : int, optional
+    height : Optional[int]
         The overall height of the target. Defaults to the value of width.
-    arm_width : int, optional
+    arm_width : int
         The width of the target arms. Defaults to 60.
     **kwargs : dict
         Additional keyword arguments to be passed to the Device constructor.
@@ -133,15 +134,15 @@ def target(
     return Device(device_array=target, **kwargs)
 
 
-def disk(width: int = 200, height: int = None, **kwargs) -> Device:
+def disk(width: int = 200, height: Optional[int] = None, **kwargs) -> Device:
     """
     Create a Device object with an elliptical shape.
 
     Parameters
     ----------
-    width : int, optional
+    width : int
         The width of the ellipse. Defaults to 200.
-    height : int, optional
+    height : Optional[int]
         The height of the ellipse. Defaults to the value of width.
     **kwargs : dict
         Additional keyword arguments to be passed to the Device constructor.
@@ -163,18 +164,18 @@ def disk(width: int = 200, height: int = None, **kwargs) -> Device:
 
 
 def ring(
-    width: int = 200, height: int = None, border_width: int = 60, **kwargs
+    width: int = 200, height: Optional[int] = None, border_width: int = 60, **kwargs
 ) -> Device:
     """
-    Create a Device object with a ring shape.
+    Create a Device object with a ring shape (hollow ellipse).
 
     Parameters
     ----------
-    width : int, optional
+    width : int
         The overall width of the ring. Defaults to 200.
-    height : int, optional
+    height : Optional[int]
         The overall height of the ring. Defaults to the value of width.
-    border_width : int, optional
+    border_width : int
         The width of the ring border. Defaults to 60.
     **kwargs : dict
         Additional keyword arguments to be passed to the Device constructor.
@@ -206,11 +207,11 @@ def disk_wavy(
 
     Parameters
     ----------
-    width : int, optional
+    width : int
         The overall width and height of the wavy circle. Defaults to 200.
-    wave_amplitude : float, optional
+    wave_amplitude : float
         The amplitude of the waves. Defaults to 10.
-    wave_frequency : float, optional
+    wave_frequency : float
         The frequency of the waves. Defaults to 10.
     **kwargs : dict
         Additional keyword arguments to be passed to the Device constructor.
@@ -233,18 +234,18 @@ def disk_wavy(
 
 
 def pie(
-    width: int = 200, height: int = None, arc_angle: float = 270, **kwargs
+    width: int = 200, height: Optional[int] = None, arc_angle: float = 270, **kwargs
 ) -> Device:
     """
     Create a Device object with a pie shape.
 
     Parameters
     ----------
-    width : int, optional
+    width : int
         The width of the pie. Defaults to 200.
-    height : int, optional
+    height : Optional[int]
         The height of the pie. Defaults to the value of width.
-    arc_angle : float, optional
+    arc_angle : float
         The angle of the pie slice in degrees. Defaults to 270.
     **kwargs : dict
         Additional keyword arguments to be passed to the Device constructor.
@@ -279,13 +280,13 @@ def grating(
 
     Parameters
     ----------
-    height : int, optional
+    height : int
         The height of the grating. Defaults to 200.
-    pitch : int, optional
+    pitch : int
         The pitch (period) of the grating. Defaults to 120.
-    duty_cycle : float, optional
+    duty_cycle : float
         The duty cycle of the grating. Defaults to 0.5.
-    num_gratings : int, optional
+    num_gratings : int
         The number of grating periods. Defaults to 3.
     **kwargs : dict
         Additional keyword arguments to be passed to the Device constructor.
@@ -310,9 +311,9 @@ def star(width: int = 200, num_points: int = 5, **kwargs) -> Device:
 
     Parameters
     ----------
-    width : int, optional
+    width : int
         The overall width and height of the star. Defaults to 200.
-    num_points : int, optional
+    num_points : int
         The number of points on the star. Defaults to 5.
     **kwargs : dict
         Additional keyword arguments to be passed to the Device constructor.
@@ -350,9 +351,9 @@ def poly(width: int = 200, num_points: int = 5, **kwargs) -> Device:
 
     Parameters
     ----------
-    width : int, optional
+    width : int
         The overall width and height of the polygon. Defaults to 200.
-    num_points : int, optional
+    num_points : int
         The number of sides of the polygon. Defaults to 5.
     **kwargs : dict
         Additional keyword arguments to be passed to the Device constructor.
@@ -382,11 +383,11 @@ def radial_grating(
 
     Parameters
     ----------
-    width : int, optional
+    width : int
         The overall width and height of the radial grating. Defaults to 200.
-    grating_skew : int, optional
+    grating_skew : int
         The skew angle of the grating arms. Defaults to 0.
-    num_gratings : int, optional
+    num_gratings : int
         The number of grating arms. Defaults to 6.
     **kwargs : dict
         Additional keyword arguments to be passed to the Device constructor.
@@ -429,13 +430,13 @@ def offset_grating(
 
     Parameters
     ----------
-    height : int, optional
+    height : int
         The height of the grating. Defaults to 200.
-    pitch : int, optional
+    pitch : int
         The pitch (period) of the grating. Defaults to 120.
-    duty_cycle : float, optional
+    duty_cycle : float
         The duty cycle of the grating. Defaults to 0.5.
-    num_gratings : int, optional
+    num_gratings : int
         The number of grating periods. Defaults to 3.
     **kwargs : dict
         Additional keyword arguments to be passed to the Device constructor.
@@ -458,9 +459,9 @@ def offset_grating(
     return Device(device_array=grating, **kwargs)
 
 
-def L_grating(
+def l_grating(
     width: int = 200,
-    height: int = None,
+    height: Optional[int] = None,
     pitch: int = 100,
     duty_cycle: float = 0.5,
     **kwargs,
@@ -470,13 +471,13 @@ def L_grating(
 
     Parameters
     ----------
-    width : int, optional
+    width : int
         The width of the L-grating. Defaults to 200.
-    height : int, optional
+    height : Optional[int]
         The height of the L-grating. Defaults to the value of width.
-    pitch : int, optional
+    pitch : int
         The pitch (period) of the L-shapes. Defaults to 100.
-    duty_cycle : float, optional
+    duty_cycle : float
         The duty cycle of the L-shapes. Defaults to 0.5.
     **kwargs : dict
         Additional keyword arguments to be passed to the Device constructor.
@@ -506,13 +507,13 @@ def disks(
 
     Parameters
     ----------
-    rows : int, optional
+    rows : int
         The number of rows in the grid. Defaults to 5.
-    cols : int, optional
+    cols : int
         The number of columns in the grid. Defaults to 5.
-    disk_radius : int, optional
+    disk_radius : int
         The radius of each disk. Defaults to 30.
-    spacing : int, optional
+    spacing : int
         The spacing between disk centers. Defaults to 60.
     **kwargs : dict
         Additional keyword arguments to be passed to the Device constructor.
@@ -546,13 +547,13 @@ def disks_offset(
 
     Parameters
     ----------
-    rows : int, optional
+    rows : int
         The number of rows in the grid. Defaults to 5.
-    cols : int, optional
+    cols : int
         The number of columns in the grid. Defaults to 5.
-    disk_radius : int, optional
+    disk_radius : int
         The radius of each disk. Defaults to 30.
-    spacing : int, optional
+    spacing : int
         The spacing between disk centers. Defaults to 30.
     **kwargs : dict
         Additional keyword arguments to be passed to the Device constructor.
@@ -597,15 +598,15 @@ def disks_varying(
 
     Parameters
     ----------
-    rows : int, optional
+    rows : int
         The number of rows in the grid. Defaults to 5.
-    cols : int, optional
+    cols : int
         The number of columns in the grid. Defaults to 5.
-    min_disk_radius : int, optional
+    min_disk_radius : int
         The minimum radius of the disks. Defaults to 10.
-    max_disk_radius : int, optional
+    max_disk_radius : int
         The maximum radius of the disks. Defaults to 30.
-    spacing : int, optional
+    spacing : int
         The spacing between disk centers. Defaults to 30.
     **kwargs : dict
         Additional keyword arguments to be passed to the Device constructor.
@@ -643,13 +644,13 @@ def holes(
 
     Parameters
     ----------
-    rows : int, optional
+    rows : int
         The number of rows in the grid. Defaults to 5.
-    cols : int, optional
+    cols : int
         The number of columns in the grid. Defaults to 5.
-    hole_radius : int, optional
+    hole_radius : int
         The radius of each hole. Defaults to 30.
-    spacing : int, optional
+    spacing : int
         The spacing between hole centers. Defaults to 30.
     **kwargs : dict
         Additional keyword arguments to be passed to the Device constructor.
@@ -683,13 +684,13 @@ def holes_offset(
 
     Parameters
     ----------
-    rows : int, optional
+    rows : int
         The number of rows in the grid. Defaults to 5.
-    cols : int, optional
+    cols : int
         The number of columns in the grid. Defaults to 5.
-    hole_radius : int, optional
+    hole_radius : int
         The radius of each hole. Defaults to 30.
-    spacing : int, optional
+    spacing : int
         The spacing between hole centers. Defaults to 30.
     **kwargs : dict
         Additional keyword arguments to be passed to the Device constructor.
@@ -734,15 +735,15 @@ def holes_varying(
 
     Parameters
     ----------
-    rows : int, optional
+    rows : int
         The number of rows in the grid. Defaults to 5.
-    cols : int, optional
+    cols : int
         The number of columns in the grid. Defaults to 5.
-    min_hole_radius : int, optional
+    min_hole_radius : int
         The minimum radius of the holes. Defaults to 10.
-    max_hole_radius : int, optional
+    max_hole_radius : int
         The maximum radius of the holes. Defaults to 30.
-    spacing : int, optional
+    spacing : int
         The spacing between hole centers. Defaults to 30.
     **kwargs : dict
         Additional keyword arguments to be passed to the Device constructor.

{prefab-1.1.5.dist-info → prefab-1.1.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: prefab
-Version: 1.1.5
+Version: 1.1.6
 Summary: Artificial nanofabrication of integrated photonic circuits using deep learning
 Project-URL: Homepage, https://prefabphotonics.com
 Project-URL: Repository, https://github.com/PreFab-Photonics/PreFab
@@ -535,6 +535,8 @@ Description-Content-Type: text/markdown
 
 PreFab is a _virtual nanofabrication environment_ that leverages **deep learning** and **computer vision** to predict and correct for structural variations in integrated photonic devices during nanofabrication.
 
+> **Try Rosette**: Want a more visual experience? Try [Rosette](https://rosette.dev) - our new layout tool with PreFab models built in, designed for rapid chip design.
+
 ## Prediction
 
 PreFab predicts process-induced structural variations, including corner rounding, loss of small lines and islands, filling of narrow holes and channels, sidewall angle deviations, and stochastic effects. This allows designers to rapidly prototype and evaluate expected performance pre-fabrication.

prefab-1.1.6.dist-info/RECORD

@@ -0,0 +1,13 @@
+prefab/__init__.py,sha256=gFae7gbaHFCprllsaX1Cb3JR-nXhZbwvnmgrYnU8XLo,425
+prefab/__main__.py,sha256=CGb63UhUkN_4_GpS3twqT1613OBeuli-qBiLMHORZU4,2987
+prefab/compare.py,sha256=Witv9jm3MnIwVTJe8goOP9JZw3RUTqxyIF6PhQtcaPY,3532
+prefab/device.py,sha256=1rqs_VQ7am6W473C-EZTsPFDlqNIMMd26VZAUV1tNS0,54885
+prefab/geometry.py,sha256=4fekWMlkdS_qlPNTdPXPhwKuQ5qdQ1Zjf8m9JKd1dA8,12049
+prefab/models.py,sha256=JpBqNFIqbo1ymKEl0NWWF4ZkhvK23rEVVBEFl05TXCI,3671
+prefab/predict.py,sha256=1yQgujZe-QtjZtOQWKcmEFKDt_EH35A83UyTUQO3p14,11731
+prefab/read.py,sha256=WNqC3xENlndzFwXeCF2E7H3Iq2dO_6rPEPZ58DuloqY,16259
+prefab/shapes.py,sha256=58cyXFNh1kEErq2jEbGd3dWSediU1OSmor_FWwc1V8A,25098
+prefab-1.1.6.dist-info/METADATA,sha256=_g2pPvFjqXfVL0P9O6z8jXPf8zAIdRVUoSaN3hbW3aY,34993
+prefab-1.1.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+prefab-1.1.6.dist-info/licenses/LICENSE,sha256=IMF9i4xIpgCADf0U-V1cuf9HBmqWQd3qtI3FSuyW4zE,26526
+prefab-1.1.6.dist-info/RECORD,,

{prefab-1.1.5.dist-info → prefab-1.1.6.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.25.0
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any

prefab-1.1.5.dist-info/RECORD

@@ -1,13 +0,0 @@
-prefab/__init__.py,sha256=0QHTuxxeHo3xJIUq20iQCLiC2nk-rgf2C374l-Aby-g,425
-prefab/__main__.py,sha256=aAgt1WXa44k1nJqsiSD3uAfNeGpwtjWqMUYCHN5_Qrw,2759
-prefab/compare.py,sha256=iz0H5EvZFZ5O-N2QOQ6wFe-Hftkfyd6oMYpjfjnrMIw,3251
-prefab/device.py,sha256=kKmud8QxfSBvadeZw56W_MNXqjRIyTA16jNTQ8v69U0,53048
-prefab/geometry.py,sha256=0sa6ietUWZGkxOnUPUzD3q2QpFuOpWkSANoopGpPd6s,11035
-prefab/models.py,sha256=JpBqNFIqbo1ymKEl0NWWF4ZkhvK23rEVVBEFl05TXCI,3671
-prefab/predict.py,sha256=upGTeNC6vY9Tdko6JEM0gKQH1PGUVYXACpep1OT8EVs,10593
-prefab/read.py,sha256=MuF-cugFQ7MWBJ8DOvQuwktIk0fJ8PXBeLye0ydrB8o,14734
-prefab/shapes.py,sha256=2qaqyNzu5WG3wVdk4oQzeNXmhwXRHcPnRZlgRrM4MoA,25576
-prefab-1.1.5.dist-info/METADATA,sha256=tk_MMU6lQcjqt4FBDgjx87ziII0ulouu2zCj2Ayr-g8,34824
-prefab-1.1.5.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-prefab-1.1.5.dist-info/licenses/LICENSE,sha256=IMF9i4xIpgCADf0U-V1cuf9HBmqWQd3qtI3FSuyW4zE,26526
-prefab-1.1.5.dist-info/RECORD,,