pyFDN 0.1.0__tar.gz

pyfdn-0.1.0/AUTHORS.rst

@@ -0,0 +1,11 @@
+=======
+Credits
+=======
+
+
+Core Contributors
+-----------------
+
+* Sebastian J. Schlecht
+* Facundo Franchino
+* Jeremy Bai

pyfdn-0.1.0/CONTRIBUTING.rst

@@ -0,0 +1,207 @@
+============
+Contributing
+============
+
+Contributions are welcome! This guide covers how to report issues, request features, set up your development environment, and run tests.
+
+
+Issues and Requests
+-------------------
+
+Report bugs or request features on the `GitHub issue tracker <https://github.com/artificial-audio/pyFDN/issues>`_.
+
+Reporting Bugs
+^^^^^^^^^^^^^^
+
+Please include:
+
+* Operating system name and version
+* Python version
+* Detailed steps to reproduce
+* Expected vs actual behavior
+
+Requesting Features
+^^^^^^^^^^^^^^^^^^^
+
+Please include:
+
+* Clear description of the feature
+* Use case and motivation
+* Proposed implementation approach (if applicable)
+
+Pull Requests
+^^^^^^^^^^^^^
+
+* Include tests for new functionality
+* Update documentation as needed
+* Ensure all tests pass before submitting
+
+
+Development Installation
+------------------------
+
+1. **Fork and clone the repository**:
+
+   .. code-block:: console
+
+      $ git clone git@github.com:your_name_here/pyFDN.git
+      $ cd pyFDN
+
+2. **Create a virtual environment**:
+
+   .. code-block:: console
+
+      $ python -m venv .venv
+      $ source .venv/bin/activate
+
+3. **Install pyFDN in editable mode with development dependencies**:
+
+   .. code-block:: console
+
+      $ pip install -e ".[dev]"
+
+4. **Install and activate pre-commit hooks**:
+
+   .. code-block:: console
+
+      $ pre-commit install
+
+   This installs git hooks that automatically run Ruff (lint + format) and mypy
+   on every commit. To run them manually on all files:
+
+   .. code-block:: console
+
+      $ pre-commit run --all-files
+
+5. **Install FLAMO locally** (required for development):
+
+   FLAMO is under active development alongside pyFDN. You are recommended to install it locally in editable mode:
+
+   .. code-block:: console
+
+      $ git clone <flamo-repository-url>
+      $ cd flamo
+      $ pip install -e .
+
+   Then return to the pyFDN directory. The local FLAMO installation will be used
+   by pyFDN during development and testing.
+
+6. **Verify installation**:
+
+   .. code-block:: console
+
+      $ pytest tests/ -v
+
+
+Building the Documentation
+--------------------------
+
+1. **Install docs dependencies** (if not already):
+
+   .. code-block:: console
+
+      $ pip install -e ".[docs]"
+
+2. **Install pandoc** (system dependency required by ``nbsphinx``):
+
+   .. code-block:: console
+
+      $ brew install pandoc          # macOS
+      $ sudo apt install pandoc      # Ubuntu / Debian
+
+3. **Build the HTML docs**:
+
+   .. code-block:: console
+
+      $ make docs
+
+   This runs ``sphinx-apidoc``, builds all pages (including executing the
+   example notebooks), and opens the result in your browser.
+
+   Alternatively, build only the HTML without opening a browser:
+
+   .. code-block:: console
+
+      $ cd docs
+      $ make html
+
+4. **Preview**: Open ``docs/_build/html/index.html`` in your browser.
+
+.. note::
+
+   The example notebooks are executed at build time by ``nbsphinx``. The
+   first build may take a few minutes. Subsequent builds are faster because
+   Sphinx caches the executed notebooks.
+
+
+Repository Index
+----------------
+
+.. note::
+    This section will be filled out later with the goal structure of the repository.
+
+
+Testing Pipeline
+----------------
+
+**Configuration**
+
+Tests are configured via ``pytest`` and ``tox.ini``. The test suite includes:
+
+* Unit tests for individual functions
+* Regression tests against MATLAB reference implementations
+* Integration tests with FLAMO
+
+**Running Tests**
+
+Run all tests:
+
+.. code-block:: console
+
+   $ pytest
+
+Run specific test file:
+
+.. code-block:: console
+
+   $ pytest tests/test_one_pole_absorption_regression.py
+
+Run with coverage:
+
+.. code-block:: console
+
+   $ pytest --cov=pyFDN --cov-report=html
+
+Run tests across multiple Python versions (requires tox):
+
+.. code-block:: console
+
+   $ tox
+
+**Cross-Validation Example**
+
+The regression test suite validates pyFDN outputs against MATLAB reference data.
+Example: ``test_one_pole_absorption_regression.py`` compares Python-generated absorption filter coefficients and impulse responses with MATLAB FDN Toolbox results.
+
+To run a specific cross-validation test:
+
+.. code-block:: console
+
+   $ pytest tests/test_one_pole_absorption_regression.py::test_one_pole_absorption_coefficients -v
+
+The test loads MATLAB reference data from ``tests/reference/``, generates equivalent Python outputs, and validates numerical agreement within specified tolerances.
+
+**Test Structure**
+
+* ``tests/conftest.py``: Shared fixtures (e.g., ``loadmat`` for loading MATLAB files)
+* ``tests/reference/``: MATLAB reference data files (``.mat`` format)
+* ``tests/test_*.py``: Test modules organized by functionality
+
+
+Code of Conduct
+---------------
+
+Please note that this project is released with a `Contributor Code of Conduct`_.
+By participating in this project you agree to abide by its terms.
+
+.. _`Contributor Code of Conduct`: CODE_OF_CONDUCT.rst

