samplemaker-sparrow 5.4.5__tar.gz → 5.4.7__tar.gz

samplemaker_sparrow-5.4.7/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

samplemaker_sparrow-5.4.7/.github/ISSUE_TEMPLATE/fault.yml

@@ -0,0 +1,81 @@
+name: Fault
+description: Report a bug or unexpected behavior
+title: "Fault: "
+labels: ["fault", "needs-triage"]
+body:
+  - type: checkboxes
+    id: preflight
+    attributes:
+      label: Before filing
+      options:
+        - label: I have searched existing issues and this is not a duplicate
+          required: true
+
+  - type: textarea
+    id: what
+    attributes:
+      label: What is broken?
+      description: Which tool, system, or process is affected?
+      placeholder: "e.g. The data export stops partway through and shows an error"
+    validations:
+      required: true
+
+  - type: dropdown
+    id: regression
+    attributes:
+      label: Is this a regression?
+      description: Did this work correctly before?
+      options:
+        - "Unknown"
+        - "Yes - it worked before"
+        - "No - it has never worked"
+    validations:
+      required: false
+
+  - type: textarea
+    id: environment
+    attributes:
+      label: Where did this happen?
+      placeholder: |
+        - Computer / OS:
+        - Software version:
+        - Equipment:
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: What were you doing when it happened?
+      description: Step by step if possible.
+      placeholder: |
+        1.
+        2.
+        3.
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: What did you expect to happen?
+      placeholder: "e.g. The export completed and a file appeared in the output folder"
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual
+    attributes:
+      label: What actually happened?
+      placeholder: "e.g. The program showed an error message and closed"
+    validations:
+      required: true
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Error messages (if any)
+      description: Copy and paste any error text here.
+      render: shell
+    validations:
+      required: false

samplemaker_sparrow-5.4.7/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,42 @@
+name: Feature request
+description: Suggest an idea for this project
+title: "Feature: "
+labels: ["feature", "needs-triage"]
+body:
+  - type: textarea
+    id: need
+    attributes:
+      label: What problem does this solve?
+      description: Focus on the need, not the solution.
+      placeholder: "e.g. We have to manually copy files after every run, which takes time and is easy to forget"
+    validations:
+      required: true
+  - type: textarea
+    id: proposal
+    attributes:
+      label: What would you like it to do?
+      placeholder: "e.g. Automatically save results to a shared folder at the end of each run"
+    validations:
+      required: true
+  - type: textarea
+    id: constraints
+    attributes:
+      label: Any requirements or limitations?
+      placeholder: "e.g. Must work without an internet connection; needs to support existing file formats"
+    validations:
+      required: false
+  - type: textarea
+    id: acceptance
+    attributes:
+      label: How will we know it is done?
+      placeholder: |
+        - [ ]
+        - [ ]
+    validations:
+      required: true
+  - type: textarea
+    id: context
+    attributes:
+      label: Anything else?
+    validations:
+      required: false

samplemaker_sparrow-5.4.7/.github/ISSUE_TEMPLATE/improvement.yml

@@ -0,0 +1,34 @@
+name: Improvement
+description: Suggest an improvement to this project
+title: "Improvement: "
+labels: ["improvement", "needs-triage"]
+body:
+  - type: textarea
+    id: current
+    attributes:
+      label: What is the problem with how it works today?
+      placeholder: "e.g. The search only matches exact words, so it is easy to miss results with slightly different names"
+    validations:
+      required: true
+  - type: textarea
+    id: proposed
+    attributes:
+      label: What would better look like?
+      placeholder: "e.g. Search should still find results when words are partially typed or spelled differently"
+    validations:
+      required: true
+  - type: textarea
+    id: acceptance
+    attributes:
+      label: How will we know it is done?
+      placeholder: |
+        - [ ]
+        - [ ]
+    validations:
+      required: true
+  - type: textarea
+    id: context
+    attributes:
+      label: Anything else?
+    validations:
+      required: false

{samplemaker_sparrow-5.4.5 → samplemaker_sparrow-5.4.7}/.gitignore

@@ -26,6 +26,9 @@ dist/
 # JetBrains IDE
 .idea/
 
+# Visual Studio Code
+.vscode/
+
 # Unit test reports
 TEST*.xml
 
