History

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

Paul Brossier committed 8 years ago

Commit 6d4802f1 parent a4a00a54 files · +30 −4Browse files

Showing the changes to doc/python_module.rst (1 of 4 files). Show all

Unified · Split

doc/python_module.rst+23−0
@@ -25,6 +25,29 @@ From ``aubio`` source directory, run the following: · 24 unmodified lines
2525 $ ./setup.py build
2626 $ sudo ./setup.py install
2727
28+
29+.. _py-doubleprecision:
30+
31+Double precision
32+----------------
33+
34+This module can be compiled in double-precision mode, in which case the
35+default type for floating-point samples will be 64-bit. The default is
36+single precision mode (32-bit, recommended).
37+
38+To build the aubio module with double precision, use the option
39+`--enable-double` of the `build_ext` subcommand:
40+
41+.. code:: bash
42+
43+ $ ./setup.py clean
44+ $ ./setup.py build_ext --enable-double
45+ $ pip install -v .
46+
47+**Note**: If linking against `libaubio`, make sure the library was also
48+compiled in :ref:`doubleprecision` mode.
49+
50+
2851 Checking your installation
2952 --------------------------
3053

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t