Madmom

https://madmom.readthedocs.io/en/latest/
Admin
Madmom is an audio signal processing library primarily used for music information retrieval (MIR)...
Tokens:1,749
Snippets:37
Trust Score:9.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install in development mode

Source: https://madmom.readthedocs.io/en/latest/installation.html

Installs the package in development mode for the current user.

```bash
python setup.py develop --user
```

--------------------------------

### Install madmom via pip

Source: https://madmom.readthedocs.io/en/latest/installation.html

Installs the latest version of madmom and its dependencies from PyPI.

```bash
pip install madmom
```

--------------------------------

### Install madmom locally via pip

Source: https://madmom.readthedocs.io/en/latest/installation.html

Installs the package for the current user only, avoiding the need for global administrative privileges.

```bash
pip install --user madmom
```

--------------------------------

### Upgrade package via pip

Source: https://madmom.readthedocs.io/en/latest/installation.html

Upgrades an existing installation of madmom.

```bash
pip install --upgrade madmom [--user]
```

--------------------------------

### Import madmom library

Source: https://madmom.readthedocs.io/en/latest/usage.html

Basic imports required to start using the library in Python scripts.

```python
import madmom
import numpy as np
```

--------------------------------

### Build documentation locally with Sphinx

Source: https://madmom.readthedocs.io/en/latest/development.html

Commands to navigate to the documentation directory and generate the HTML output.

```bash
cd docs
make html
```

--------------------------------

### Access help messages for executable programs

Source: https://madmom.readthedocs.io/en/latest/usage.html

Displays help documentation for the program and its specific operational modes.

```bash
DBNBeatTracker -h

DBNBeatTracker single -h

DBNBeatTracker batch -h

DBNBeatTracker online -h

DBNBeatTracker pickle -h
```

--------------------------------

### Clone and initialize submodules manually

Source: https://madmom.readthedocs.io/en/latest/installation.html

Alternative method to clone the repository and initialize submodules if not using the recursive flag.

```bash
git clone  https://github.com/CPJKU/madmom.git
cd madmom
git submodule update --init --remote
```

--------------------------------

### Run DBNBeatTracker in online mode

Source: https://madmom.readthedocs.io/en/latest/usage.html

Operates on live audio signals; requires the pyaudio library.

```bash
DBNBeatTracker online [-o OUTFILE] [INFILE]
```

--------------------------------

### Run DBNBeatTracker in batch mode

Source: https://madmom.readthedocs.io/en/latest/usage.html

Processes multiple audio files and saves outputs to a directory with a specific suffix.

```bash
DBNBeatTracker batch [-o OUTPUT_DIR] [-s OUTPUT_SUFFIX] FILES
```

--------------------------------

### Run DBNBeatTracker in single file mode

Source: https://madmom.readthedocs.io/en/latest/usage.html

Processes a single audio file and outputs results to STDOUT or a specified file.

```bash
DBNBeatTracker single [-o OUTFILE] INFILE
```

--------------------------------

### Run tests

Source: https://madmom.readthedocs.io/en/latest/installation.html

Executes the included test suite using pytest.

```bash
python setup.py pytest
```

--------------------------------

### Reinstall package via pip

Source: https://madmom.readthedocs.io/en/latest/installation.html

Uninstalls and then reinstalls the package to ensure a clean update.

```bash
pip uninstall madmom
pip install madmom [--user]
```

--------------------------------

### Clone madmom repository

Source: https://madmom.readthedocs.io/en/latest/installation.html

Clones the repository including submodules required for pre-trained models.

```bash
git clone --recursive https://github.com/CPJKU/madmom.git
```

--------------------------------

### Add scripts to PATH

Source: https://madmom.readthedocs.io/en/latest/installation.html

Updates the system PATH to include the directory where local pip-installed scripts are located.

```bash
export PATH='path/to/scripts':$PATH
```

--------------------------------

### Pull latest source

Source: https://madmom.readthedocs.io/en/latest/installation.html

Updates the local repository with the latest changes from the remote.

```bash
git pull
```

--------------------------------

### Recompile Cython modules

Source: https://madmom.readthedocs.io/en/latest/installation.html

Recompiles Cython modules in-place if source files have changed.

```bash
python setup.py build_ext --inplace
```

--------------------------------

### Update submodules

Source: https://madmom.readthedocs.io/en/latest/installation.html

Updates the models contained in the submodule.

```bash
git submodule update
```

--------------------------------

### Cite madmom in BibTeX

Source: https://madmom.readthedocs.io/en/latest/citation.html

Use this BibTeX entry to cite the madmom library in academic publications.

```bibtex
@inproceedings{madmom,
   Title = {{madmom: a new Python Audio and Music Signal Processing Library}},
   Author = {B{"o}ck, Sebastian and Korzeniowski, Filip and Schl{"u}ter, Jan and Krebs, Florian and Widmer, Gerhard},
   Booktitle = {Proceedings of the 24th ACM International Conference on
   Multimedia},
   Month = {10},
   Year = {2016},
   Pages = {1174--1178},
   Address = {Amsterdam, The Netherlands},
   Doi = {10.1145/2964284.2973795}
}
```
Tokens:
Raw