@@ -54,7 +57,7 @@ Thumbs.db
 *.gds
 src/boopy/*.pro.user
 html/
-tests/
+
 # Python build artifacts
 build/
 *.egg-info/

{samplemaker_sparrow-5.4.5 → samplemaker_sparrow-5.4.7}/BUILD.md

@@ -45,7 +45,19 @@ pip install -e .
 ```
 
 ### macOS
-Work in progress...
+
+Install the required packages using Homebrew:
+```bash
+brew install cmake boost
+```
+
+Navigate to the project directory and build:
+```bash
+# Using Astral uv (recommended)
+uv sync
+# Using pip
+pip install -e .
+```
 
 ### Windows
 To build on Windows, ensure you have Visual Studio with C++ build tools installed.
@@ -113,7 +125,15 @@ cibuildwheel .
 ```
 
 ### macOS
-Work in progress...
+On macOS, you can build wheels directly without Docker. Run the following command in the project directory:
+```bash
+# Using Astral uv (recommended)
+uvx cibuildwheel .
+
+# Using pip
+pip install cibuildwheel
+cibuildwheel .
+```
 
 ### Windows
 To build Windows wheels locally, the correct version of `vcpkg` must be added to the PATH environment variable.

{samplemaker_sparrow-5.4.5 → samplemaker_sparrow-5.4.7}/PKG-INFO

@@ -1,25 +1,25 @@
 Metadata-Version: 2.4
 Name: samplemaker-sparrow
-Version: 5.4.5
+Version: 5.4.7
 Summary: Lithographic mask design package
-Author-Email: Leonardo Midolo <midolo@nbi.ku.dk>
+Author-Email: Leonardo Midolo <midolo@nbi.ku.dk>, Jeppe Roulund <jeppe.roulund@sparrowquantum.com>
 License-Expression: BSD-3-Clause
 License-File: LICENSE.md
 Classifier: Programming Language :: C++
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: MacOS
 Classifier: Operating System :: Unix
 Classifier: Operating System :: POSIX :: Linux
-Project-URL: Repository, https://github.com/lmidolo/samplemaker.git
-Requires-Python: <3.14,>=3.10
-Requires-Dist: matplotlib>=3.7.5
+Project-URL: Repository, https://github.com/SparrowQuantum/samplemaker.git
+Requires-Python: <3.15,>=3.11
+Requires-Dist: matplotlib>=3.10.5
 Requires-Dist: numpy==2.*
 Description-Content-Type: text/markdown
 
@@ -37,4 +37,10 @@ the European Research Council (ERC) under the European Union’s Horizon 2020 re
 
 ### How do I get set up?
 
-* For local development build instructions, please refer to [BUILD.md](BUILD.md).
+The package can be installed on most platforms via pip:
+
+```bash
+pip install samplemaker-sparrow
+```
+
+For local development build instructions, please refer to [BUILD.md](https://github.com/SparrowQuantum/samplemaker/blob/master/BUILD.md).

{samplemaker_sparrow-5.4.5 → samplemaker_sparrow-5.4.7}/README.md

@@ -12,4 +12,10 @@ the European Research Council (ERC) under the European Union’s Horizon 2020 re
 
 ### How do I get set up?
 
-* For local development build instructions, please refer to [BUILD.md](BUILD.md).
+The package can be installed on most platforms via pip:
+
+```bash
+pip install samplemaker-sparrow
+```
+
+For local development build instructions, please refer to [BUILD.md](https://github.com/SparrowQuantum/samplemaker/blob/master/BUILD.md).

{samplemaker_sparrow-5.4.5 → samplemaker_sparrow-5.4.7}/pyproject.toml

@@ -5,16 +5,17 @@ build-backend = "scikit_build_core.build"
 [project]
 name = "samplemaker-sparrow"
 authors = [
-    { name = "Leonardo Midolo", email = "midolo@nbi.ku.dk"}
+    { name = "Leonardo Midolo", email = "midolo@nbi.ku.dk"},
+    { name = "Jeppe Roulund", email = "jeppe.roulund@sparrowquantum.com"}
 ]
 description = "Lithographic mask design package"
 readme = "README.md"
-requires-python = ">=3.10,<3.14"
+requires-python = ">=3.11,<3.15"
 license-files = ["LICENSE.md"]
 license = "BSD-3-Clause"
-version = "5.4.5"
+version = "5.4.7"
 dependencies = [
-    "matplotlib>=3.7.5",
+    "matplotlib>=3.10.5",
     "numpy==2.*",
 ]
 classifiers = [
@@ -22,10 +23,10 @@ classifiers = [
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3 :: Only",
-    "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     "Operating System :: Microsoft :: Windows",
     "Operating System :: MacOS",
     "Operating System :: Unix",
@@ -33,7 +34,7 @@ classifiers = [
 ]
 
 [project.urls]
-Repository = "https://github.com/lmidolo/samplemaker.git"
+Repository = "https://github.com/SparrowQuantum/samplemaker.git"
 
 [tool.scikit-build]
 minimum-version = "0.11.6"
@@ -44,6 +45,9 @@ wheel.packages = ["src/samplemaker"]
 
 [tool.cibuildwheel]
 skip = ["*-musllinux*", "*-win32*"]
+test-requires = "pytest"
+test-sources = ["tests"]
+test-command = "pytest {project}/tests"
 
 [tool.cibuildwheel.linux]
 before-all = "yum install -y boost-devel"
@@ -56,3 +60,9 @@ environment = { BOOST_ROOT = "C:/vcpkg/installed/x64-windows" }
 before-all = [
     "vcpkg install boost-polygon:x64-windows",
 ]
+
+[dependency-groups]
+dev = [
+    "pytest==9.0.2",
+    "ruff==0.15.1",
+]

samplemaker_sparrow-5.4.7/src/samplemaker/__init__.py

@@ -0,0 +1,48 @@
+"""
+
+This is the Python version of Sample Maker, a scripting tool for designing lithographic
+masks in the GDSII format. Package `samplemaker` comes with different tools and
+submodules for the creation and manipulation of basic shapes, periodic shapes, sequences
+(e.g. waveguides), circuits, and complex devices.
+
+The code has been developed primarily for nanophotonics, but it can be easily extended
+to different applications in micro and nano device fabrication.
+
+Sample Maker is developed and maintained by Leonardo Midolo (Niels Bohr Institute,
+University of Copenhagen). It is based on the MATLAB(R) code developed by Leonardo
+Midolo between 2013 and 2019. The first version of the rewritten Python code has been
+released in October 2021.
+
+This software has been realized with the financial support from
+the European Research Council (ERC) under the European Union’s Horizon 2020 research and
+innovation programme (Grant agreement No. 949043, NANOMEQ).
+
+.. include:: ./documentation.md
+"""
+
+__pdoc__: dict[str, bool | str] = {
+    "samplemaker.Tutorials": False,
+    "samplemaker.tests": False,
+    "samplemaker.resources": False,
+    "samplemaker.gdsreader": False,
+    "samplemaker.devices.DevicePort": False,
+}
+
+# The LayoutPool contains all the current layout, this class should generally not
+# be used directly, but only through the Mask class.
+LayoutPool = {}  # connects a SREF name to a particular geomgroup in the current memory
+
+# Additional cache pool:
+
+# _DevicePool Connects a device hash to a SREF to be instantiated:
+_DevicePool = {}
+
+# _DeviceLocalParamPool connects a device hash to local parameters created by the call
+# to geom():
+_DeviceLocalParamPool = {}
+
+# _DeviceCountPool connects a device name to a device count
+_DeviceCountPool = {}
+
+# _BoundingBoxPool connects a SREF name to its bounding box
+_BoundingBoxPool = {}

samplemaker_sparrow-5.4.7/src/samplemaker/baselib/__init__.py

@@ -0,0 +1,3 @@
+import samplemaker.baselib.devices  # noqa: F401
+
+print("Base library loaded")

samplemaker_sparrow-5.4.7/src/samplemaker/baselib/devices.py

@@ -0,0 +1,295 @@
+"""
+Base device library.
+
+This is a collection of some simple demo devices distributed with the base version of
+`samplemaker`. It can be used as template for creating new libraries or to learn how to
+design them.
+
+Note that individual device methods are not documented but should be readable and
+self-explanatory.
+"""
+
+import math
+
+import numpy as np
+
+import samplemaker.makers as sm
+from samplemaker.baselib.waveguides import BaseWaveguidePort, BaseWaveguideSequencer
+from samplemaker.devices import Device, registerDevicesInModule
+
+
+class CrossMark(Device):
+    def initialize(self):
+        self.set_name("BASELIB_CMARK")
+        self.set_description("Generic cross marker for mask alignment.")
+
+    def parameters(self):
+        self.addparameter(
+            param_name="length1",
+            default_value=20,
+            param_description="Length of inner cross",
+            param_type=float,
+        )
+        self.addparameter(
+            param_name="length2",
+            default_value=10,
+            param_description="Length of outer cross",
+            param_type=float,
+        )
+        self.addparameter(
+            param_name="width1",
+            default_value=0.5,
+            param_description="Width of inner cross",
+            param_type=float,
+        )
+        self.addparameter(
+            param_name="width2",
+            default_value=2,
+            param_description="width of outer cross",
+            param_type=float,
+        )
+        self.addparameter(
+            param_name="layer",
+            default_value=4,
+            param_description="Layer to use for cross",
+            param_type=int,
+            param_range=(0, 255),
+        )
+        self.addparameter(
+            param_name="mark_number",
+            default_value=0,
+            param_description="Places a square in the corner, use 0 to remove",
+            param_type=float,
+            param_range=(0, 4),
+        )
+        self.addparameter(
+            param_name="square_size",
+            default_value=10,
+            param_description="Size of the square in the corner",
+            param_type=float,
+        )
+
+    def geom(self):
+        p = self.get_params()
+        cross = sm.make_rect(0, 0, p["length1"], p["width1"], layer=1)
+        cross += sm.make_rect(0, 0, p["width1"], p["length1"], layer=1)
+        cross.boolean_union(1)
+        ocross = sm.make_rect(p["length1"] / 2, 0, p["length2"], p["width2"], numkey=4)
+        for i in range(4):
+            c = ocross.copy()
+            c.rotate(0, 0, 90 * i)
+            cross += c
+        if p["mark_number"] > 0:
+            rot = 90 * (p["mark_number"] - 1)
+            sq_dim = p["length1"] / 2 + p["length2"]
+            sq_size = p["square_size"]
+            square = sm.make_rect(sq_dim, sq_dim, sq_size, sq_size, numkey=1)
+            square.rotate(0, 0, rot)
+            cross += square
+
+        cross.set_layer(p["layer"])
+        return cross
+
+
+class DirectionalCoupler(Device):
+    def initialize(self):
+        self.set_name("BASELIB_DCPL")
+        self.set_description("Simple symmetric directional coupler")
+
+    def parameters(self):
+        self.addparameter("length", 20, "Coupling length", float)
+        self.addparameter(
+            param_name="width",
+            default_value=0.3,
+            param_description="Width of the waveguides in the coupling section",
+            param_type=float,
+            param_range=(0.01, 1),
+        )
+        self.addparameter(
+            param_name="gap",
+            default_value=0.5,
+            param_description="Distance between waveguides in the coupling section",
+            param_type=float,
+        )
+        self.addparameter(
+            param_name="input_dist",
+            default_value=5,
+            param_description="Distance between waveguides at input",
+            param_type=float,
+            param_range=(0.01, np.inf),
+        )
+        self.addparameter(
+            param_name="input_len",
+            default_value=7,
+            param_description="Length of the input section from input to coupling",
+            param_type=float,
+            param_range=(3, np.inf),
+        )
+
+    def geom(self):
+        p = self.get_params()
+        # Draw the upper arm, then mirror
+        off = p["input_dist"] / 2
+        clen = (p["input_len"] - 1) / 2
+        ltot = p["length"] + p["input_len"] * 2
+        seq = [["T", 1, p["width"]], ["C", -off, clen], ["S", p["length"] / 2]]
+        ss = BaseWaveguideSequencer(seq)
+        dc = ss.run()
+        dc2 = dc.copy()
+        dc2.mirrorX(ltot / 2)
+        dc += dc2
+        dc.translate(-ltot / 2, off + p["gap"] / 2 + p["width"] / 2)
+        dc3 = dc.copy()
+        dc3.mirrorY(0)
+        dc += dc3
+
+        # Add ports
+        xp = ltot / 2
+        yp = off + p["gap"] / 2 + p["width"] / 2
+        nw_port = BaseWaveguidePort(-xp, yp, "west", ss.options["defaultWidth"], "p1")
+        ne_port = BaseWaveguidePort(xp, yp, "east", ss.options["defaultWidth"], "p2")
+        sw_port = BaseWaveguidePort(-xp, -yp, "west", ss.options["defaultWidth"], "p3")
+        se_port = BaseWaveguidePort(xp, -yp, "east", ss.options["defaultWidth"], "p4")
+        for port in (nw_port, ne_port, sw_port, se_port):
+            self.addlocalport(port)
+
+        return dc
+
+
+class FocusingGratingCoupler(Device):
+    def initialize(self):
+        self.set_name("BASELIB_FGC")
+        self.set_description("Grating coupler demo.")
+
+    def parameters(self):
+        self.addparameter(
+            param_name="w0",
+            default_value=0.3,
+            param_description="Width of the waveguide at the start",
+            param_type=float,
+        )
+        self.addparameter(
+            param_name="pitch",
+            default_value=0.355,
+            param_description="Grating default pitch",
+            param_type=float,
+        )
+        self.addparameter(
+            param_name="ff",
+            default_value=0.5,
+            param_description="Fill factor",
+            param_type=float,
+        )
+        self.addparameter(
+            param_name="theta",
+            default_value=10,
+            param_description="Emission angle at central wavelength",
+            param_type=float,
+        )
+        self.addparameter(
+            param_name="lambda0",
+            default_value=0.94,
+            param_description="Central wavelength",
+            param_type=float,
+        )
+        self.addparameter(
+            param_name="nr_Apo",
+            default_value=11,
+            param_description="nr of the 1st arc with pitch and ff",
+            param_type=int,
+        )
+        self.addparameter(
+            param_name="ff_coef",
+            default_value=0.5,
+            param_description="min ff_apod = ff_coef*ff",
+            param_type=float,
+        )
+        self.addparameter(
+            param_name="order_start",
+            default_value=10,
+            param_description="Starting period",
+            param_type=int,
+        )
+        self.addparameter(
+            param_name="order",
+            default_value=15,
+            param_description="Number of periods",
+            param_type=int,
+        )
+        self.addparameter(
+            param_name="diverg_angle",
+            default_value=20,
+            param_description="GRT divergence angle/2, deg",
+            param_type=float,
+        )
+        self.addparameter(
+            param_name="pre_split",
+            default_value=True,
+            param_description="Split in quads = false",
+            param_type=bool,
+        )
+
+    def geom(self):
+        # Grating first
+        p = self.get_params()
+        theta = math.radians(p["theta"])
+        div_angle = p["diverg_angle"]
+        q0 = p["order_start"]
+        qn = q0 + p["order"] + 1
+        lambda0 = p["lambda0"]
+        pitch = p["pitch"]
+        n = math.sin(theta) + lambda0 / pitch  # Effective refractive index
+        p0 = lambda0 / math.sqrt(n * n - np.power(math.sin(theta), 2))
+        ff = p["ff"]
+        nr_apo = p["nr_Apo"]
+        ff_coef = p["ff_coef"]
+
+        g = sm.GeomGroup()
+        for q in range(q0, qn):
+            b = q * p0
+            x0 = b * b * math.sin(theta) / (q * lambda0)
+            a = b * b * n / (q * lambda0)
+            if q <= q0 + nr_apo - 1:
+                ff_chi = ff - (1 - ff_coef) * ff / (nr_apo - 2) * (q0 + nr_apo - q)
+            else:
+                ff_chi = ff
+
+            w = ff_chi * pitch
+            g += sm.make_arc(
+                x0=x0,
+                y0=0,
+                rX=a,
+                rY=b,
+                rot=0,
+                w=w,
+                a1=-div_angle - 5,
+                a2=div_angle + 5,
+                layer=3,
+                to_poly=True,
+                vertices=40,
+                split=p["pre_split"],
+            )
+
+        # waveguide
+        l_taper = 1
+        g_taper = qn * pitch
+        w_taper = g_taper * math.tan(math.radians(div_angle)) * 2
+
+        seq = [
+            ["T", l_taper, p["w0"]],
+            ["CENTER", 0, 0],
+            ["T", g_taper, w_taper],
+            ["STATE", "w", 2.5],
+            ["S", 1],
+        ]
+
+        ss = BaseWaveguideSequencer(seq)
+        g += ss.run()
+
+        self.addlocalport(BaseWaveguidePort(-l_taper, 0, "west", p["w0"], "p1"))
+
+        return g
+
+
+# Register all devices here in this module
+registerDevicesInModule(__name__)