pyfdn-0.1.0/HISTORY.rst

@@ -0,0 +1,8 @@
+=======
+History
+=======
+
+0.1.0 (2025-07-02)
+------------------
+
+* First release on PyPI.

pyfdn-0.1.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2026, Artificial Audio Lab
+
+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.
+

pyfdn-0.1.0/MANIFEST.in

@@ -0,0 +1,11 @@
+include AUTHORS.rst
+include CONTRIBUTING.rst
+include HISTORY.rst
+include LICENSE
+include README.rst
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif

pyfdn-0.1.0/PKG-INFO

@@ -0,0 +1,158 @@
+Metadata-Version: 2.4
+Name: pyFDN
+Version: 0.1.0
+Summary: Python library for Feedback Delay Networks
+Author: Sebastian J. Schlecht, Facundo Franchino, Jeremy Bai
+Maintainer: Facundo Franchino, Sebastian J. Schlecht
+License-Expression: MIT
+Project-URL: bugs, https://github.com/artificial-audio/pyFDN/issues
+Project-URL: changelog, https://github.com/artificial-audio/pyFDN/releases
+Project-URL: homepage, https://github.com/artificial-audio/pyFDN
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: soundfile
+Requires-Dist: scipy
+Requires-Dist: flamo>=0.2.14
+Requires-Dist: flareverb
+Requires-Dist: pyroomacoustics
+Provides-Extra: examples
+Requires-Dist: marimo; extra == "examples"
+Requires-Dist: matplotlib>=3.5.0; extra == "examples"
+Requires-Dist: plotly>=5.0.0; extra == "examples"
+Provides-Extra: test
+Requires-Dist: marimo; extra == "test"
+Requires-Dist: matplotlib>=3.5.0; extra == "test"
+Requires-Dist: plotly>=5.0.0; extra == "test"
+Requires-Dist: pytest>=7.0.0; extra == "test"
+Requires-Dist: pytest-cov>=4.0.0; extra == "test"
+Requires-Dist: coverage>=7.0.0; extra == "test"
+Provides-Extra: dev
+Requires-Dist: pyFDN[test]; extra == "dev"
+Requires-Dist: tox>=4.0.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: twine>=4.0.0; extra == "dev"
+Requires-Dist: wheel>=0.40.0; extra == "dev"
+Requires-Dist: build>=0.10.0; extra == "dev"
+Requires-Dist: bump-my-version>=1.0.0; extra == "dev"
+Requires-Dist: watchdog>=3.0.0; extra == "dev"
+Requires-Dist: pre-commit>=3.0.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: Sphinx>=6.0.0; extra == "docs"
+Requires-Dist: pydata-sphinx-theme>=0.15.0; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints>=1.0.0; extra == "docs"
+Requires-Dist: sphinx-design>=0.5.0; extra == "docs"
+Requires-Dist: sphinx-copybutton>=0.5.0; extra == "docs"
+Requires-Dist: sphinx-marimo; extra == "docs"
+Requires-Dist: nbsphinx>=0.9.0; extra == "docs"
+Requires-Dist: ipykernel>=6.0.0; extra == "docs"
+Requires-Dist: pandoc>=2.0; extra == "docs"
+Requires-Dist: plotly>=5.0.0; extra == "docs"
+Requires-Dist: matplotlib>=3.5.0; extra == "docs"
+Dynamic: license-file
+
+=====
+pyFDN
+=====
+
+.. image:: docs/logo/logo_pyFDN_4.png
+   :alt: pyFDN
+   :align: center
+   :width: 300px
+
+.. image:: https://img.shields.io/badge/python-3.10%20%7C%203.11-blue
+        :target: https://www.python.org/downloads/
+        :alt: Python versions
+
+.. image:: https://img.shields.io/badge/license-MIT-blue.svg
+        :target: https://opensource.org/licenses/MIT
+        :alt: License
+
+.. image:: https://img.shields.io/badge/coverage-68%25-brightgreen
+    :target: https://github.com/artificial-audio/pyFDN/actions/workflows/ci.yml
+    :alt: Test coverage
+
+`Documentation <https://artificial-audio.github.io/pyFDN/>`_ |
+`Examples <https://artificial-audio.github.io/pyFDN/examples_gallery.html>`_ |
+`Report a bug <https://github.com/artificial-audio/pyFDN/issues>`_
+
+
+Overview
+--------
+
+``pyFDN`` provides building blocks for designing, simulating, and analysing Feedback Delay Networks (FDNs). The package focuses on reusable, tested helper functions that simplify typical FDN workflows such as creating orthogonal feedback matrices, designing loop filters, and inspecting pole locations. Using ``flamo`` as a dependency, ``pyFDN`` allows modular design of advanced FDN structure with DSP operations in time and frequency domain.
+
+
+Highlights
+----------
+
+* Matrix polynomial helpers for evaluating, differentiating, and convolving FIR/IIR blocks.
+* Loop analysis utilities including pole boundary estimation and curve bounding checks.
+* Acoustic absorption design tools that translate RT targets into one-pole loop filters.
+* Echo density (Abel & Huang 2006) for analysing reverberation and mixing time.
+* Random orthogonal matrix generation to prototype energy-preserving feedback networks.
+
+
+Installation
+------------
+
+Install the current release from PyPI::
+
+    pip install pyFDN
+
+For local development, create a virtual environment and install the package in
+editable mode together with the optional tooling::
+
+    python -m venv .venv
+    source .venv/bin/activate
+    pip install -e .
+
+
+Quick start
+-----------
+
+All main functions are accessible directly from the top-level ``pyFDN`` namespace::
+
+    import numpy as np
+    import pyFDN
+
+    fs = 48_000
+    delays = np.array([331, 347, 359, 373], dtype=int)
+
+    # energy-preserving feedback matrix
+    feedback = pyFDN.random_orthogonal(len(delays))
+
+    # one-pole absorption filters targeting RT of 1.2 s at DC and 0.9 s at Nyquist
+    absorption = pyFDN.one_pole_absorption(1.2, 0.9, delays, fs)
+
+    # convert delay state-space to standard state-space (A_ss, b, c, d)
+    A_ss, b, c, d = pyFDN.dss_to_ss(delays, feedback)
+
+Alternatively, import specific functions directly::
+
+    from pyFDN import random_orthogonal, one_pole_absorption, lin_to_db
+
+    feedback = random_orthogonal(4)
+    absorption = one_pole_absorption(1.2, 0.9, [100, 150, 200, 250], 48_000)
+
+
+Development
+-----------
+
+Run the test suite (the configuration mirrors CI and emits coverage details)::
+
+    tox -e py311
+
+Or, inside an activated virtual environment::
+
+    pytest --cov=src/pyFDN --cov-report=term-missing
+
+For linting and packaging helpers see ``Makefile`` (``make lint``/``make docs``)
+and ``tox.ini`` for multi-environment testing.

