Changeset 6d4802f for doc/python_module.rst

Timestamp:

Oct 31, 2018, 5:12:21 PM (5 years ago)

Author:

Paul Brossier <piem@piem.org>

Branches:

feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master

Children:

dc3f68d

Parents:

a4a00a5

Message:

[doc] add a note about building the module in double precision

File:

• doc/python_module.rst (modified) (1 diff)

doc/python_module.rst

@@ -26 +26 @@
     $ sudo ./setup.py install
 
+
+.. _py-doubleprecision:
+
+Double precision
+----------------
+
+This module can be compiled in double-precision mode, in which case the
+default type for floating-point samples will be 64-bit. The default is
+single precision mode (32-bit, recommended).
+
+To build the aubio module with double precision, use the option
+`--enable-double` of the `build_ext` subcommand:
+
+.. code:: bash
+
+    $ ./setup.py clean
+    $ ./setup.py build_ext --enable-double
+    $ pip install -v .
+
+**Note**: If linking against `libaubio`, make sure the library was also
+compiled in :ref:`doubleprecision` mode.
+
+
 Checking your installation
 --------------------------