Skip to content
This repository has been archived by the owner on May 26, 2023. It is now read-only.

Commit

Permalink
remove pyfftw as requirement because it is not mandatory and update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Sebastian Böck committed Nov 23, 2018
1 parent 9e761b8 commit ccd80c0
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 11 deletions.
15 changes: 9 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,16 +60,19 @@ Prerequisites
-------------

To install the ``madmom`` package, you must have either Python 2.7 or Python
3.3 or newer and the following packages installed:
3.5 or newer and the following packages installed:

- `numpy <http://www.numpy.org>`_
- `scipy <http://www.scipy.org>`_
- `cython <http://www.cython.org>`_
- `mido <https://github.com/olemb/mido>`_ (for MIDI handling)
- `pytest <https://www.pytest.org/>`_ (to run the tests)
- `pyaudio <http://people.csail.mit.edu/hubert/pyaudio/>`_ (to process live
audio input)
- `pyfftw <https://github.com/pyFFTW/pyFFTW/>`_ (for better FFT performance)
- `mido <https://github.com/olemb/mido>`_

In order to test your installation, process live audio input, or have improved
FFT performance, additionally install these packages:

- `pytest <https://www.pytest.org/>`_
- `pyaudio <http://people.csail.mit.edu/hubert/pyaudio/>`_
- `pyfftw <https://github.com/pyFFTW/pyFFTW/>`_

If you need support for audio files other than ``.wav`` with a sample rate of
44.1kHz and 16 bit depth, you need ``ffmpeg`` (``avconv`` on Ubuntu Linux has
Expand Down
15 changes: 11 additions & 4 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,20 @@ Prerequisites
To install the ``madmom`` package, you must have either Python 2.7 or Python
3.3 or newer and the following packages installed:

To install the ``madmom`` package, you must have either Python 2.7 or Python
3.5 or newer and the following packages installed:

- `numpy <http://www.numpy.org>`_
- `scipy <http://www.scipy.org>`_
- `cython <http://www.cython.org>`_
- `mido <https://github.com/olemb/mido>`_ (for MIDI handling)
- `pytest <https://www.pytest.org/>`_ (to run the tests)
- `pyaudio <http://people.csail.mit.edu/hubert/pyaudio/>`_ (to process live
audio input)
- `mido <https://github.com/olemb/mido>`_

In order to test your installation, process live audio input, or have improved
FFT performance, additionally install these packages:

- `pytest <https://www.pytest.org/>`_
- `pyaudio <http://people.csail.mit.edu/hubert/pyaudio/>`_
- `pyfftw <https://github.com/pyFFTW/pyFFTW/>`_

If you need support for audio files other than ``.wav`` with a sample rate of
44.1kHz and 16 bit depth, you need ``ffmpeg`` (``avconv`` on Ubuntu Linux has
Expand Down
1 change: 0 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,3 @@ numpy>=1.13.4
scipy>=0.16
cython>=0.25
mido>=1.2.8
pyfftw>=0.10.4

0 comments on commit ccd80c0

Please sign in to comment.