Skip to content

Commit

Permalink
Replace PySoundFile with SoundFile
Browse files Browse the repository at this point in the history
  • Loading branch information
auroracramer committed Nov 16, 2021
1 parent 8a0bfc5 commit 34d0a14
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 9 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@ Dependencies
Currently, we support Python 3.6, 3.7, and 3.8.

#### libsndfile (Linux only)
BirdVoxClassify depends on the PySoundFile module to load audio files, which itself depends on the non-Python library libsndfile.
BirdVoxClassify depends on the SoundFile module to load audio files, which itself depends on the non-Python library libsndfile.
On Windows and Mac OS X, these will be installed automatically via the ``pip`` package manager and you can therefore skip this step.
However, on Linux, `libsndfile` must be installed manually via your platform's package manager.
For Debian-based distributions (such as Ubuntu), this can be done by simply running

apt-get install libsndfile

For more detailed information, please consult the
[installation instructions of pysoundfile](https://pysoundfile.readthedocs.io/en/0.9.0/#installation>).
[installation instructions of soundfile](https://pysoundfile.readthedocs.io/en/latest/#installation>).

#### Note about TensorFlow:
We have dropped support for Tensorflow 1.x, and have moved to Tensorflow 2.x.
Expand Down
9 changes: 3 additions & 6 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ Installation instructions

Dependencies
------------
Python Versions
^^^^^^^^^^^^^^^
Currently, we support Python 3.6 and Python 3.7. Python 3.8 is not currently supported since TensorFlow 1.x is not supported for Python 3.8.

Python Versions
^^^^^^^^^^^^^^^
Expand All @@ -14,7 +11,7 @@ Currently, we support Python 3.6, 3.7, and 3.8.
libsndfile (Linux only)
^^^^^^^^^^^^^^^^^^^^^^^

BirdVoxClassify depends on the PySoundFile module to load audio files,
BirdVoxClassify depends on the SoundFile module to load audio files,
which itself depends on the non-Python library libsndfile. On Windows
and Mac OS X, these will be installed automatically via the ``pip``
package manager and you can therefore skip this step. However, on Linux,
Expand All @@ -27,7 +24,7 @@ done by simply running
apt-get install libsndfile

For more detailed information, please consult the `installation
instructions of pysoundfile`_.
instructions of soundfile`_.


Note about TensorFlow:
Expand Down Expand Up @@ -62,5 +59,5 @@ To install the latest version of BirdVoxClassify from source:
cd birdvoxclassify
pip install -e .

.. _installation instructions of pysoundfile: https://pysoundfile.readthedocs.io/en/0.9.0/#installation%3E
.. _installation instructions of soundfile: https://pysoundfile.readthedocs.io/en/latest/#installation
.. _BirdVoxDetect: https://github.com/BirdVox/birdvoxdetect
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@
'librosa>=0.6.2',
'numpy>=1.13.0',
'scipy>=1.0.0',
'PySoundFile>=0.9.0',
'SoundFile>=0.9.0',
'resampy>=0.2.0',
'h5py>=2.7.0',
'pandas>=0.23',
Expand Down

0 comments on commit 34d0a14

Please sign in to comment.