pnpq 0.1.0__tar.gz

pnpq-0.1.0/.editorconfig

@@ -0,0 +1,24 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
+
+[[shell]]
+simplify = true
+
+[*.py]
+indent_size = 4
+
+[*.rs]
+indent_size = 4
+
+[*.toml]
+indent_size = 4
+
+[Makefile]
+indent_style = tab

pnpq-0.1.0/.gitattributes

@@ -0,0 +1,2 @@
+# Disable autocrlf for all files in this repository
+* -text

pnpq-0.1.0/.github/workflows/check.yml

@@ -0,0 +1,34 @@
+# Automatically run semantic checks, linters, and unit tests
+
+name: Code Checks
+
+on:
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+  workflow_call:
+
+jobs:
+  check-codes:
+    runs-on: ubuntu-24.04
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Install uv and enable caching
+      uses: astral-sh/setup-uv@v6
+      with:
+        enable-cache: true
+        version: "0.8.11"
+
+    - name: Set up Python with uv
+      run: uv python install
+
+    - name: Install other dependencies
+      run: |
+        ./bin/install-dependencies.bash
+
+    - name: Run check script
+      run: |
+        ./bin/check.bash

pnpq-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,52 @@
+# Automatically prepare, build, and publish the package to PyPI
+
+name: Publish PnPQ to PyPI
+
+on:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+
+  workflow_dispatch:
+
+jobs:
+  run-checks:
+    uses: ./.github/workflows/check.yml
+
+  draft-release:
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: write
+
+    steps:
+    - name: Create GitHub Release (draft)
+      env:
+        GH_TOKEN: ${{ github.token }}
+      run: |
+        gh release create --draft --repo "${{ github.repository }}" "${{ github.ref_name }}"
+
+  publish-package:
+    needs: [run-checks, draft-release]
+    environment: pypi
+    runs-on: ubuntu-24.04
+    permissions:
+      id-token: write
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Install uv and enable caching
+      uses: astral-sh/setup-uv@v6
+      with:
+        enable-cache: true
+        version: "0.8.11"
+
+    - name: Set up Python with uv
+      run: uv python install
+
+    - name: Build package
+      run: uv build
+
+    - name: Publish package to PyPI
+      run: uv publish

pnpq-0.1.0/.github/workflows/publish_sphinx.yml

@@ -0,0 +1,54 @@
+# Automatically publish documentation to GitHub Pages
+
+name: Publish Sphinx Documentation
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build-documentation:
+    runs-on: ubuntu-24.04
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v5
+
+    - name: Install uv and enable caching
+      uses: astral-sh/setup-uv@v6
+      with:
+        enable-cache: true
+        version: "0.8.11"
+
+    - name: Set up Python with uv and sync dependencies
+      run: |
+        uv python install
+        uv sync
+
+    - name: Activate environment and build documentation
+      run: |
+        source .venv/bin/activate
+        sphinx-build -M html sphinx/source/ sphinx/build/ --fail-on-warning --fresh-env --write-all
+
+    - name: Upload documentation files as artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: sphinx/build/html
+
+  deploy-documentation:
+    needs: build-documentation
+
+    permissions:
+      pages: write
+      id-token: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

pnpq-0.1.0/.gitignore

