THE AUDITORY MODELING TOOLBOX

General

The AMT development and website sources, the mailing list, and releases are all hosted at Sourceforge.

You can get the latest source codes by accessing the Git repository on Sourceforge. Access is possible by the web interface or by using an Git client to access the repository at:

git://git.code.sf.net/p/amtoolbox/code amtoolbox

AMT developers

In order to contribute to the AMT, you will need a Sourceforge account and be subscribed as project developer. To become a project developer, contact us and provide your Sourceforge user name. The first steps as an AMT developer:

• Create a branch named by your last name and the year of your contribution, e.g., smith2021 for Ms. Smith contributing in 2021. The corresponding Git command would be git branch smith2021 in that example.
• Switch to that branch, e.g., git checkout smith2021
• Write the code and add all your files to the repository, e.g., git add your_files.
• Commit your changes to your local Git repository and describe the changes.

Further, we ask you to follow the guidelines described in Majdak et al., (2022). Note that by using your own branch, no harm can be done to the main AMT code at all.

Documentation

An important part of the AMT is its documentation. The content is embedded in the Matlab/Octave files. From that, we use mat2doc to automatically generate the final documentation for the releases and the web. Our mat2doc is a fork of the mat2doc project: We use an improved version which is directly integrated in the AMT (see the mat2doc directory of the AMT).

Generally, the syntax of mat2doc relies on reStructuredText but it also includes some additional features. The formatting and layout is roughly described in the mat2doc documentation. The general parts of the documentation can be edited and checked online.