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`)::
diff --git a/bayesian_listener/__init__.py b/bayesian_listener/__init__.py
index 40fe35f..fd987da 100644
--- a/bayesian_listener/__init__.py
+++ b/bayesian_listener/__init__.py
@@ -5,6 +5,9 @@
__author__ = """Roberto Barumerli, Fabian Brinkmann, Emanuele Zanoni, Anton Hoyer"""
__email__ = 'r.barumerli@imperial.ac.uk'
__version__ = '0.1'
+__all__ = [
+ 'BayesianListener'
+ ]
from .bayesian_listener import BayesianListener
@@ -12,6 +15,4 @@
from . import resample
from . import utils
-__all__ = [
- 'BayesianListener'
- ]
\ No newline at end of file
+
diff --git a/bayesian_listener/bayesian_listener.py b/bayesian_listener/bayesian_listener.py
index c577abd..0d21aab 100644
--- a/bayesian_listener/bayesian_listener.py
+++ b/bayesian_listener/bayesian_listener.py
@@ -1,3 +1,6 @@
+"""
+The following describes the BayesianListener, 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 273ca8f..77676d5 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 905be8e..8cca8e0 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 b8e63bc..5cc9a02 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