Skip to content

Commit

Permalink
Doc: add doc about new way to build parallel version
Browse files Browse the repository at this point in the history
  • Loading branch information
MuellerSeb committed Apr 6, 2021
1 parent 6d4bcbc commit b9b8e71
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,24 +61,24 @@ To get the latest development version you can install it directly from GitHub:
If something went wrong during installation, try the :code:`-I` `flag from pip <https://pip-python3.readthedocs.io/en/latest/reference/pip_install.html?highlight=i#cmdoption-i>`_.

To enable the OpenMP support, you have to provide a C compiler, Cython and OpenMP.
To get all other dependencies, it is recommended to first install gstools once
in the standard way just decribed.
Simply use the following commands:
To enable the OpenMP support, you have to provide a C compiler and OpenMP.
Parallel support is controlled by an environment variable ``GSTOOLS_BUILD_PARALLEL``,
that can be ``0`` or ``1`` (interpreted as ``0`` if not present).
GSTools then needs to be installed from source:

.. code-block:: none
pip install gstools
pip install -I --no-deps --global-option="--openmp" gstools
export GSTOOLS_BUILD_PARALLEL=1
pip install --no-binary=gstools gstools
Note, that the ``--no-binary=gstools`` option forces pip to not use a wheel for GSTools.

Or for the development version:
For the development version, you can do almost the same:

.. code-block:: none
export GSTOOLS_BUILD_PARALLEL=1
pip install git+git://github.com/GeoStat-Framework/GSTools.git@develop
pip install -I --no-deps --global-option="--openmp" git+git://github.com/GeoStat-Framework/GSTools.git@develop
The flags :code:`-I --no-deps` force pip to reinstall gstools but not the dependencies.
Citation
Expand Down

0 comments on commit b9b8e71

Please sign in to comment.