summaryrefslogtreecommitdiff
path: root/src/cython/doc/installation.rst
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-04-10 14:00:40 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-04-10 14:00:40 +0000
commit9661f87b543eb53d0473ceb147e95a7d61bd1763 (patch)
treeae88e18468240cbf71a90567dbbadb5f8ce67e2e /src/cython/doc/installation.rst
parentdd108b5a6c620b10675b7ebaf8d1561c2c165bf2 (diff)
parent2334cb2704e84792f3972ba7d3b45a7b9ee75f67 (diff)
Merge code reviews fix
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@2325 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 1a35ff8f60aee0bd150db7b571b13a50e843851a
Diffstat (limited to 'src/cython/doc/installation.rst')
-rw-r--r--src/cython/doc/installation.rst19
1 files changed, 12 insertions, 7 deletions
diff --git a/src/cython/doc/installation.rst b/src/cython/doc/installation.rst
index e7d8c210..f818366b 100644
--- a/src/cython/doc/installation.rst
+++ b/src/cython/doc/installation.rst
@@ -4,12 +4,19 @@ Installation
Compiling
*********
-The library uses c++11 and requires `Boost <http://www.boost.org/>`_ with version
-1.48.0 or more recent. It is a multi-platform library and compiles on Linux,
-Mac OSX and Visual Studio 2015.
+The library uses c++11 and requires `Boost <http://www.boost.org/>`_ with
+version 1.48.0 or more recent. It is a multi-platform library and compiles on
+Linux, Mac OSX and Visual Studio 2015.
It also requires cmake to generate makefiles, and cython to compile the
library.
+On `Windows <https://wiki.python.org/moin/WindowsCompilers>`_ , only Python
+3.5 and 3.6 are available because of required Visual Studio version.
+
+On other systems, if you have several Python/cython installed, the version 2.X
+will be used by default, but you can force it by adding
+:code:`-DPython_ADDITIONAL_VERSIONS=3` to the cmake command.
+
GUDHI Cythonization
===================
@@ -23,8 +30,6 @@ To build the GUDHI cython module, run the following commands in a terminal:
cmake ..
make cython
-A list of examples is available here.
-
Test suites
===========
@@ -33,9 +38,9 @@ following command in a terminal:
.. code-block:: bash
- cd /path-to-gudhi/build/src/cython
+ cd /path-to-gudhi/build/cython
# For windows, you have to set PYTHONPATH environment variable
- export PYTHONPATH='$PYTHONPATH:/path-to-gudhi/build/src/cython'
+ export PYTHONPATH='$PYTHONPATH:/path-to-gudhi/build/cython'
py.test
Documentation