If you want to contribute to
pyroomacoustics and make it better,
your help is very welcome. Contributing is also a great way to learn
more about the package itself.
Ways to contribute¶
- File bug reports
- Improvements to the documentation are always more than welcome. Keeping a good clean documentation is a challenging task and any help is appreciated.
- Feature requests
- If you implemented an extra DOA/adaptive filter/beamforming algorithm: that’s awesome! We’d love to add it to the package.
- Suggestion of improvements to the code base are also welcome.
We try to stick to PEP8 as much as possible. Variables, functions, modules and packages should be in lowercase with underscores. Class names in CamelCase.
Docstrings should follow the numpydoc style.
We recommend the following steps for generating the documentation:
- Create a separate environment, e.g. with Anaconda, as such:
conda create -n mkdocs37 python=3.7 sphinx numpydoc mock sphinx_rtd_theme
- Switch to the environment:
source activate mkdocs37
- Navigate to the
docsfolder and run:
- The materials database page is generated with the script
- Build and view the documentation locally with:
- Open in your browser:
It can be convenient to develop and run tests locally. In contrast to only using the package, you will then also need to compile the C++ extension for that. On Mac and Linux, GCC is required, while Visual C++ 14.0 is necessary for windows.
Get the source code. Use recursive close so that Eigen (a sub-module of this repository) is also downloaded.
git clone --recursive email@example.com:LCAV/pyroomacoustics.git
Alternatively, you can clone without the –recursive flag and directly install the Eigen library. For macOS, you can find installation instruction here: https://stackoverflow.com/a/35658421. After installation you can create a symbolic link as such:
ln -s PATH_TO_EIGEN pyroomacoustics/libroom_src/ext/eigen/Eigen
Install a few pre-requisites
pip install numpy Cython pybind11
python setup.py build_ext --inplace
On recent Mac OS (Mojave), it is necessary in some cases to add a higher deployment target
MACOSX_DEPLOYMENT_TARGET=10.9 python setup.py build_ext --inplace
$PYTHONPATHso that python knows where to find the local package
# Linux/Mac export PYTHONPATH=<path_to_pyroomacoustics>:$PYTHONPATH
For windows, see this question on stackoverflow.
Install the dependencies listed in
pip install -r requirements.txt
Now fire up
ipythonand check that the package can be imported
import pyroomacoustics as pra
As much as possible, for every new function added to the code base, add
a short test script in
pyroomacoustics/tests. The names of the
script and the functions running the test should be prefixed by
test_. The tests are started by running
nosetests at the root of
How to make a clean pull request¶
Look for a project’s contribution instructions. If there are any, follow them.
- Create a personal fork of the project on Github.
- Clone the fork on your local machine. Your remote repo on Github is
- Add the original repository as a remote called
- If you created your fork a while ago be sure to pull upstream changes into your local repository.
- Create a new branch to work on! Branch from
developif it exists, else from
- Implement/fix your feature, comment your code.
- Follow the code style of the project, including indentation.
- If the project has tests run them!
- Write or adapt tests as needed.
- Add or change the documentation as needed.
- Squash your commits into a single commit with git’s interactive rebase. Create a new branch if necessary.
- Push your branch to your fork on Github, the remote
- From your fork open a pull request in the correct branch. Target the
developbranch if there is one, else go for
- If the maintainer requests further changes just push them to your branch. The PR will be updated automatically.
- Once the pull request is approved and merged you can pull the changes
upstreamto your local repo and delete your extra branch(es).
And last but not least: Always write your commit messages in the present tense. Your commit message should describe what the commit, when applied, does to the code – not what you did to the code.