samplemaker-sparrow 5.4.4__tar.gz

samplemaker_sparrow-5.4.4/.github/workflows/build_wheels.yml

@@ -0,0 +1,64 @@
+name: Build and upload to PyPI
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - master
+  release:
+    types:
+      - published
+
+jobs:
+  build_wheels:
+    name: Build wheels on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        # macos-15-intel is an Intel runner, macos-14 is Apple silicon
+        os: [ubuntu-latest, ubuntu-24.04-arm, windows-latest, windows-11-arm, macos-15-intel, macos-14]
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Build wheels
+        uses: pypa/cibuildwheel@v3.3.0
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: cibw-wheels-${{ matrix.os }}-${{ strategy.job-index }}
+          path: ./wheelhouse/*.whl
+
+  make_sdist:
+    name: Make SDist
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          submodules: true
+
+      - name: Build SDist
+        run: pipx run build --sdist
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: cibw-sdist
+          path: dist/*.tar.gz
+  
+  upload_pypi:
+    needs: [build_wheels, make_sdist]
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    if: github.event_name == 'release' && github.event.action == 'published'
+    steps:
+      - uses: actions/download-artifact@v5
+        with:
+          # unpacks all CIBW artifacts into dist/
+          pattern: cibw-*
+          path: dist
+          merge-multiple: true
+
+      - uses: pypa/gh-action-pypi-publish@release/v1

samplemaker_sparrow-5.4.4/.gitignore

@@ -0,0 +1,70 @@
+# These are some examples of commonly ignored file patterns.
+# You should customize this list as applicable to your project.
+# Learn more about .gitignore:
+#     https://www.atlassian.com/git/tutorials/saving-changes/gitignore
+
+# Node artifact files
+node_modules/
+dist/
+
+# Compiled Java class files
+*.class
+
+# Compiled Python bytecode
+*.py[co]
+
+# Log files
+*.log
+
+# Package files
+*.jar
+
+# Maven
+target/
+dist/
+
+# JetBrains IDE
+.idea/
+
+# Unit test reports
+TEST*.xml
+
+# Generated by MacOS
+.DS_Store
+
+# Generated by Windows
+Thumbs.db
+
+# Applications
+*.app
+*.exe
+*.war
+
+# Large media files
+*.mp4
+*.tiff
+*.avi
+*.flv
+*.mov
+*.wmv
+*.cache
+*.gds
+*.cel
+*.lel
+*.gds
+src/boopy/*.pro.user
+html/
+tests/
+# Python build artifacts
+build/
+*.egg-info/
+wheelhouse/
+*.so
+*.pyd
+*.dll
+
+# CMake artifacts
+CMakeFiles/
+CMakeCache.txt
+cmake_install.cmake
+Makefile

samplemaker_sparrow-5.4.4/BUILD.md

@@ -0,0 +1,132 @@
+# Building SampleMaker
+
+This document explains how to build SampleMaker with its C++ extension module (boopy) for different platforms.
+
+## Overview
+
+SampleMaker includes a C++ component called "boopy" that provides high-performance Boolean polygon operations using 
+Boost.Polygon and is exposed to Python via pybind11. The project uses:
+
+- **[scikit-build-core](https://scikit-build-core.readthedocs.io/en/latest/)**: 
+  Modern build system that uses CMake and pure `pyproject.toml` configuration.
+- **[CMake](https://cmake.org/)**: For configuring the C++ extension build.
+- **[Astral uv](https://docs.astral.sh/uv/)**: For faster dependency installation during builds.
+- **[cibuildwheel](https://cibuildwheel.pypa.io/en/stable/)**: 
+  For cross-platform wheel building.
+
+
+## Local Development Build
+
+### Prerequisites
+- Python 3.10 or later
+- CMake 3.15 or later
+- A C++14-compatible compiler
+- pybind11 (installed automatically during build)
+- Boost (header-only, for polygon operations)
+
+### Linux
+
+Install the required packages using your distribution's package manager:
+```bash
+# Ubuntu/Debian
+sudo apt-get install build-essential cmake libboost-dev
+
+# RHEL/CentOS/Fedora
+sudo yum install gcc-c++ make cmake boost-devel
+```
+
+Navigate to the project directory and build:
+```bash
+# Using Astral uv (recommended)
+uv sync
+
+# Using pip
+pip install -e .
+```
+
+### macOS
+Work in progress...
+
+### Windows
+To build on Windows, ensure you have Visual Studio with C++ build tools installed.
+
+Boost can be installed via vcpkg:
+```powershell
+git clone https://github.com/Microsoft/vcpkg.git C:\vcpkg
+C:\vcpkg\bootstrap-vcpkg.bat
+C:\vcpkg\vcpkg.exe install boost-polygon
+C:\vcpkg\vcpkg.exe integrate install
+```
+
+> [!NOTE]  
+> `vcpkg` may come pre-installed with your Visual Studio installation. This version
+> only works in manifest mode, meaning the above commands will not work. Ensure you
+> are referencing the correct `vcpkg` installation.
+
+Open "x64 Native Tools Command Prompt for VS" and navigate to the project directory:
+```cmd
+cd path\to\samplemaker
+set CMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake
+
+# Astral uv (recommended)
+uv sync
+
+# Using pip
+pip install -e .
+```
+
+If boost is not found, try setting the CMAKE_TOOLCHAIN_FILE directly in the build command:
+```cmd
+cd path\to\samplemaker
+
+# Astral uv (recommended)
+uv sync -C cmake.args="-DCMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake"
+
+# Using pip
+pip install -e . -C cmake.args="-DCMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake"
+```
+
+## Building Wheels for Distribution
+
+To build wheels for distribution, we use `cibuildwheel`. This tool automates 
+the process of building wheels for multiple platforms and is intended to run
+in CI environments.
+
+This section outlines the steps to build wheels locally using `cibuildwheel`.
+
+### Prerequisites
+Ensure you are able to build the project locally as described in the previous section.
+
+### Linux
+Building Linux wheels locally requires [Docker](https://docs.docker.com/get-docker/).
+If you are building using WSL2 on Windows, Docker Desktop should be installed on Windows.
+For more information on working with Docker for WSL, see the official [Docker docs article](https://docs.docker.com/desktop/features/wsl/).
+
+Once Docker is set up, you can build the wheels using the following command in the project directory:
+```bash
+# Using Astral uv (recommended)
+uvx cibuildwheel .
+
+# Using pip
+pip install cibuildwheel
+cibuildwheel .
+```
+
+### macOS
+Work in progress...
+
+### Windows
+To build Windows wheels locally, the correct version of `vcpkg` must be added to the PATH environment variable.
+When using "x64 Native Tools Command Prompt for VS", the wrong version of `vcpkg` may be added to PATH.
+
+To ensure the correct version is used, modify the PATH variable in the command prompt before building:
+```cmd
+set PATH=C:\vcpkg;%PATH%
+
+# Using Astral uv (recommended)
+uvx cibuildwheel .
+
+# Using pip
+pip install cibuildwheel
+cibuildwheel .
+```

samplemaker_sparrow-5.4.4/LICENSE.md

@@ -0,0 +1,11 @@
+Copyright (c) 2021 Leonardo Midolo, Niels Bohr Institute, Denmark
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

samplemaker_sparrow-5.4.4/PKG-INFO

@@ -0,0 +1,40 @@
+Metadata-Version: 2.4
+Name: samplemaker-sparrow
+Version: 5.4.4
+Summary: Lithographic mask design package
+Author-Email: Leonardo Midolo <midolo@nbi.ku.dk>
+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: 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
+Requires-Dist: numpy==2.*
+Description-Content-Type: text/markdown
+
+# README
+
+Welcome to the SampleMaker git repository. 
+
+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).
+
+
+### What is this repository for?
+
+* SampleMaker lithographic mask design tool in Python.
+
+### How do I get set up?
+
+* For local development build instructions, please refer to [BUILD.md](BUILD.md).

samplemaker_sparrow-5.4.4/README.md

@@ -0,0 +1,15 @@
+# README
+
+Welcome to the SampleMaker git repository. 
+
+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).
+
+
+### What is this repository for?
+
+* SampleMaker lithographic mask design tool in Python.
+
+### How do I get set up?
+
+* For local development build instructions, please refer to [BUILD.md](BUILD.md).

samplemaker_sparrow-5.4.4/pyproject.toml

@@ -0,0 +1,58 @@
+[build-system]
+requires = ["scikit-build-core>=0.11.6", "pybind11>=3.0.1"]
+build-backend = "scikit_build_core.build"
+
+[project]
+name = "samplemaker-sparrow"
+authors = [
+    { name = "Leonardo Midolo", email = "midolo@nbi.ku.dk"}
+]
+description = "Lithographic mask design package"
+readme = "README.md"
+requires-python = ">=3.10,<3.14"
+license-files = ["LICENSE.md"]
+license = "BSD-3-Clause"
+version = "5.4.4"
+dependencies = [
+    "matplotlib>=3.7.5",
+    "numpy==2.*",
+]
+classifiers = [
+    "Programming Language :: C++",
+    "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",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: MacOS",
+    "Operating System :: Unix",
+    "Operating System :: POSIX :: Linux",
+]
+
+[project.urls]
+Repository = "https://github.com/lmidolo/samplemaker.git"
+
+[tool.scikit-build]
+minimum-version = "0.11.6"
+build-dir = "build/{wheel_tag}"
+cmake.source-dir = "src/boopy"
+wheel.install-dir = "samplemaker"
+wheel.packages = ["src/samplemaker"]
+
+[tool.cibuildwheel]
+skip = ["*-musllinux*", "*-win32*"]
+
+[tool.cibuildwheel.linux]
+before-all = "yum install -y boost-devel"
+
+[tool.cibuildwheel.macos]
+before-all = "brew install boost"
+
+[tool.cibuildwheel.windows]
+environment = { BOOST_ROOT = "C:/vcpkg/installed/x64-windows" }
+before-all = [
+    "vcpkg install boost-polygon:x64-windows",
+]

samplemaker_sparrow-5.4.4/src/boopy/CMakeLists.txt

@@ -0,0 +1,41 @@
+cmake_minimum_required(VERSION 3.15...3.29)
+project(${SKBUILD_PROJECT_NAME} LANGUAGES CXX)
+
+# Find Python
+find_package(Python COMPONENTS Interpreter Development.Module REQUIRED)
+
+# Find pybind11
+find_package(pybind11 CONFIG REQUIRED)
+
+# Find Boost
+if(WIN32)
+    # On Windows with vcpkg, use CONFIG mode only
+    find_package(Boost REQUIRED CONFIG)
+else()
+    # On Linux/macOS, try CONFIG first, fall back to MODULE mode
+    find_package(Boost QUIET CONFIG)
+    if(NOT Boost_FOUND)
+        find_package(Boost REQUIRED)
+    endif()
+endif()
+
+# Create the Python extension module
+pybind11_add_module(boopy boopy.cpp)
+
+# Link Boost headers - handle both old and new Boost installations
+if(TARGET Boost::headers)
+    target_link_libraries(boopy PRIVATE Boost::headers)
+elseif(TARGET Boost::boost)
+    target_link_libraries(boopy PRIVATE Boost::boost)
+else()
+    target_include_directories(boopy PRIVATE ${Boost_INCLUDE_DIRS})
+endif()
+
+# Set C++ standard
+target_compile_features(boopy PRIVATE cxx_std_14)
+
+# Set visibility
+set_target_properties(boopy PROPERTIES CXX_VISIBILITY_PRESET hidden)
+
+# Install the module to the correct location within the package
+install(TARGETS boopy LIBRARY DESTINATION resources)

samplemaker_sparrow-5.4.4/src/boopy/boopy.cpp

@@ -0,0 +1,94 @@
+#include <iostream>
+#include <vector>
+#include <pybind11/pybind11.h>
+#include <pybind11/stl.h>
+#include <pybind11/numpy.h>
+#include <pybind11/stl_bind.h>
+#include <boost/polygon/polygon.hpp>
+
+namespace py = pybind11;
+namespace gtl = boost::polygon;
+using namespace boost::polygon::operators;
+
+typedef gtl::polygon_data<int> Polygon;
+typedef gtl::polygon_traits<Polygon>::point_type Point;
+typedef std::vector<gtl::polygon_data<int> > PolygonSet;
+
+struct PolyGroup {
+    void addPolyData(const std::vector<int> &data) {
+        size_t npts = (data.size())/2;
+        Point *pts = new Point[npts];
+        for(unsigned int i = 0; i< npts; i++) {
+            pts[i]=gtl::construct<Point>(data.at(2*i),data.at(2*i+1));
+        }
+        Polygon poly;
+        gtl::set_points(poly,pts,pts+npts);
+
+        ps_.push_back(poly);
+        delete [] pts;
+    }
+    unsigned int getPolyCount(void) {return static_cast<unsigned int>(ps_.size());}
+    const std::vector<int> getPoly(unsigned int n) const {
+        std::vector<int> pseq;
+        if(n<ps_.size()) {
+            Polygon poly = ps_[n];
+            for(auto v = poly.begin(); v!=poly.end(); v++) {
+                pseq.push_back(v->x());
+                pseq.push_back(v->y());
+            }
+        }
+        return pseq;
+    }
+    double area() {
+        return gtl::area(ps_);
+    }
+    void clear() {
+        gtl::clear(ps_);
+    }
+    bool empty() {
+        return gtl::empty(ps_);
+    }
+    void difference(PolyGroup &pg2) {
+        ps_-=pg2.ps_;
+    }
+    void intersection(PolyGroup &pg2) {
+        ps_&=pg2.ps_;
+    }
+    void merge(PolyGroup &pg2) {
+        ps_+=pg2.ps_;
+    }
+    void assign() {
+        gtl::assign(ps_,ps_);
+    }
+    void exor(PolyGroup &pg2) {
+        ps_^=pg2.ps_;
+    }
+    void trapezoids() {
+        PolygonSet psin = ps_;
+        clear();
+        gtl::get_trapezoids(ps_,psin);
+    }
+    void resize(double value, bool corner_fill_arc, unsigned int num_circle_segments) {
+        ps_=gtl::resize(ps_,value,corner_fill_arc,num_circle_segments);
+    }
+
+    PolygonSet ps_;
+};
+
+PYBIND11_MODULE(boopy, m) {
+    py::class_<PolyGroup>(m, "PolyGroup")
+        .def(py::init<>())
+        .def("addPolyData",&PolyGroup::addPolyData)
+        .def("getPolyCount", &PolyGroup::getPolyCount)
+        .def("getPoly", &PolyGroup::getPoly)
+        .def("area", &PolyGroup::area)
+        .def("clear", &PolyGroup::clear)
+        .def("empty", &PolyGroup::empty)
+        .def("assign", &PolyGroup::assign)
+        .def("difference", &PolyGroup::difference)
+        .def("intersection", &PolyGroup::intersection)
+        .def("merge", &PolyGroup::merge)
+        .def("exor", &PolyGroup::exor)
+        .def("trapezoids", &PolyGroup::trapezoids)
+        .def("resize", &PolyGroup::resize);
+}

samplemaker_sparrow-5.4.4/src/samplemaker/__init__.py

@@ -0,0 +1,43 @@
+"""
+
+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
+"""
+
+from typing import (  # noqa: F401
+    cast, Any, Callable, Dict, Generator, Iterable, List, Mapping, NewType,
+    Optional, Set, Tuple, Type, TypeVar, Union,
+)
+
+__version__ = "5.4.3"
+    
+__pdoc__: Dict[str, Union[bool, str]] = {}
+__pdoc__["samplemaker.Tutorials"]=False
+__pdoc__["samplemaker.tests"]=False
+__pdoc__["samplemaker.resources"]=False
+__pdoc__["samplemaker.gdsreader"]=False
+__pdoc__["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 = dict() # connects a SREF name to a particular geomgroup in the current memory
+# Additional cache pool
+_DevicePool = dict() # connects a device hash to a SREF to be instantiated
+_DeviceLocalParamPool = dict() # connects a device hash to local parameters created by the call to geom()
+_DeviceCountPool = dict() # connects a device name to a device count 
+_BoundingBoxPool = dict() # connects a SREF name to its bounding box

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

@@ -0,0 +1,5 @@
+# -*- coding: utf-8 -*-
+
+import samplemaker.baselib.devices
+
+print("Base library loaded")