Skip to content

Commit

Permalink
Update documentation to reflect requirements changes
Browse files Browse the repository at this point in the history
  • Loading branch information
dexter2206 committed Jan 21, 2019
1 parent 2257705 commit 49ba3f4
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions doc/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Installing binary wheel from PyPI

If you are running a Linux system and are only interested in non GPU-enabled build, you can install
binary wheel from PyPI as usual::

pip install ising

Unfortunately, we cannot provide GPU-enabled binary wheel due to a manylinux_ PEP-513 policy, as it is impossible to build **ising** on CentOS 5.
Expand All @@ -25,11 +25,12 @@ To build **ising** you need the following:

- Virtually any C and C++ compiler,
- A Fortran compiler. The build script supports PGI, Intel, and gfortran compilers.
- The thrust_ library. This is installed by default alongside with CUDA toolkit, otherwise you need to make sure that thrust's include files are visible by your C++ compiler.
- Working CUDA toolkit. For CPU based implementation only its thrust_ library with ``OMP_DEVICE_BACKEND`` is used, but ``nvcc`` is still required for compiling sources. You can get around this requirement and use your local installation of ``thrust`` if you use GNU fortran compiler.
- ``numpy`` Python package installed in the same environment as is used to run the build process.
- Python development headers.

.. _thrust: https://thrust.github.io/
In addition, to build a GPU-enabled version you need PGI CUDA Fortran and compatible CUDA toolkit. Our package was tested against CUDA 9.2 and CUDA 10.0.
In addition, to build a GPU-enabled version you need PGI CUDA Fortran. Our package was tested against CUDA 9.2 and CUDA 10.0.

Building and installing
+++++++++++++++++++++++
Expand All @@ -40,6 +41,4 @@ To build the **ising** package download its source code and run ``install.py`` s

where ``<fortran_compiler>`` is one of ``pgi``, ``intel``, ``gfortran``. The ``--usecuda`` switch can be used to enable GPU support. Note that ``--usecuda`` requires ``--fcompiler=pgi``.

The script should take care of building extensions and installing package, so after running the above command **ising** package should be ready to use.


The script should take care of building extensions and installing package, so after running the above command **ising** package should be ready to use.

0 comments on commit 49ba3f4

Please sign in to comment.