install.rst 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. ============
  2. Installation
  3. ============
  4. Prerequisites
  5. -------------
  6. To use QCGPU you will need to be using `Python 2.7 or later <https://www.python.org/downloads/>`_.
  7. You will also need to ensure that you have an `OpenCL <https://www.khronos.org/opencl/>`_ implementation installed.
  8. This is done by default on MacOS, but you shuld check that ``clinfo`` or some other diagnostic command will run.
  9. You can also use `Anaconda 3 <https://www.continuum.io/downloads>`_, which will have many of the required dependencies already installed.
  10. Installing from PyPI
  11. --------------------
  12. This library is distributed on `PyPI <https://pypi.python.org/pypi/qcgpu>`_ and can be installed using pip:
  13. .. code:: sh
  14. $ pip install qcgpu
  15. If you run into any issues, you should try installing from source.
  16. Installing from Source
  17. ----------------------
  18. You can install QCGPU from the source. First, clone the repository off
  19. GitHub:
  20. .. code:: sh
  21. $ git clone https://github.com/qcgpu/qcgpu
  22. Then you will need to ``cd`` into the directory, and install the
  23. requirements.
  24. .. code:: sh
  25. $ pip install -r requirements.txt
  26. And finally you can install:
  27. .. code:: sh
  28. $ python setup.py install