pyfdn-0.1.0/README.rst

@@ -0,0 +1,98 @@
+=====
+pyFDN
+=====
+
+.. image:: docs/logo/logo_pyFDN_4.png
+   :alt: pyFDN
+   :align: center
+   :width: 300px
+
+.. image:: https://img.shields.io/badge/python-3.10%20%7C%203.11-blue
+        :target: https://www.python.org/downloads/
+        :alt: Python versions
+
+.. image:: https://img.shields.io/badge/license-MIT-blue.svg
+        :target: https://opensource.org/licenses/MIT
+        :alt: License
+
+.. image:: https://img.shields.io/badge/coverage-68%25-brightgreen
+    :target: https://github.com/artificial-audio/pyFDN/actions/workflows/ci.yml
+    :alt: Test coverage
+
+`Documentation <https://artificial-audio.github.io/pyFDN/>`_ |
+`Examples <https://artificial-audio.github.io/pyFDN/examples_gallery.html>`_ |
+`Report a bug <https://github.com/artificial-audio/pyFDN/issues>`_
+
+
+Overview
+--------
+
+``pyFDN`` provides building blocks for designing, simulating, and analysing Feedback Delay Networks (FDNs). The package focuses on reusable, tested helper functions that simplify typical FDN workflows such as creating orthogonal feedback matrices, designing loop filters, and inspecting pole locations. Using ``flamo`` as a dependency, ``pyFDN`` allows modular design of advanced FDN structure with DSP operations in time and frequency domain.
+
+
+Highlights
+----------
+
+* Matrix polynomial helpers for evaluating, differentiating, and convolving FIR/IIR blocks.
+* Loop analysis utilities including pole boundary estimation and curve bounding checks.
+* Acoustic absorption design tools that translate RT targets into one-pole loop filters.
+* Echo density (Abel & Huang 2006) for analysing reverberation and mixing time.
+* Random orthogonal matrix generation to prototype energy-preserving feedback networks.
+
+
+Installation
+------------
+
+Install the current release from PyPI::
+
+    pip install pyFDN
+
+For local development, create a virtual environment and install the package in
+editable mode together with the optional tooling::
+
+    python -m venv .venv
+    source .venv/bin/activate
+    pip install -e .
+
+
+Quick start
+-----------
+
+All main functions are accessible directly from the top-level ``pyFDN`` namespace::
+
+    import numpy as np
+    import pyFDN
+
+    fs = 48_000
+    delays = np.array([331, 347, 359, 373], dtype=int)
+
+    # energy-preserving feedback matrix
+    feedback = pyFDN.random_orthogonal(len(delays))
+
+    # one-pole absorption filters targeting RT of 1.2 s at DC and 0.9 s at Nyquist
+    absorption = pyFDN.one_pole_absorption(1.2, 0.9, delays, fs)
+
+    # convert delay state-space to standard state-space (A_ss, b, c, d)
+    A_ss, b, c, d = pyFDN.dss_to_ss(delays, feedback)
+
+Alternatively, import specific functions directly::
+
+    from pyFDN import random_orthogonal, one_pole_absorption, lin_to_db
+
+    feedback = random_orthogonal(4)
+    absorption = one_pole_absorption(1.2, 0.9, [100, 150, 200, 250], 48_000)
+
+
+Development
+-----------
+
+Run the test suite (the configuration mirrors CI and emits coverage details)::
+
+    tox -e py311
+
+Or, inside an activated virtual environment::
+
+    pytest --cov=src/pyFDN --cov-report=term-missing
+
+For linting and packaging helpers see ``Makefile`` (``make lint``/``make docs``)
+and ``tox.ini`` for multi-environment testing.

pyfdn-0.1.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = pyFDN
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)