noiselab 0.1.0__tar.gz

noiselab-0.1.0/.github/workflows/build_matrix.yml

@@ -0,0 +1,80 @@
+name: Build all packages
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+  workflow_call:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build_wheels:
+    name: Build wheels for ${{ matrix.os }}
+    runs-on: ${{ matrix.runs-on }}
+    strategy:
+      matrix:
+        include:
+          - os: linux-intel
+            runs-on: ubuntu-latest
+          - os: linux-arm
+            runs-on: ubuntu-24.04-arm
+        #   - os: windows-intel
+        #     runs-on: windows-latest
+        #   - os: windows-arm
+        #     runs-on: windows-11-arm
+          - os: macos-intel
+            # macos-15-intel is the last x86_64 runner
+            runs-on: macos-15-intel
+          - os: macos-arm
+            # macos-14+ (including latest) are ARM64 runners
+            runs-on: macos-latest
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          submodules: true
+          persist-credentials: false
+
+      - name: Set up QEMU
+        if: runner.os == 'Linux' && runner.arch == 'X64'
+        uses: docker/setup-qemu-action@v4
+        with:
+          platforms: all
+
+      - name: Build wheels
+        uses: pypa/cibuildwheel@v3.4.0
+        # env:
+        #   # configure cibuildwheel on Linux to build native archs ('auto') and to build arm7 on x86_64
+        #   CIBW_ARCHS_LINUX: ${{ runner.arch == 'X64' && 'auto armv7l' || 'auto' }}
+
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v7
+        with:
+          name: cibw-wheels-${{ matrix.os }}-${{ strategy.job-index }}
+          path: ./wheelhouse/*.whl
+          if-no-files-found: error
+          retention-days: 7
+
+
+  build_sdist:
+    name: Build source distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          persist-credentials: false
+
+      - name: Build sdist
+        run: pipx run build --sdist
+
+      - uses: actions/upload-artifact@v7
+        with:
+          name: cibw-sdist
+          path: dist/*.tar.gz
+          if-no-files-found: error
+          retention-days: 7

noiselab-0.1.0/.github/workflows/build_native.yml

@@ -0,0 +1,41 @@
+name: Build native package
+
+on:
+  pull_request:
+    branches:
+      - main
+      - develop
+
+  workflow_dispatch:
+  workflow_call:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build_wheels:
+    name: Build native linux wheel
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          submodules: true
+          persist-credentials: false
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.x"
+
+      - name: Build package
+        run: pipx run build
+
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v7
+        with:
+          name: python-package-distributions
+          path: dist/
+          if-no-files-found: error
+          retention-days: 7

noiselab-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,54 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+  workflow_dispatch: # Allows manual trigger from GitHub UI
+
+jobs:
+  build:
+    uses: ./.github/workflows/build_matrix.yml
+    secrets: inherit
+
+  github-release:
+    name: Upload to GitHub Release 📂
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write  # Mandatory for uploading to releases
+    steps:
+      - name: Download dists
+        uses: actions/download-artifact@v8
+        with:
+          pattern: cibw-*
+          path: dist
+          merge-multiple: true
+
+      - name: Upload artifacts to GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          prerelease: ${{ contains(github.ref_name, 'rc') }}
+          generate_release_notes: true
+
+  pypi-publish:
+    name: Publish to PyPI 🚀
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/noiselab
+    permissions:
+      id-token: write  # Required for Trusted Publishing
+    steps:
+      - name: Download dists
+        uses: actions/download-artifact@v8
+        with:
+          pattern: cibw-*
+          path: dist
+          merge-multiple: true
+
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

noiselab-0.1.0/.github/workflows/ruff.yml

@@ -0,0 +1,25 @@
+name: Ruff
+
+on:
+  push:
+    branches:
+      - 'main'
+      - 'develop'
+      - 'update/ruff'
+
+  pull_request:
+    branches:
+      - 'main'
+      - 'develop'
+      - 'update/ruff'
+
+  workflow_dispatch:
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/ruff-action@v3
+        with:
+            version: "latest"

noiselab-0.1.0/.github/workflows/test-release.yml

@@ -0,0 +1,59 @@
+name: Publish to TestPyPI
+
+on:
+  push:
+    tags:
+      - 'test-v*'
+
+  workflow_dispatch: # Allows manual trigger from GitHub UI
+
+jobs:
+  build:
+    uses: ./.github/workflows/build_matrix.yml
+    secrets: inherit
+
+  github-release:
+    name: Upload to GitHub Release 📂
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write  # Mandatory for uploading to releases
+    steps:
+      - name: Download dists
+        uses: actions/download-artifact@v8
+        with:
+          pattern: cibw-*
+          path: dist
+          merge-multiple: true
+
+      - name: Upload artifacts to GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          prerelease: true
+          generate_release_notes: true
+
+  test-publish:
+    name: Publish to TestPyPI 🧪
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/noiselab
+    permissions:
+      id-token: write  # Required for Trusted Publishing
+    steps:
+      - name: Download dists
+        uses: actions/download-artifact@v8
+        with:
+          pattern: cibw-*
+          path: dist
+          merge-multiple: true
+
+      - name: Publish distribution 📦 to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          # Optional: allow overwriting the same version on TestPyPI
+          skip-existing: true
+          verbose: true

noiselab-0.1.0/.github/workflows/tests.yml

@@ -0,0 +1,48 @@
+name: Pytest
+
+on:
+  push:
+    branches:
+      - 'main'
+      - 'develop'
+      - 'update/tests'
+
+  pull_request:
+    branches:
+      - 'main'
+      - 'develop'
+      - 'update/tests'
+
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
+      fail-fast: false
+
+    steps:
+    - name: Checkout repo
+      uses: actions/checkout@v6
+      with:
+        submodules: 'true'
+
+    - name: Setup Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+        cache: 'pip'
+
+    - name: Build and install Python package
+      run: |
+        pip install -e .[dev]
+
+    - name: Test with pytest
+      run: |
+        pytest ./tests --doctest-modules --junitxml=junit/test-results-${{ matrix.python-version }}.xml

noiselab-0.1.0/.gitignore

@@ -0,0 +1,158 @@
+# 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/
+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/
+
+# 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
+.idea/
+
+src/noiselab/_version.py

noiselab-0.1.0/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "noiselab/tdigest/t-digest-c"]
+	path = src/noiselab/tdigest/t-digest-c
+	url = https://github.com/RedisBloom/t-digest-c.git

noiselab-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.15.6
+  hooks:
+    - id: ruff-check
+      types_or: [ python, pyi ]
+      args: [ --fix ]
+
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v6.0.0
+  hooks:
+    - id: no-commit-to-branch
+      args: ['--branch', 'main']

noiselab-0.1.0/.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+    "cmake.ignoreCMakeListsMissing": true,
+    "files.autoSave": "afterDelay",
+    "files.trimTrailingWhitespace": true
+}

noiselab-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Jonathan Kohler
+
+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.

noiselab-0.1.0/MANIFEST.in

@@ -0,0 +1,2 @@
+recursive-include src/noiselab/tdigest/t-digest-c/src/ *.h
+recursive-include src/noiselab/tdigest/t-digest-c/src/ *.c

noiselab-0.1.0/PKG-INFO

@@ -0,0 +1,66 @@
+Metadata-Version: 2.4
+Name: noiselab
+Version: 0.1.0
+Summary: Efficient algorithms for noise generation and analysis in Python.
+Author-email: Jonathan Kohler <kohler.jonathan@gmail.com>
+Maintainer-email: Jonathan Kohler <kohler.jonathan@gmail.com>
+License-Expression: MIT
+Project-URL: source, https://github.com/kohlerjl/python-noiselab
+Project-URL: download, https://pypi.python.org/pypi/noiselab
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+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: Programming Language :: Python :: 3.14
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.23
+Requires-Dist: scipy
+Provides-Extra: dev
+Requires-Dist: ruff>=0.14.0; extra == "dev"
+Requires-Dist: pytest>=7.2.2; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Dynamic: license-file
+
+# python-noiselab
+
+noiselab is a collection of Cython- or C-optimized implementations of algorithms for the simulation and analysis of
+continuous-variable random processes in Python. In particular, this library is currently focused on the simulation of
+stochastic signals in time with non-trivial temporal correlations and distributions.
+
+There are a collection of Generator classes, which can generate continuous streams of stochastic signals with various
+power spectra. These noisy signals can then be analyzed using Power Spectral Density estimation routines in noiselab.psd
+or the Allan deviation, in noiselab.adev. This library also contains a wrapper for a fast TDigest library written in C,
+which can be used to efficiently estimate quantiles of arbitrary noise distributions.
+
+# Generators
+
+* WhitenoiseProcess: White noise
+* WienerProcess: Brownian noise / Wiener process
+* MarkovProcess: Orenstein-Uhlenbeck / 1st-order Markov process
+* RelaxationProcess: $\alpha = 0 - 2$ Power-law noise (PLNoise)
+
+## RelaxationProcess - PLNoise
+
+Fast Cython implemention of PLNoise2 power-low noise generation algorithm described in the following references:
+
+Milotti, Edoardo (2005), "Exact numerical simulation of power-law noises", Physical Review E, Volume 72, Issue 5, https://doi.org/10.1103/PhysRevE.72.056701 (https://arxiv.org/abs/physics/0509237)
+
+Milotti, Edoardo (2007), "New version of PLNoise: a package for exact numerical simulation of power-law noises", Computer Physics Communications, Volume 177, Issue 4
+Link: https://doi.org/10.1016/j.cpc.2007.04.005
+
+Milotti, Edoardo (2007), “New version of PLNoise: a package for exact numerical simulation of power-law noises ”, Mendeley Data, V1, doi: 10.17632/nt7mcwh98m.1
+Link: https://doi.org/10.17632/nt7mcwh98m.1
+
+
+# TDigest
+* https://arxiv.org/abs/1902.04023
+* Python bindings for C library: https://github.com/RedisBloom/t-digest-c

noiselab-0.1.0/Pipfile

@@ -0,0 +1,15 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[requires]
+python_version = "3.11"
+
+[packages]
+cython = ">=0.29"
+numpy = ">=1.23"
+scipy = "*"
+
+[dev-packages]
+pytest = "*"