Merge remote-tracking branch 'origin/master' into tomato2

4 files changed, 77 insertions, 8 deletions

diff --git a/src/python/CMakeLists.txt b/src/python/CMakeLists.txt
index f5e1b12b..04f64ce3 100644
--- a/src/python/CMakeLists.txt
+++ b/src/python/CMakeLists.txt
@@ -242,6 +242,9 @@ if(PYTHONINTERP_FOUND)
     file(COPY "gudhi/dtm_rips_complex.py" DESTINATION "${CMAKE_CURRENT_BINARY_DIR}/gudhi")
     file(COPY "gudhi/hera/__init__.py" DESTINATION "${CMAKE_CURRENT_BINARY_DIR}/gudhi/hera")
 
+    # Some files for pip package
+    file(COPY "introduction.rst" DESTINATION "${CMAKE_CURRENT_BINARY_DIR}/")
+
     add_custom_command(
         OUTPUT gudhi.so
         WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
diff --git a/src/python/doc/installation.rst b/src/python/doc/installation.rst
index a66e910e..525ca84e 100644
--- a/src/python/doc/installation.rst
+++ b/src/python/doc/installation.rst
@@ -5,20 +5,47 @@
 Installation
 ############
 
-Conda
-*****
-The easiest way to install the Python version of GUDHI is using
-`conda <https://gudhi.inria.fr/conda/>`_.
+Packages
+********
+The easiest way to install the Python version of GUDHI is using pre-built packages.
+We recommend `conda <https://gudhi.inria.fr/conda/>`_
+
+.. code-block:: bash
+
+    conda install -c conda-forge gudhi
+
+Gudhi is also available on `PyPI <https://pypi.org/project/gudhi/>`_
+
+.. code-block:: bash
+
+    pip install gudhi
+
+Third party packages are also available, for instance on Debian or Ubuntu
+
+.. code-block:: bash
+
+    apt install python3-gudhi
+
+In all cases, you may still want to install some of the optional `run time dependencies`_.
 
 Compiling
 *********
+These instructions are for people who want to compile gudhi from source, they are
+unnecessary if you installed a binary package of Gudhi as above. They assume that
+you have downloaded a `release <https://github.com/GUDHI/gudhi-devel/releases>`_,
+with a name like `gudhi.3.2.0.tar.gz`, then run `tar xf gudhi.3.2.0.tar.gz`, which
+created a directory `gudhi.3.2.0`, hereinafter referred to as `/path-to-gudhi/`.
+If you are instead using a git checkout, beware that the paths are a bit
+different, and in particular the `python/` subdirectory is actually `src/python/`
+there.
+
 The library uses c++14 and requires `Boost <https://www.boost.org/>`_ :math:`\geq` 1.56.0,
 `CMake <https://www.cmake.org/>`_ :math:`\geq` 3.1  to generate makefiles,
 `NumPy <http://numpy.org>`_, `Cython <https://www.cython.org/>`_ and
 `pybind11 <https://github.com/pybind/pybind11>`_ to compile
 the GUDHI Python module.
 It is a multi-platform library and compiles on Linux, Mac OSX and Visual
-Studio 2017.
+Studio 2017 or later.
 
 On `Windows <https://wiki.python.org/moin/WindowsCompilers>`_ , only Python
 :math:`\geq` 3.5 are available because of the required Visual Studio version.
diff --git a/src/python/introduction.rst b/src/python/introduction.rst
new file mode 100644
index 00000000..11c06ac5
--- /dev/null
+++ b/src/python/introduction.rst
@@ -0,0 +1,24 @@
+The Gudhi library is an open source library for Computational Topology and
+Topological Data Analysis (TDA). It offers state-of-the-art algorithms
+to construct various types of simplicial complexes, data structures to
+represent them, and algorithms to compute geometric approximations of shapes
+and persistent homology.
+
+The GUDHI library offers the following interoperable modules:
+
+* Complexes:
+   * Cubical
+   * Simplicial: Rips, Witness, Alpha and Čech complexes
+   * Cover: Nerve and Graph induced complexes
+* Data structures and basic operations:
+   * Simplex tree, Skeleton blockers and Toplex map
+   * Construction, update, filtration and simplification
+* Topological descriptors computation
+* Manifold reconstruction
+* Topological descriptors tools:
+   * Bottleneck distance
+   * Statistical tools
+   * Persistence diagram and barcode
+
+For more information about Topological Data Analysis and its workflow, please
+refer to the `Wikipedia TDA dedicated page <https://en.wikipedia.org/wiki/Topological_data_analysis>`_.
diff --git a/src/python/setup.py.in b/src/python/setup.py.in
index 9b3c7521..98d058fc 100644
--- a/src/python/setup.py.in
+++ b/src/python/setup.py.in
@@ -64,14 +64,29 @@ for module in pybind11_modules:
         runtime_library_dirs=runtime_library_dirs,
         ))
 
+# read the contents of introduction.rst
+with open("introduction.rst", "r") as fh:
+    long_description = fh.read()
+
 setup(
     name = 'gudhi',
     packages=find_packages(), # find_namespace_packages(include=["gudhi*"])
     author='GUDHI Editorial Board',
     author_email='gudhi-contact@lists.gforge.inria.fr',
     version='@GUDHI_VERSION@',
-    url='http://gudhi.gforge.inria.fr/',
+    url='https://gudhi.inria.fr/',
+    project_urls={
+        'Bug Tracker': 'https://github.com/GUDHI/gudhi-devel/issues',
+        'Documentation': 'https://gudhi.inria.fr/python/latest/',
+        'Source Code': 'https://github.com/GUDHI/gudhi-devel',
+        'License': 'https://gudhi.inria.fr/licensing/'
+        },
+    description='The Gudhi library is an open source library for ' \
+        'Computational Topology and Topological Data Analysis (TDA).',
+    long_description_content_type='text/x-rst',
+    long_description=long_description,
     ext_modules = ext_modules,
-    install_requires = ['cython','numpy >= 1.9',],
-    setup_requires = ['numpy >= 1.9','pybind11',],
+    install_requires = ['numpy >= 1.9',],
+    setup_requires = ['cython','numpy >= 1.9','pybind11',],
+    package_data={"": ["*.dll"], },
 )