@@ -0,0 +1,333 @@
+### Generated by gibo (https://github.com/simonwhitaker/gibo)
+### https://raw.github.com/github/gitignore/4488915eec0b3a45b5c63ead28f286819c0917de/Python.gitignore
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+.ruff_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+sphinx/build
+
+# API documents are auto-generated
+sphinx/source/api
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+### Generated by gibo (https://github.com/simonwhitaker/gibo)
+### https://raw.github.com/github/gitignore/4488915eec0b3a45b5c63ead28f286819c0917de/Global/VisualStudioCode.gitignore
+
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+### Generated by gibo (https://github.com/simonwhitaker/gibo)
+### https://raw.github.com/github/gitignore/4488915eec0b3a45b5c63ead28f286819c0917de/Global/macOS.gitignore
+
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon?
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+### Generated by gibo (https://github.com/simonwhitaker/gibo)
+### https://raw.github.com/github/gitignore/4488915eec0b3a45b5c63ead28f286819c0917de/Global/Windows.gitignore
+
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+### Generated by gibo (https://github.com/simonwhitaker/gibo)
+### https://raw.github.com/github/gitignore/4488915eec0b3a45b5c63ead28f286819c0917de/Global/Linux.gitignore
+
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+### Generated by gibo (https://github.com/simonwhitaker/gibo)
+### https://raw.github.com/github/gitignore/4488915eec0b3a45b5c63ead28f286819c0917de/Global/Emacs.gitignore
+
+# -*- mode: gitignore; -*-
+*~
+\#*\#
+/.emacs.desktop
+/.emacs.desktop.lock
+*.elc
+auto-save-list
+tramp
+.\#*
+
+# Org-mode
+.org-id-locations
+*_archive
+
+# flymake-mode
+*_flymake.*
+
+# eshell files
+/eshell/history
+/eshell/lastdir
+
+# elpa packages
+/elpa/
+
+# reftex files
+*.rel
+
+# AUCTeX auto folder
+/auto/
+
+# cask packages
+.cask/
+dist/
+
+# Flycheck
+flycheck_*.el
+
+# server auth directory
+/server/
+
+# projectiles files
+.projectile
+
+# directory configuration
+.dir-locals.el
+
+# network security
+/network-security.data
+
+### Generated by gibo (https://github.com/simonwhitaker/gibo)
+### https://raw.github.com/github/gitignore/4488915eec0b3a45b5c63ead28f286819c0917de/Global/Vim.gitignore
+
+# Swap
+[._]*.s[a-v][a-z]
+!*.svg  # comment out if you don't need vector files
+[._]*.sw[a-p]
+[._]s[a-rt-v][a-z]
+[._]ss[a-gi-z]
+[._]sw[a-p]
+
+# Session
+Session.vim
+Sessionx.vim
+
+# Temporary
+.netrwhist
+*~
+# Auto-generated tag files
+tags
+# Persistent undo
+[._]*.un~
+
+# Direnv
+.envrc

pnpq-0.1.0/.python-version

@@ -0,0 +1 @@
+3.13.5

pnpq-0.1.0/.vscode/extensions.json

@@ -0,0 +1,9 @@
+{
+    "recommendations": [
+        "ms-python.black-formatter",
+        "editorconfig.editorconfig",
+        "ms-python.vscode-pylance",
+        "ms-python.python",
+        "littlefoxteam.vscode-python-test-adapter"
+    ]
+}

pnpq-0.1.0/.vscode/launch.json

@@ -0,0 +1,16 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "pnpq example",
+            "type": "python",
+            "request": "launch",
+            "program": "${workspaceFolder}/example.py",
+            "console": "integratedTerminal",
+            "justMyCode": true
+        }
+    ]
+}

pnpq-0.1.0/.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+    "python.testing.pytestArgs": [
+        "src"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+    "python.analysis.typeCheckingMode": "basic",
+    "[python]": {
+      "editor.defaultFormatter": "ms-python.black-formatter",
+    }
+}

pnpq-0.1.0/CITATION.cff

@@ -0,0 +1,28 @@
+cff-version: 1.2.0
+title: "PnPQ"
+license: "BSD-3-Clause"
+type: software
+abstract: "Python library for laboratory devices often used in quantum networking and computing testbeds."
+message: "If our software significantly contributed to your research, we ask that you cite it either with the concept DOI in this file, which represents all versions, or with the version-specific DOI matching the version you used."
+authors:
+  - given-names: Amin
+    family-names: Taherkhani
+    orcid: "https://orcid.org/0000-0003-3044-6487"
+  - given-names: Andrew
+    family-names: Todd
+    orcid: "https://orcid.org/0009-0008-5423-3500"
+  - given-names: Lars
+    family-names: Matsumiya
+    orcid: "https://orcid.org/0009-0007-6640-7953"
+  - given-names: Tom
+    family-names: Shen
+    orcid: "https://orcid.org/0009-0000-1747-1050"
+identifiers:
+  - type: doi
+    value: 10.5281/zenodo.16886214
+keywords:
+  - optics
+  - ozoptics
+  - physics
+  - quantum
+  - thorlabs

