samplemaker-sparrow 5.4.8__tar.gz → 5.4.9__tar.gz

{samplemaker_sparrow-5.4.8 → samplemaker_sparrow-5.4.9}/.github/workflows/build_wheels.yml

@@ -25,7 +25,7 @@ jobs:
       - name: Build wheels
         uses: pypa/cibuildwheel@v3.3.0
 
-      - uses: actions/upload-artifact@v4
+      - uses: actions/upload-artifact@v7
         with:
           name: cibw-wheels-${{ matrix.os }}-${{ strategy.job-index }}
           path: ./wheelhouse/*.whl
@@ -41,7 +41,7 @@ jobs:
       - name: Build SDist
         run: pipx run build --sdist
 
-      - uses: actions/upload-artifact@v4
+      - uses: actions/upload-artifact@v7
         with:
           name: cibw-sdist
           path: dist/*.tar.gz

samplemaker_sparrow-5.4.9/.github/workflows/ruff.yml

@@ -0,0 +1,19 @@
+name: Ruff Check
+on: push
+jobs:
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            -   uses: actions/checkout@v4
+            -   name: Install Python
+                uses: actions/setup-python@v5
+                with:
+                    python-version: "3.13"
+            -   name: Install dependencies
+                run: |
+                    python -m pip install --upgrade pip
+                    pip install ruff==0.15.1
+            -   name: Run Ruff Linter
+                run: ruff check --output-format=github .
+            -   name: Check Ruff formatting
+                run: ruff format --check --diff .

{samplemaker_sparrow-5.4.8 → samplemaker_sparrow-5.4.9}/.gitignore

@@ -65,9 +65,13 @@ wheelhouse/
 *.so
 *.pyd
 *.dll
+result
 
 # CMake artifacts
 CMakeFiles/
 CMakeCache.txt
 cmake_install.cmake
 Makefile
+
+# Pytest coverage reports
+.coverage

samplemaker_sparrow-5.4.9/.python-version

@@ -0,0 +1 @@
+3.13.13

{samplemaker_sparrow-5.4.8 → samplemaker_sparrow-5.4.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: samplemaker-sparrow
-Version: 5.4.8
+Version: 5.4.9
 Summary: Lithographic mask design package
 Author-Email: Leonardo Midolo <midolo@nbi.ku.dk>, Jeppe Roulund <jeppe.roulund@sparrowquantum.com>
 License-Expression: BSD-3-Clause
@@ -19,6 +19,7 @@ Classifier: Operating System :: Unix
 Classifier: Operating System :: POSIX :: Linux
 Project-URL: Repository, https://github.com/SparrowQuantum/samplemaker.git
 Requires-Python: <3.15,>=3.11
+Requires-Dist: asteval>=1.0.9
 Requires-Dist: matplotlib>=3.10.5
 Requires-Dist: numpy==2.*
 Description-Content-Type: text/markdown

samplemaker_sparrow-5.4.9/flake.lock

@@ -0,0 +1,61 @@
+{
+  "nodes": {
+    "flake-utils": {
+      "inputs": {
+        "systems": "systems"
+      },
+      "locked": {
+        "lastModified": 1731533236,
+        "narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=",
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1780749050,
+        "narHash": "sha256-3av0pIjlOWQ6rDbNOmpUSvbNnJkGORQKKjb4LtCZsIY=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "a799d3e3886da994fa307f817a6bc705ae538eeb",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixos-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "flake-utils": "flake-utils",
+        "nixpkgs": "nixpkgs"
+      }
+    },
+    "systems": {
+      "locked": {
+        "lastModified": 1681028828,
+        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
+        "owner": "nix-systems",
+        "repo": "default",
+        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "default",
+        "type": "github"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

samplemaker_sparrow-5.4.9/flake.nix

@@ -0,0 +1,96 @@
+{
+  description = "samplemaker-sparrow lithographic mask design package";
+
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
+    flake-utils.url = "github:numtide/flake-utils";
+  };
+
+  outputs = {
+    nixpkgs,
+    flake-utils,
+    ...
+  }:
+    flake-utils.lib.eachDefaultSystem (
+      system: let
+        pkgs = nixpkgs.legacyPackages.${system};
+        python = pkgs.python313;
+        pyPkgs = python.pkgs;
+
+        pyProj = pkgs.lib.trivial.importTOML ./pyproject.toml;
+        samplemaker = pyPkgs.buildPythonPackage {
+          pname = "samplemaker-sparrow";
+          version = pyProj.project.version;
+          pyproject = true;
+
+          src = ./.;
+
+          build-system = [
+            pyPkgs.scikit-build-core
+            pyPkgs.pybind11
+          ];
+
+          nativeBuildInputs = [
+            pkgs.cmake
+            pkgs.ninja
+          ];
+
+          buildInputs = [
+            pkgs.boost.dev
+          ];
+
+          dependencies = [
+            pyPkgs.matplotlib
+            pyPkgs.numpy
+          ];
+
+          # scikit-build-core invokes cmake internally; skip Nix's cmake configure hook
+          dontUseCmakeConfigure = true;
+
+          meta = with pkgs.lib; {
+            description = "Lithographic mask design package";
+            homepage = "https://github.com/SparrowQuantum/samplemaker";
+            license = licenses.bsd3;
+          };
+        };
+
+        devEnv = python.withPackages (ps: [
+          samplemaker
+          ps.pytest
+          ps.pytest-cov
+        ]);
+
+        fmtPackage = pkgs.writeShellScriptBin "fmt" ''
+          ${pkgs.alejandra}/bin/alejandra . --quiet
+        '';
+      in {
+        packages = {
+          default = samplemaker;
+          samplemaker = samplemaker;
+        };
+
+        devShells = {
+          default = pkgs.mkShell {
+            packages = [
+              pkgs.ruff
+              pkgs.alejandra
+              pkgs.deadnix
+              devEnv
+            ];
+          };
+          uv = pkgs.mkShell {
+            packages = with pkgs; [
+              uv
+              cmake
+              ninja
+              boost.dev
+              alejandra
+              deadnix
+            ];
+          };
+        };
+
+        formatter = fmtPackage;
+      }
+    );
+}

{samplemaker_sparrow-5.4.8 → samplemaker_sparrow-5.4.9}/pyproject.toml

@@ -5,19 +5,16 @@ build-backend = "scikit_build_core.build"
 [project]
 name = "samplemaker-sparrow"
 authors = [
-    { name = "Leonardo Midolo", email = "midolo@nbi.ku.dk"},
-    { name = "Jeppe Roulund", email = "jeppe.roulund@sparrowquantum.com"}
+    { 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.11,<3.15"
 license-files = ["LICENSE.md"]
 license = "BSD-3-Clause"
-version = "5.4.8"
-dependencies = [
-    "matplotlib>=3.10.5",
-    "numpy==2.*",
-]
+version = "5.4.9"
+dependencies = ["asteval>=1.0.9", "matplotlib>=3.10.5", "numpy==2.*"]
 classifiers = [
     "Programming Language :: C++",
     "Programming Language :: Python",
@@ -36,6 +33,50 @@ classifiers = [
 [project.urls]
 Repository = "https://github.com/SparrowQuantum/samplemaker.git"
 
+[tool.ruff]
+extend-exclude = ["tutorials/*"]
+
+[tool.ruff.lint]
+extend-select = [
+    "D",    # Pydocstyle
+    "E",    # Pycodestyle errors
+    "W",    # Pycodestyle warnings
+    "ANN",  # flake8-annotations
+    "BLE",  # flake8-blind-except
+    "B",    # flake8-bugbear
+    "S",    # flake8-bandit
+    "A",    # flake8-builtins
+    "C4",   # flake8-comprehensions
+    "T100", # flake8-debugger
+    "EM",   # flake8-errmsg
+    "FIX",  # flake8-fixme
+    "INP",  # flake8-no-pep420
+    "PIE",  # flake8-pie
+    "PYI",  # flake8-pyi
+    "PT",   # flake8-pytest-style
+    "RSE",  # flake8-raise
+    "RET",  # flake8-return
+    "SIM",  # flake8-simplify
+    "TC",   # flake8-type-checking
+    "ARG",  # flake8-unused-arguments
+    "PTH",  # flake8-use-pathlib
+    "I",    # isort
+    "NPY",  # Numpy specific rules
+    "UP",   # Pyupgrade
+    "F",    # pyflakes
+    "PL",   # pylint
+    "FURB", # refurb
+    "RUF",  # ruff
+    "PGH",  # pygrep-hooks
+    "PERF", # perflint
+    "N",    # pep8-naming
+]
+ignore = ["D203", "D213", "PLR2004", "PLR091"]
+
+[tool.ruff.lint.extend-per-file-ignores]
+"tests/*" = ["D1", "S101", "ARG"]
+"*.pyi" = ["N802"]
+
 [tool.scikit-build]
 minimum-version = "0.11.6"
 build-dir = "build/{wheel_tag}"
@@ -57,12 +98,7 @@ before-all = "brew install boost"
 
 [tool.cibuildwheel.windows]
 environment = { BOOST_ROOT = "C:/vcpkg/installed/x64-windows" }
-before-all = [
-    "vcpkg install boost-polygon:x64-windows",
-]
+before-all = ["vcpkg install boost-polygon:x64-windows"]
 
 [dependency-groups]
-dev = [
-    "pytest==9.0.2",
-    "ruff==0.15.1",
-]
+dev = ["pytest==9.0.2", "pytest-cov==7.1.0", "ruff==0.15.1"]

{samplemaker_sparrow-5.4.8 → samplemaker_sparrow-5.4.9}/src/samplemaker/__init__.py

@@ -1,9 +1,9 @@
-"""
+"""The Python version of Sample Maker.
 
-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.
+Sample Maker is a scripting tool for designing lithographic masks in the GDSII format.
+The 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.
@@ -13,9 +13,9 @@ University of Copenhagen). It is based on the MATLAB(R) code developed by Leonar
 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).
+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
 """

samplemaker_sparrow-5.4.9/src/samplemaker/_legacy.py

@@ -0,0 +1,142 @@
+"""Common helper functions used for backwards compatibility.
+
+The main purpose of these functions is to assist in replacing uppercase function/method
+keyword arguments with lowercase ones, while still allowing the uppercase ones to be
+used for a transition period.
+
+Optional argument example
+-------------------------
+
+To replace an optional argument (in this case Npts -> npts), do the following:
+
+    def my_func(npts: int = 100, **kwargs: int) -> None:
+        npts = get_optional_kwarg("npts", npts, 100, "Npts", kwargs)
+        ensure_empty_kwargs("my_func", kwargs)
+
+        # rest of function body
+        ...
+
+Required argument example
+-------------------------
+
+To replace a required argument (in this case Npts -> npts), do the following:
+
+    def my_func(npts: int | MissingType = MISSING, **kwargs: int) -> None:
+        npts = get_kwarg("npts", npts, "Npts", kwargs)
+        ensure_empty_kwargs("my_func", kwargs)
+        check_missing_args("my_func", npts=npts)
+
+        # Filter out the MissingType type hint for the rest of the function body.
+        npts = ensure_arg_type("npts", npts)
+
+        # Rest of function body
+        ...
+
+If there are required arguments following the one being replaced, they should also be
+given a default value of MISSING, after which check_missing_args should be called with
+all of the required arguments:
+
+    def my_func(
+        npts: int | MissingType = MISSING,
+        other_arg: str | MissingType = MISSING,
+        **kwargs: int,
+    ) -> None:
+        npts = get_kwarg("npts", npts, "Npts", kwargs)
+        ensure_empty_kwargs("my_func", kwargs)
+        check_missing_args("my_func", npts=npts, other_arg=other_arg)
+
+        # We cast both npts and other_arg this time
+        npts = ensure_arg_type("npts", npts)
+        other_arg = ensure_arg_type("other_arg", other_arg)
+
+        # Rest of function body
+        ...
+
+"""
+
+import warnings
+from typing import Any, TypeVar
+
+T = TypeVar("T")
+
+
+# Sentinel for missing arguments
+class MissingType:
+    pass
+
+
+MISSING = MissingType()
+
+
+def get_kwarg(
+    new_name: str, new_value: T | MissingType, legacy_name: str, kwargs: dict[str, T]
+) -> T | MissingType:
+    if legacy_name in kwargs:
+        if not isinstance(new_value, MissingType):
+            msg = (
+                f"Cannot specify both {new_name} and {legacy_name}. "
+                f"Please use {new_name} only."
+            )
+            raise TypeError(msg)
+        warnings.warn(
+            f"Passing {legacy_name} as a keyword argument is deprecated and "
+            f"will be removed in a future version. Use {new_name} instead.",
+            DeprecationWarning,
+            stacklevel=3,
+        )
+        return kwargs.pop(legacy_name)
+    return new_value
+
+
+def get_optional_kwarg(
+    new_name: str,
+    new_value: T,
+    default_value: T,
+    legacy_name: str,
+    kwargs: dict[str, T],
+) -> T:
+    if legacy_name in kwargs:
+        if new_value != default_value:
+            msg = (
+                f"Cannot specify both {new_name} and {legacy_name}. "
+                f"Please use {new_name} only."
+            )
+            raise TypeError(msg)
+        warnings.warn(
+            f"Passing {legacy_name} as a keyword argument is deprecated and "
+            f"will be removed in a future version. Use {new_name} instead.",
+            DeprecationWarning,
+            stacklevel=3,
+        )
+        return kwargs.pop(legacy_name)
+    return new_value
+
+
+def check_missing_args(func_name: str, **kwargs: Any) -> None:  # noqa: ANN401
+    missing_args = [name for name, value in kwargs.items() if value is MISSING]
+    if missing_args:
+        n_missing = len(missing_args)
+        if n_missing == 1:
+            arg_word = "argument"
+            arg_str = missing_args[0]
+        else:
+            arg_word = "arguments"
+            arg_str = ", ".join(missing_args[:-1]) + f", and {missing_args[-1]}"
+        msg = f"{func_name}() missing {n_missing} required {arg_word}: {arg_str}"
+        raise TypeError(msg)
+
+
+def ensure_arg_type(name: str, value: T | MissingType) -> T:
+    if isinstance(value, MissingType):
+        msg = f"Missing required argument, {name}."
+        raise TypeError(msg)
+    return value
+
+
+def ensure_empty_kwargs(func_name: str, kwargs: dict[str, Any]) -> None:
+    if not kwargs:
+        return
+    arg_word = "argument" if len(kwargs) == 1 else "arguments"
+    unexpected = ", ".join(kwargs.keys())
+    msg = f"{func_name}() got unexpected keyword {arg_word}: {unexpected}"
+    raise TypeError(msg)

{samplemaker_sparrow-5.4.8 → samplemaker_sparrow-5.4.9}/src/samplemaker/baselib/__init__.py

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

{samplemaker_sparrow-5.4.8 → samplemaker_sparrow-5.4.9}/src/samplemaker/baselib/devices.py

@@ -1,5 +1,4 @@
-"""
-Base device library.
+"""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
@@ -15,15 +14,32 @@ import numpy as np
 
 import samplemaker.makers as sm
 from samplemaker.baselib.waveguides import BaseWaveguidePort, BaseWaveguideSequencer
-from samplemaker.devices import Device, registerDevicesInModule
+from samplemaker.devices import Device, register_devices_in_module
+from samplemaker.shapes import GeomGroup
 
 
 class CrossMark(Device):
-    def initialize(self):
+    """Generic cross marker for lithographic mask alignment."""
+
+    def initialize(self) -> None:
+        """Initialize the cross mark device.
+
+        Returns
+        -------
+        None
+
+        """
         self.set_name("BASELIB_CMARK")
         self.set_description("Generic cross marker for mask alignment.")
 
-    def parameters(self):
+    def parameters(self) -> None:
+        """Define the parameters of the cross mark.
+
+        Returns
+        -------
+        None
+
+        """
         self.addparameter(
             param_name="length1",
             default_value=20,
@@ -69,7 +85,15 @@ class CrossMark(Device):
             param_type=float,
         )
 
-    def geom(self):
+    def geom(self) -> GeomGroup:
+        """Define the geometry of the cross mark.
+
+        Returns
+        -------
+        GeomGroup
+            The geometry of the cross mark.
+
+        """
         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)
@@ -92,11 +116,27 @@ class CrossMark(Device):
 
 
 class DirectionalCoupler(Device):
-    def initialize(self):
+    """Simple symmetric directional coupler."""
+
+    def initialize(self) -> None:
+        """Initialize the directional coupler device.
+
+        Returns
+        -------
+        None
+
+        """
         self.set_name("BASELIB_DCPL")
         self.set_description("Simple symmetric directional coupler")
 
-    def parameters(self):
+    def parameters(self) -> None:
+        """Define the parameters of the directional coupler.
+
+        Returns
+        -------
+        None
+
+        """
         self.addparameter("length", 20, "Coupling length", float)
         self.addparameter(
             param_name="width",
@@ -126,7 +166,15 @@ class DirectionalCoupler(Device):
             param_range=(3, np.inf),
         )
 
-    def geom(self):
+    def geom(self) -> GeomGroup:
+        """Define the geometry of the directional coupler.
+
+        Returns
+        -------
+        GeomGroup
+            The geometry of the directional coupler.
+
+        """
         p = self.get_params()
         # Draw the upper arm, then mirror
         off = p["input_dist"] / 2
@@ -136,11 +184,11 @@ class DirectionalCoupler(Device):
         ss = BaseWaveguideSequencer(seq)
         dc = ss.run()
         dc2 = dc.copy()
-        dc2.mirrorX(ltot / 2)
+        dc2.mirror_x(ltot / 2)
         dc += dc2
         dc.translate(-ltot / 2, off + p["gap"] / 2 + p["width"] / 2)
         dc3 = dc.copy()
-        dc3.mirrorY(0)
+        dc3.mirror_y(0)
         dc += dc3
 
         # Add ports
@@ -157,11 +205,27 @@ class DirectionalCoupler(Device):
 
 
 class FocusingGratingCoupler(Device):
-    def initialize(self):
+    """Apodized focusing grating coupler."""
+
+    def initialize(self) -> None:
+        """Initialize the grating coupler device.
+
+        Returns
+        -------
+        None
+
+        """
         self.set_name("BASELIB_FGC")
         self.set_description("Grating coupler demo.")
 
-    def parameters(self):
+    def parameters(self) -> None:
+        """Define the parameters for the grating coupler.
+
+        Returns
+        -------
+        None
+
+        """
         self.addparameter(
             param_name="w0",
             default_value=0.3,
@@ -229,7 +293,15 @@ class FocusingGratingCoupler(Device):
             param_type=bool,
         )
 
-    def geom(self):
+    def geom(self) -> GeomGroup:
+        """Define the grating coupler geometry.
+
+        Returns
+        -------
+        GeomGroup
+            The geometry of the grating coupler.
+
+        """
         # Grating first
         p = self.get_params()
         theta = math.radians(p["theta"])
@@ -244,7 +316,7 @@ class FocusingGratingCoupler(Device):
         nr_apo = p["nr_Apo"]
         ff_coef = p["ff_coef"]
 
-        g = sm.GeomGroup()
+        g = GeomGroup()
         for q in range(q0, qn):
             b = q * p0
             x0 = b * b * math.sin(theta) / (q * lambda0)
@@ -258,8 +330,8 @@ class FocusingGratingCoupler(Device):
             g += sm.make_arc(
                 x0=x0,
                 y0=0,
-                rX=a,
-                rY=b,
+                rx=a,
+                ry=b,
                 rot=0,
                 w=w,
                 a1=-div_angle - 5,
@@ -292,4 +364,4 @@ class FocusingGratingCoupler(Device):
 
 
 # Register all devices here in this module
-registerDevicesInModule(__name__)
+register_devices_in_module(__name__)