install.html 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  1. <!DOCTYPE html>
  2. <html >
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <title>Installation</title>
  7. <link rel="stylesheet" href="_static/pygments.css">
  8. <link rel="stylesheet" href="_static/theme.css">
  9. <script src="_static/theme-vendors.js"></script>
  10. <script src="_static/theme.js" defer></script>
  11. <link rel="index" title="Index" href="genindex.html" />
  12. <link rel="search" title="Search" href="search.html" />
  13. <link rel="next" title="Getting Started" href="quickstart.html" />
  14. <link rel="prev" title="QCGPU" href="index.html" />
  15. </head>
  16. <body><div id="app" class="theme-container" :class="pageClasses"><navbar @toggle-sidebar="toggleSidebar">
  17. <router-link to="index.html" class="home-link">
  18. <span class="site-name">QCGPU</span>
  19. </router-link>
  20. <div class="links">
  21. <navlinks class="can-hide">
  22. <div class="nav-item">
  23. <a href="#"
  24. class="nav-link router-link-active">
  25. None
  26. </a>
  27. </div>
  28. </navlinks>
  29. </div>
  30. </navbar>
  31. <div class="sidebar-mask" @click="toggleSidebar(false)">
  32. </div>
  33. <sidebar @toggle-sidebar="toggleSidebar">
  34. <navlinks>
  35. <div class="nav-item">
  36. <a href="#"
  37. class="nav-link router-link-active">
  38. None
  39. </a>
  40. </div>
  41. </navlinks><div class="sidebar-links" role="navigation" aria-label="main navigation">
  42. <div class="sidebar-group">
  43. <ul class="current">
  44. <li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul>
  45. <li class="toctree-l2"><a class="reference internal" href="#prerequisites">Prerequisites</a></li>
  46. <li class="toctree-l2"><a class="reference internal" href="#installing-from-pypi">Installing from PyPI</a></li>
  47. <li class="toctree-l2"><a class="reference internal" href="#installing-from-source">Installing from Source</a></li>
  48. </ul>
  49. </li>
  50. <li class="toctree-l1"><a class="reference internal" href="quickstart.html">Getting started</a></li>
  51. </ul>
  52. </div>
  53. </div>
  54. </sidebar>
  55. <page>
  56. <div class="content">
  57. <div class="section" id="installation">
  58. <h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
  59. <div class="section" id="prerequisites">
  60. <h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline">¶</a></h2>
  61. <p>To use QCGPU you will need to be using <a class="reference external" href="https://www.python.org/downloads/">Python 2.7 or later</a>.
  62. You will also need to ensure that you have an <a class="reference external" href="https://www.khronos.org/opencl/">OpenCL</a> implementation installed.
  63. This is done by default on MacOS, but you shuld check that <code class="docutils literal notranslate"><span class="pre">clinfo</span></code> or some other diagnostic command will run.</p>
  64. <p>You can also use <a class="reference external" href="https://www.continuum.io/downloads">Anaconda 3</a>, which will have many of the required dependencies already installed.</p>
  65. </div>
  66. <div class="section" id="installing-from-pypi">
  67. <h2>Installing from PyPI<a class="headerlink" href="#installing-from-pypi" title="Permalink to this headline">¶</a></h2>
  68. <p>This library is distributed on <a class="reference external" href="https://pypi.python.org/pypi/qcgpu">PyPI</a> and can be installed using pip:</p>
  69. <div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span>$ pip install qcgpu
  70. </pre></div>
  71. </div>
  72. <p>If you run into any issues, you should try installing from source.</p>
  73. </div>
  74. <div class="section" id="installing-from-source">
  75. <h2>Installing from Source<a class="headerlink" href="#installing-from-source" title="Permalink to this headline">¶</a></h2>
  76. <p>You can install QCGPU from the source. First, clone the repository off
  77. GitHub:</p>
  78. <div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span>$ git clone https://github.com/qcgpu/qcgpu
  79. </pre></div>
  80. </div>
  81. <p>Then you will need to <code class="docutils literal notranslate"><span class="pre">cd</span></code> into the directory, and install the
  82. requirements.</p>
  83. <div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span>$ pip install -r requirements.txt
  84. </pre></div>
  85. </div>
  86. <p>And finally you can install:</p>
  87. <div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span>$ python setup.py install
  88. </pre></div>
  89. </div>
  90. </div>
  91. </div>
  92. </div>
  93. <div class="page-nav">
  94. <div class="inner">
  95. <span class="prev">
  96. <a href="index.html"
  97. title="previous chapter">← QCGPU</a>
  98. </span>
  99. <span class="next">
  100. <a href="quickstart.html"
  101. title="next chapter">Getting Started →</a>
  102. </span>
  103. <div class="footer" role="contentinfo">
  104. &#169; Copyright 2018, Adam Kelly.
  105. <br>
  106. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.1 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a>.
  107. </div>
  108. </div>
  109. </div>
  110. </page>
  111. </div></body>
  112. </html>