pnpq-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+# Code of Conduct
+
+Please see the project code of conduct at [`CODE_OF_CONDUCT.md`](https://github.com/moonshot-nagayama-pj/public-documents/blob/main/CODE_OF_CONDUCT.md).

pnpq-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# Contributing
+
+Thank you for your interest in contributing to our project. To make it as easy as possible to engage with our work, please read this short guide.
+
+## Preparing your environment
+
+Please see [`development-environment.md`](https://github.com/moonshot-nagayama-pj/public-documents/blob/main/engineering/development-environment.md) for more information.
+
+## Development
+
+We run unit tests on all pull requests using simulated hardware. Use `pytest` to run these unit tests.
+
+For ad-hoc testing of real hardware, use `pytest hardware_tests`.
+
+Before making a pull request, please be sure to run the script `bin/check.bash`. This will run our static analysis checks and unit tests, all of which must pass before a pull request will be accepted.
+
+Ensure that pull requests have meaningful titles. The title will be used in the changelog.
+
+## Discussing and proposing changes
+
+To make a trivial change, or a change that has already been agreed to in discussions outside of GitHub, please create a pull request.
+
+If a change might need more discussion, please create a GitHub issue in this project before working on a pull request.
+
+## Licensing and attribution
+
+By contributing your work to this repository, you agree to license it in perpetuity under the terms described in [`LICENSE.md`](LICENSE.md). You are also asserting that the work is your own, and that you have the right to license it to us.
+
+If you wish to integrate our work into your own projects, please follow the attribution guidelines in `LICENSE.md`.
+
+## Code of conduct
+
+In order to provide a safe and welcoming environment for all people to contribute to our project, we have adopted a code of conduct, which you can read in [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md).
+
+## Versioning and backward compatibility
+
+We use Semantic Versioning 2.0.0 for all of our projects.
+
+## Making a release
+
+Follow the steps below in order to create and publish a release for PnPQ
+
+1. Decide to create a release.
+1. Run `./bin/release.bash` script and wait for it to finish.
+1. Wait for the release check script in GitHub Actions to finish.
+1. Edit and publish the draft in [Releases](https://github.com/moonshot-nagayama-pj/PnPQ/releases) (the generate release note function is sufficient for most cases).
+1. Approve the publish action.
+1. Create a PR to merge this branch (the script should open a new PR automatically).
+1. Wait for approval to merge the PR, and finish!
+
+The release script is based on steps from [Pallets release procedure](https://palletsprojects.com/contributing/release).

pnpq-0.1.0/LICENSE.md

@@ -0,0 +1,31 @@
+# Licenses
+
+## Source code
+
+Source code in this repository is available under [the 3-Clause BSD License](https://opensource.org/license/BSD-3-clause).
+
+> Copyright 2023-present https://github.com/moonshot-nagayama-pj/PnPQ contributors
+>
+> 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.
+
+## Non-code content
+
+Non-code content in this repository is available under the [Creative Commons Attribution 4.0 International license](https://creativecommons.org/licenses/by/4.0/).
+
+## Attribution
+
+Non-trivial use of any content from this repository requires proper attribution to the authors. For non-source code content, the easiest way to do this is to link back to our repository in a way that makes sense in your comment. For example:
+
+> This document contains work from the PnPQ documentation, available under the [Creative Commons Attribution 4.0 International license](https://creativecommons.org/licenses/by/4.0/) and [accessible from their GitHub repository](https://github.com/moonshot-nagayama-pj/PnPQ).
+
+For source code, please follow the instructions in the license.
+
+If this guidance is insufficient or unclear, please open a GitHub issue to ask for help.