pyglaze 0.1.0__tar.gz

pyglaze-0.1.0/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Glaze Technologies
+
+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.

pyglaze-0.1.0/MANIFEST.in

@@ -0,0 +1 @@
+include src/pyglaze/device/_delayunit_data/*

pyglaze-0.1.0/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.1
+Name: pyglaze
+Version: 0.1.0
+Summary: Pyglaze is a library used to operate the devices of Glaze Technologies
+Author: GLAZE Technologies ApS
+License: BSD 3-Clause License
+        
+        Copyright (c) 2024, Glaze Technologies
+        
+        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.
+Project-URL: Homepage, https://www.glazetech.dk/
+Project-URL: Documentation, https://glazetech.github.io/pyglaze/latest
+Project-URL: Repository, https://github.com/GlazeTech/pyglaze
+Project-URL: Issues, https://github.com/GlazeTech/pyglaze/issues
+Requires-Python: <3.13,>=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy<2.0.0,>=1.26.4
+Requires-Dist: pyserial>=3.5
+Requires-Dist: scipy>=1.7.3
+Requires-Dist: bitstring>=4.1.2
+Requires-Dist: typing_extensions>=4.12.2
+
+# Pyglaze
+Pyglaze is a python library used to operate the devices of [Glaze Technologies](https://www.glazetech.dk/).
+
+Documentation can be found [here](https://glazetech.github.io/pyglaze/latest/).
+
+# Installation
+
+To install the latest version of the package, simply run 
+
+```
+pip install pyglaze
+```
+
+# Usage 
+See [our documentation](https://glazetech.github.io/pyglaze/latest/) for usage.
+
+# Developers
+
+To install the API with development tools in editable mode, first clone the repository from our [public GitHub repository](https://github.com/GlazeTech/pyglaze). Then, from the root of the project, run
+
+```
+python -m pip install --upgrade pip
+pip install -e . --config-settings editable_mode=strict
+pip install -r requirements-dev.txt
+```
+
+## Documentation - local build
+To build and serve the documentation locally
+
+1. Checkout the repository (or a specific version)
+2. Install `mkdocs`
+3. Run `mkdocs serve` while standing in the project root.
+
+
+# Bug reporting or feature requests
+Please create an issue [here](https://github.com/GlazeTech/pyglaze/issues) and we will look at it ASAP!

pyglaze-0.1.0/README.md

@@ -0,0 +1,36 @@
+# Pyglaze
+Pyglaze is a python library used to operate the devices of [Glaze Technologies](https://www.glazetech.dk/).
+
+Documentation can be found [here](https://glazetech.github.io/pyglaze/latest/).
+
+# Installation
+
+To install the latest version of the package, simply run 
+
+```
+pip install pyglaze
+```
+
+# Usage 
+See [our documentation](https://glazetech.github.io/pyglaze/latest/) for usage.
+
+# Developers
+
+To install the API with development tools in editable mode, first clone the repository from our [public GitHub repository](https://github.com/GlazeTech/pyglaze). Then, from the root of the project, run
+
+```
+python -m pip install --upgrade pip
+pip install -e . --config-settings editable_mode=strict
+pip install -r requirements-dev.txt
+```
+
+## Documentation - local build
+To build and serve the documentation locally
+
+1. Checkout the repository (or a specific version)
+2. Install `mkdocs`
+3. Run `mkdocs serve` while standing in the project root.
+
+
+# Bug reporting or feature requests
+Please create an issue [here](https://github.com/GlazeTech/pyglaze/issues) and we will look at it ASAP!

pyglaze-0.1.0/pyproject.toml

@@ -0,0 +1,99 @@
+[project]
+name = "pyglaze"
+version = "0.1.0"
+description = "Pyglaze is a library used to operate the devices of Glaze Technologies"
+readme = "README.md"
+license = { file = "LICENSE" }
+authors = [
+    {name = "GLAZE Technologies ApS"},
+]
+requires-python = ">=3.9,<3.13"
+
+dependencies = [
+    "numpy>=1.26.4,<2.0.0",
+    "pyserial>=3.5",
+    "scipy>=1.7.3",
+    "bitstring>=4.1.2",
+    "typing_extensions>=4.12.2"
+]
+
+[project.urls]
+Homepage = "https://www.glazetech.dk/"
+Documentation = "https://glazetech.github.io/pyglaze/latest"
+Repository = "https://github.com/GlazeTech/pyglaze"
+Issues = "https://github.com/GlazeTech/pyglaze/issues"
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.pytest.ini_options]
+addopts = [
+    "--cov=pyglaze", 
+    "--import-mode=importlib",
+]
+
+[tool.coverage.report]
+exclude_also = [
+    "if TYPE_CHECKING:", # type checking is turned off at runtime
+    "@(abc\\.)?abstractmethod", # abstract methods aren't executed
+    ]
+
+[tool.ruff]
+target-version = "py39"
+lint.select = ["ALL"]
+lint.ignore = [
+    "D100",   # allow undocumented public modules
+    "D104",   # allow undocumented public package
+    "D106",   # allow undocumented public nested class
+    "D107",   # allow undocumented public __init__
+    "D203",   # allow 0 black lines before class docstring
+    "D213",   # allow multiline docstring to start on first line
+    "COM812", # allow missing trailing comma in type annotation
+    "E501",   # don't enforce line length
+    "N802", # allow uppercase in function names
+    "N803", # allow uppercase in function args
+    "N806", # allow uppercase in variable names
+    "S301", # allow unpickling
+    "ISC001", # disable as advised by "ruff format"
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = [
+    "D", # allow missing docs
+    "PLR2004", # allow magic numbers
+    "S101", # allow asserts
+    "SLF001", # allow accessing private methods
+    "T201", # allow prints in tests
+]
+
+[tool.bumpver]
+current_version = "0.1.0"
+version_pattern = "MAJOR.MINOR.PATCH[-TAG]"
+commit_message = "BUMP VERSION {old_version} -> {new_version}"
+tag_message = "v{new_version}"
+tag_scope = "default"
+pre_commit_hook = ""
+post_commit_hook = ""
+commit = true
+tag = true
+push = true
+
+[tool.bumpver.file_patterns]
+"pyproject.toml" = [
+    'current_version = "{version}"',
+    'version = "{version}"',
+]
+"src/pyglaze/__init__.py" = [
+    '__version__ = "{version}"',
+]
+"docs/index.md" = [
+    '**Documentation Version**: {version}'
+]
+

pyglaze-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pyglaze-0.1.0/src/pyglaze/__init__.py

@@ -0,0 +1 @@
+__version__ = "4.2.0"

pyglaze-0.1.0/src/pyglaze/datamodels/__init__.py

@@ -0,0 +1,4 @@
+from .pulse import Pulse
+from .waveform import UnprocessedWaveform
+
+__all__ = ["Pulse", "UnprocessedWaveform"]