diff options
Diffstat (limited to 'src/cython/doc/installation.rst')
| -rw-r--r-- | src/cython/doc/installation.rst | 23 |
1 files changed, 14 insertions, 9 deletions
diff --git a/src/cython/doc/installation.rst b/src/cython/doc/installation.rst index e7d8c210..f98a5039 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 the 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,20 +30,18 @@ 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 =========== -To test your build, `py.test <http://doc.pytest.org>`_ is required. Run the +To test your build, `py.test <http://doc.pytest.org>`_ is optional. Run the 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' - py.test + export PYTHONPATH='$PYTHONPATH:/path-to-gudhi/build/cython' + ctest -R py_test Documentation ============= |