signaloid 2.0.0__tar.gz

signaloid-2.0.0/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2024, Signaloid.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

signaloid-2.0.0/PKG-INFO

@@ -0,0 +1,130 @@
+Metadata-Version: 2.4
+Name: signaloid
+Version: 2.0.0
+Summary: Signaloid Data Toolkit for interacting with Signaloid's UxHw®.
+License: MIT
+License-File: LICENSE
+Author: Signaloid
+Author-email: info@signaloid.com
+Requires-Python: >=3.11,<4
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+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: Programming Language :: Python :: 3.15
+Requires-Dist: matplotlib (>=3.10.0) ; python_version >= "3.11" and python_version < "3.14"
+Requires-Dist: matplotlib (>=3.10.5) ; python_version >= "3.11" and python_version < "3.15"
+Requires-Dist: matplotlib (>=3.9.0) ; python_version >= "3.11" and python_version < "3.13"
+Requires-Dist: numpy (>=2.0.0) ; python_version >= "3.11" and python_version < "3.13"
+Requires-Dist: numpy (>=2.1.0) ; python_version >= "3.11" and python_version < "3.14"
+Requires-Dist: numpy (>=2.4.1) ; python_version >= "3.11" and python_version < "3.15"
+Requires-Dist: pillow (>=13.0.0)
+Requires-Dist: scipy (>=1.14.0)
+Project-URL: Homepage, https://signaloid.com
+Project-URL: Repository, https://github.com/signaloid/signaloid-data-toolkit
+Description-Content-Type: text/markdown
+
+# Signaloid Data Toolkit
+
+The Signaloid Data Toolkit provides tools for interacting with
+applications that utilize Signaloid's UxHw® technology for distributional
+arithmetic. Use the library to analyze Ux Data values from the application.
+
+The tools for benchmarking applications against equivalent Monte Carlo
+methods build on this library and live in the separate
+[signaloid-benchmarking](https://github.com/signaloid/signaloid-benchmarking)
+repository.
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/signaloid/signaloid-data-toolkit/main/images/signaloid-external-illustration-signaloid-data-toolkit-diagram-flat-dark-withCR.png">
+  <img alt="signaloid-data-toolkit diagram" src="https://raw.githubusercontent.com/signaloid/signaloid-data-toolkit/main/images/signaloid-external-illustration-signaloid-data-toolkit-diagram-flat-light-withCR.png">
+</picture>
+
+## Requirements
+
+The Signaloid Data Toolkit requires Python 3.11 or later. See
+`pyproject.toml` for the full list of dependencies.
+
+## Installation
+Install the `signaloid` package via pip (recommended):
+```bash
+python -m pip install signaloid
+```
+
+
+Install the latest version from the GitHub repository:
+```bash
+python -m pip install git+https://github.com/signaloid/signaloid-data-toolkit
+```
+
+Alternatively, clone this repository and install from source with:
+```bash
+python -m pip install .
+```
+
+## Usage
+
+### Parsing Ux Data
+Construct `DistributionalValue` Python objects by parsing
+[Ux Data](https://docs.signaloid.io/docs/uxhw-api/ux-data-format/) in
+Ux-string or Ux Binary format.
+
+```python
+from signaloid.distributional.distributional import DistributionalValue
+
+# Intermediate code which writes to ux_string and ux_binary_buffer
+# ...
+
+# Parse a Ux-string
+dist_value = DistributionalValue.parse(ux_string)
+
+# Parse a Ux Binary buffer
+dist_value = DistributionalValue.parse(ux_binary_buffer)
+```
+
+### Create Distribution Plots
+Create plots to visualize distributional information by using the
+[`plot` function](https://github.com/signaloid/signaloid-data-toolkit/blob/main/src/signaloid/distributional_information_plotting/plot_wrapper.py)
+with a `PlotData` object built from a `DistributionalValue` containing Ux Data.
+The `plot` function is a wrapper function for the `PlotHistogramDiracDeltas`
+class for plotting a distributional value as a histogram with variable bin
+widths.
+
+```python
+from signaloid.distributional.distributional import DistributionalValue
+from signaloid.distributional_information_plotting.plot_histogram_dirac_deltas import PlotData
+from signaloid.distributional_information_plotting.plot_wrapper import plot
+
+# Intermediate code which writes to ux_string
+# ...
+
+# Create distributional value object from Ux-string
+dist_value = DistributionalValue.parse(ux_string)
+plot(PlotData(dist_value))
+```
+
+For plotting from raw samples, saving to a file, and the other `plot` options,
+see the package [README.md](https://github.com/signaloid/signaloid-data-toolkit/blob/main/src/signaloid/distributional_information_plotting/README.md).
+
+### Sample from Ux Data
+Draw random samples from a distributional value with the
+[`sample_generator` function](https://github.com/signaloid/signaloid-data-toolkit/blob/main/src/signaloid/distributional_information_plotting/sample_generator.py).
+Samples of the finite part of the distribution are drawn by inverse transform
+sampling of the binned distribution. Distributions that also carry non-finite
+mass (`NaN`, `-Inf`, `+Inf`) are sampled as a mixture, with each sample drawn
+from the finite or the non-finite part in proportion to their masses.
+
+```python
+from signaloid.distributional_information_plotting.sample_generator import sample_generator
+
+# Intermediate code which writes to ux_string
+# ...
+
+samples = sample_generator(ux_string, n_samples=1000)
+```
+
+To sample from a `DistributionalValue` that is already parsed, use
+`sample_from_distributional_value` from the same module.
+

signaloid-2.0.0/README.md

@@ -0,0 +1,101 @@
+# Signaloid Data Toolkit
+
+The Signaloid Data Toolkit provides tools for interacting with
+applications that utilize Signaloid's UxHw® technology for distributional
+arithmetic. Use the library to analyze Ux Data values from the application.
+
+The tools for benchmarking applications against equivalent Monte Carlo
+methods build on this library and live in the separate
+[signaloid-benchmarking](https://github.com/signaloid/signaloid-benchmarking)
+repository.
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/signaloid/signaloid-data-toolkit/main/images/signaloid-external-illustration-signaloid-data-toolkit-diagram-flat-dark-withCR.png">
+  <img alt="signaloid-data-toolkit diagram" src="https://raw.githubusercontent.com/signaloid/signaloid-data-toolkit/main/images/signaloid-external-illustration-signaloid-data-toolkit-diagram-flat-light-withCR.png">
+</picture>
+
+## Requirements
+
+The Signaloid Data Toolkit requires Python 3.11 or later. See
+`pyproject.toml` for the full list of dependencies.
+
+## Installation
+Install the `signaloid` package via pip (recommended):
+```bash
+python -m pip install signaloid
+```
+
+
+Install the latest version from the GitHub repository:
+```bash
+python -m pip install git+https://github.com/signaloid/signaloid-data-toolkit
+```
+
+Alternatively, clone this repository and install from source with:
+```bash
+python -m pip install .
+```
+
+## Usage
+
+### Parsing Ux Data
+Construct `DistributionalValue` Python objects by parsing
+[Ux Data](https://docs.signaloid.io/docs/uxhw-api/ux-data-format/) in
+Ux-string or Ux Binary format.
+
+```python
+from signaloid.distributional.distributional import DistributionalValue
+
+# Intermediate code which writes to ux_string and ux_binary_buffer
+# ...
+
+# Parse a Ux-string
+dist_value = DistributionalValue.parse(ux_string)
+
+# Parse a Ux Binary buffer
+dist_value = DistributionalValue.parse(ux_binary_buffer)
+```
+
+### Create Distribution Plots
+Create plots to visualize distributional information by using the
+[`plot` function](https://github.com/signaloid/signaloid-data-toolkit/blob/main/src/signaloid/distributional_information_plotting/plot_wrapper.py)
+with a `PlotData` object built from a `DistributionalValue` containing Ux Data.
+The `plot` function is a wrapper function for the `PlotHistogramDiracDeltas`
+class for plotting a distributional value as a histogram with variable bin
+widths.
+
+```python
+from signaloid.distributional.distributional import DistributionalValue
+from signaloid.distributional_information_plotting.plot_histogram_dirac_deltas import PlotData
+from signaloid.distributional_information_plotting.plot_wrapper import plot
+
+# Intermediate code which writes to ux_string
+# ...
+
+# Create distributional value object from Ux-string
+dist_value = DistributionalValue.parse(ux_string)
+plot(PlotData(dist_value))
+```
+
+For plotting from raw samples, saving to a file, and the other `plot` options,
+see the package [README.md](https://github.com/signaloid/signaloid-data-toolkit/blob/main/src/signaloid/distributional_information_plotting/README.md).
+
+### Sample from Ux Data
+Draw random samples from a distributional value with the
+[`sample_generator` function](https://github.com/signaloid/signaloid-data-toolkit/blob/main/src/signaloid/distributional_information_plotting/sample_generator.py).
+Samples of the finite part of the distribution are drawn by inverse transform
+sampling of the binned distribution. Distributions that also carry non-finite
+mass (`NaN`, `-Inf`, `+Inf`) are sampled as a mixture, with each sample drawn
+from the finite or the non-finite part in proportion to their masses.
+
+```python
+from signaloid.distributional_information_plotting.sample_generator import sample_generator
+
+# Intermediate code which writes to ux_string
+# ...
+
+samples = sample_generator(ux_string, n_samples=1000)
+```
+
+To sample from a `DistributionalValue` that is already parsed, use
+`sample_from_distributional_value` from the same module.

signaloid-2.0.0/pyproject.toml

@@ -0,0 +1,79 @@
+[tool.poetry]
+name = "signaloid"
+version = "2.0.0"
+description = "Signaloid Data Toolkit for interacting with Signaloid's UxHw®."
+readme = "README.md"
+license = "MIT"
+homepage = "https://signaloid.com"
+repository = "https://github.com/signaloid/signaloid-data-toolkit"
+authors = [
+	"Signaloid <info@signaloid.com>"
+]
+
+packages = [
+	{ include = "signaloid", from = "src" }
+]
+
+[tool.poetry-dynamic-versioning]
+enable = false
+vcs = "git"
+style = "pep440"
+
+
+[tool.poetry.group.dev.dependencies]
+wheel = "^0.46.3"
+types-toml = "^0.10.8.20240310"
+pytest = "^9.0.3"
+mypy = "^1.19.1"
+flake8 = "^7.3.0"
+toml = "^0.10.2"
+black = "^26.3.1"
+
+[build-system]
+requires = ["poetry-core>=1.9.1", "poetry-dynamic-versioning>=1.0.0,<2.0.0"]
+build-backend = "poetry_dynamic_versioning.backend"
+
+[tool.poetry.dependencies]
+python = ">=3.11,<4"
+numpy = [
+	{ version = ">=2.0.0", python = ">=3.11,<3.13" },
+	{ version = ">=2.1.0", python = ">=3.11,<3.14" },
+	{ version = ">=2.4.1", python = ">=3.11,<3.15" },
+]
+matplotlib = [
+	{ version = ">=3.9.0", python = ">=3.11,<3.13" },
+	{ version = ">=3.10.0", python = ">=3.11,<3.14" },
+	{ version = ">=3.10.5", python = ">=3.11,<3.15" },
+]
+pillow = ">=13.0.0"
+scipy = ">=1.14.0"
+
+[tool.poetry.scripts]
+signaloid-uxdata-toolkit = "signaloid.uxdata_toolkit:main"
+
+[tool.mypy]
+warn_unused_configs = true
+strict = true
+disallow_any_generics = false
+python_version = "3.11"
+exclude = '(^|/)\.venv/'
+# `signaloid` is a PEP 420 namespace package, so it has no top-level `py.typed`
+# marker. Resolve it from the source tree (via `mypy_path`) rather than as an
+# installed distribution, so `mypy -p signaloid` type-checks the sources
+# directly instead of failing on the absent namespace-level marker.
+mypy_path = "src"
+namespace_packages = true
+explicit_package_bases = true
+
+[[tool.mypy.overrides]]
+module = [
+	"signaloid.distributional_information_plotting.*",
+	"signaloid.distributional.*",
+	"signaloid.circuitpython.*",
+]
+disallow_untyped_calls = false
+disallow_untyped_defs = false
+disallow_incomplete_defs = false
+warn_unused_ignores = false
+check_untyped_defs = false
+strict_equality = false

signaloid-2.0.0/src/signaloid/circuitpython/README.md

@@ -0,0 +1,3 @@
+### Helpers for CircuitPython
+- `extended_ulab_numpy.py`: Extends the [ulab numpy implementation](https://docs.circuitpython.org/en/latest/shared-bindings/ulab/numpy/index.html) with extra methods needed for the `distributional` and `distributional_information_plotting` modules.
+- `plot_wrapper.py`: Implements a plot renderer specifically for Signaloid Ux histograms.