From 625d68c8b6c95bf0490f4f26de7f0cf263eed64e Mon Sep 17 00:00:00 2001 From: Fabian Brinkmann Date: Fri, 9 Jan 2026 22:00:27 +0100 Subject: [PATCH 1/4] add imports for classes and modules --- bayesian_listener/__init__.py | 6 +++++ tests/test_bayesian_listener.py | 11 +-------- tests/test_imports.py | 41 +++++++++++++++++++++++++++++++++ 3 files changed, 48 insertions(+), 10 deletions(-) create mode 100644 tests/test_imports.py diff --git a/bayesian_listener/__init__.py b/bayesian_listener/__init__.py index 6e048e1..5a8aef7 100644 --- a/bayesian_listener/__init__.py +++ b/bayesian_listener/__init__.py @@ -5,3 +5,9 @@ __author__ = """''""" __email__ = '' __version__ = '#' + +from .bayesian_listener import BayesianListener + +from . import metrics +from . import resample +from . import utils diff --git a/tests/test_bayesian_listener.py b/tests/test_bayesian_listener.py index 57fd5f4..8e90b21 100644 --- a/tests/test_bayesian_listener.py +++ b/tests/test_bayesian_listener.py @@ -1,17 +1,8 @@ import pytest - - -def test_import_bayesian_listener(): - try: - import bayesian_listener # noqa - except ImportError: - pytest.fail('import bayesian_listener failed') - -import pytest import numpy as np from pathlib import Path import urllib.request -from bayesian_listener.bayesian_listener import BayesianListener +from bayesian_listener import BayesianListener from bayesian_listener.coordinates import Coordinates diff --git a/tests/test_imports.py b/tests/test_imports.py new file mode 100644 index 0000000..1ddeabc --- /dev/null +++ b/tests/test_imports.py @@ -0,0 +1,41 @@ +import pytest + + +def test_import_bayesian_listener(): + """Test package import""" + try: + import bayesian_listener # noqa + except ImportError: + pytest.fail('import bayesian_listener failed') + + +def test_import_bayesian_listener_class(): + """Test BayesianListener class import""" + try: + from bayesian_listener import BayesianListener # noqa + except ImportError: + pytest.fail('from bayesian_listener import BayesianListener failed') + + +def test_import_metrics(): + """Test import of the metrics module""" + try: + from bayesian_listener import metrics # noqa + except ImportError: + pytest.fail('from bayesian_listener import metrics failed') + + +def test_import_resample(): + """Test import of the resample module""" + try: + from bayesian_listener import resample # noqa + except ImportError: + pytest.fail('from bayesian_listener import resample failed') + + +def test_import_utils(): + """Test import of the utils module""" + try: + from bayesian_listener import utils # noqa + except ImportError: + pytest.fail('from bayesian_listener import utils failed') From 22040776e3520dbc24071c0fa2f2ba187d119c8f Mon Sep 17 00:00:00 2001 From: Fabian Brinkmann Date: Sat, 10 Jan 2026 14:03:37 +0100 Subject: [PATCH 2/4] Correct information in contributing --- CONTRIBUTING.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index a66261c..98c5be2 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -14,12 +14,12 @@ Types of Contributions Report Bugs or Suggest Features ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The best place for this is https://github.com/robaru/bayesian_listener/issues. +The best place for this is https://github.com/robaru/bayesian_listener_package/issues. Fix Bugs or Implement Features ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Look through https://github.com/robaru/bayesian_listener/issues for bugs or feature request +Look through https://github.com/robaru/bayesian_listener_package/issues for bugs or feature request and contact us or comment if you are interested in implementing. Write Documentation @@ -32,18 +32,18 @@ articles, and such. Get Started! ------------ -Ready to contribute? Here's how to set up `bayesian_listener` for local development using the command-line interface. Note that several alternative user interfaces exist, e.g., the Git GUI, `GitHub Desktop `_, extensions in `Visual Studio Code `_ ... +Ready to contribute? Here's how to set up `bayesian_listener_package` for local development using the command-line interface. Note that several alternative user interfaces exist, e.g., the Git GUI, `GitHub Desktop `_, extensions in `Visual Studio Code `_ ... 1. `Fork `_ the `bayesian_listener` repo on GitHub. -2. Clone your fork locally and cd into the bayesian_listener directory:: +2. Clone your fork locally and cd into the bayesian_listener_package directory:: - $ git clone https://github.com/YOUR_USERNAME/bayesian_listener.git - $ cd bayesian_listener + $ git clone https://github.com/robaru/bayesian_listener_package.git + $ cd bayesian_listener_package 3. Install your local copy into a virtualenv. Assuming you have Anaconda or Miniconda installed, this is how you set up your fork for local development:: - $ conda create --name bayesian_listener python - $ conda activate bayesian_listener + $ conda create --name bayesian_listener_package python + $ conda activate bayesian_listener_package $ pip install -e ".[dev]" 4. Create a branch for local development. Indicate the intention of your branch in its respective name (i.e. `feature/branch-name` or `bugfix/branch-name`):: From 87d35dbe3f8a29df1f282cead143cf9a1cf76fbf Mon Sep 17 00:00:00 2001 From: Fabian Brinkmann Date: Sat, 10 Jan 2026 14:03:50 +0100 Subject: [PATCH 3/4] add initial content to docs --- bayesian_listener/bayesian_listener.py | 3 +++ bayesian_listener/metrics.py | 4 ++++ bayesian_listener/resample.py | 4 ++++ bayesian_listener/utils.py | 1 + docs/api_reference.rst | 12 ++++++++---- docs/classes/bayesian_listener.rst | 9 +++++++++ docs/modules/bayesian_listener.rst | 7 ------- docs/modules/metrics.rst | 8 ++++++++ docs/modules/resample.rst | 8 ++++++++ docs/modules/utils.rst | 8 ++++++++ 10 files changed, 53 insertions(+), 11 deletions(-) create mode 100644 docs/classes/bayesian_listener.rst delete mode 100644 docs/modules/bayesian_listener.rst create mode 100644 docs/modules/metrics.rst create mode 100644 docs/modules/resample.rst create mode 100644 docs/modules/utils.rst diff --git a/bayesian_listener/bayesian_listener.py b/bayesian_listener/bayesian_listener.py index 2ba29d0..c531df7 100644 --- a/bayesian_listener/bayesian_listener.py +++ b/bayesian_listener/bayesian_listener.py @@ -1,3 +1,6 @@ +""" +The following describes the BayesianListner, which is the core auditory model. +""" import sofar import numpy as np import matplotlib.pyplot as plt diff --git a/bayesian_listener/metrics.py b/bayesian_listener/metrics.py index 4311c7d..5a87e0c 100644 --- a/bayesian_listener/metrics.py +++ b/bayesian_listener/metrics.py @@ -1,3 +1,7 @@ +""" +This module contains functions to compute localization errors based on a set +of target and response directions. +""" import numpy as np # Shared dictionary to hold metric functions and their metadata diff --git a/bayesian_listener/resample.py b/bayesian_listener/resample.py index 755763f..dba700a 100644 --- a/bayesian_listener/resample.py +++ b/bayesian_listener/resample.py @@ -1,3 +1,7 @@ +""" +This module contains functions to spatially resample ITD, ILD and spectral +cues. +""" import numpy as np import spharpy as sy import spaudiopy diff --git a/bayesian_listener/utils.py b/bayesian_listener/utils.py index 14e3383..a1ab060 100644 --- a/bayesian_listener/utils.py +++ b/bayesian_listener/utils.py @@ -1,3 +1,4 @@ +"""This model contains helpful utility functions.""" import numpy as np from scipy.signal import butter, hilbert, correlate, lfilter from math import factorial diff --git a/docs/api_reference.rst b/docs/api_reference.rst index 888a52e..b2a96c0 100644 --- a/docs/api_reference.rst +++ b/docs/api_reference.rst @@ -3,9 +3,12 @@ API Reference ============= -The following gives detailed information about all bayesian_listener functions sorted -according to their modules. +The following documents the BayesianListener model along with its additional functions provided in separate modules. +.. toctree:: + :maxdepth: 1 + + classes/bayesian_listener Modules ------- @@ -13,5 +16,6 @@ Modules .. toctree:: :maxdepth: 1 - modules/bayesian_listener - + modules/metrics + modules/resample + modules/utils diff --git a/docs/classes/bayesian_listener.rst b/docs/classes/bayesian_listener.rst new file mode 100644 index 0000000..84377f1 --- /dev/null +++ b/docs/classes/bayesian_listener.rst @@ -0,0 +1,9 @@ +BayesianListener +================= + +.. automodule:: bayesian_listener.bayesian_listener + +.. autoclass:: bayesian_listener.BayesianListener + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/modules/bayesian_listener.rst b/docs/modules/bayesian_listener.rst deleted file mode 100644 index ee112fa..0000000 --- a/docs/modules/bayesian_listener.rst +++ /dev/null @@ -1,7 +0,0 @@ -bayesian_listener -================= - -.. automodule:: bayesian_listener - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/modules/metrics.rst b/docs/modules/metrics.rst new file mode 100644 index 0000000..b19d0f7 --- /dev/null +++ b/docs/modules/metrics.rst @@ -0,0 +1,8 @@ +bayesian_listener.metrics +========================= + +.. automodule:: bayesian_listener.metrics + :members: + :undoc-members: + :show-inheritance: + :exclude-members: diff --git a/docs/modules/resample.rst b/docs/modules/resample.rst new file mode 100644 index 0000000..64fd9b5 --- /dev/null +++ b/docs/modules/resample.rst @@ -0,0 +1,8 @@ +bayesian_listener.resample +========================== + +.. automodule:: bayesian_listener.resample + :members: + :undoc-members: + :show-inheritance: + :exclude-members: \ No newline at end of file diff --git a/docs/modules/utils.rst b/docs/modules/utils.rst new file mode 100644 index 0000000..94cb2ec --- /dev/null +++ b/docs/modules/utils.rst @@ -0,0 +1,8 @@ +bayesian_listener.utils +========================= + +.. automodule:: bayesian_listener.utils + :members: + :undoc-members: + :show-inheritance: + :exclude-members: \ No newline at end of file From ed07900f90c20202339506d94426d25417d143b5 Mon Sep 17 00:00:00 2001 From: Anton Hoyer <156099087+hoyer-a@users.noreply.github.com> Date: Tue, 20 Jan 2026 11:59:08 +0100 Subject: [PATCH 4/4] Update bayesian_listener/bayesian_listener.py --- bayesian_listener/bayesian_listener.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bayesian_listener/bayesian_listener.py b/bayesian_listener/bayesian_listener.py index c531df7..602ee1b 100644 --- a/bayesian_listener/bayesian_listener.py +++ b/bayesian_listener/bayesian_listener.py @@ -1,5 +1,5 @@ """ -The following describes the BayesianListner, which is the core auditory model. +The following describes the BayesianListener, which is the core auditory model. """ import sofar import numpy as np