index.html 7.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256
  1. <!DOCTYPE html>
  2. <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
  3. <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
  4. <head>
  5. <meta charset="utf-8">
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <title>QCGPU &mdash; QCGPU 0.1.0 documentation</title>
  8. <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  9. <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  10. <link rel="index" title="Index" href="genindex.html" />
  11. <link rel="search" title="Search" href="search.html" />
  12. <link rel="next" title="Installing" href="installing.html" />
  13. <script src="_static/js/modernizr.min.js"></script>
  14. </head>
  15. <body class="wy-body-for-nav">
  16. <div class="wy-grid-for-nav">
  17. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  18. <div class="wy-side-scroll">
  19. <div class="wy-side-nav-search">
  20. <a href="#" class="icon icon-home"> QCGPU
  21. </a>
  22. <div role="search">
  23. <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
  24. <input type="text" name="q" placeholder="Search docs" />
  25. <input type="hidden" name="check_keywords" value="yes" />
  26. <input type="hidden" name="area" value="default" />
  27. </form>
  28. </div>
  29. </div>
  30. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  31. <p class="caption"><span class="caption-text">Contents:</span></p>
  32. <ul>
  33. <li class="toctree-l1"><a class="reference internal" href="installing.html">Installing</a></li>
  34. </ul>
  35. </div>
  36. </div>
  37. </nav>
  38. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  39. <nav class="wy-nav-top" aria-label="top navigation">
  40. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  41. <a href="#">QCGPU</a>
  42. </nav>
  43. <div class="wy-nav-content">
  44. <div class="rst-content">
  45. <div role="navigation" aria-label="breadcrumbs navigation">
  46. <ul class="wy-breadcrumbs">
  47. <li><a href="#">Docs</a> &raquo;</li>
  48. <li>QCGPU</li>
  49. <li class="wy-breadcrumbs-aside">
  50. <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
  51. </li>
  52. </ul>
  53. <hr/>
  54. </div>
  55. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  56. <div itemprop="articleBody">
  57. <div class="section" id="qcgpu">
  58. <h1>QCGPU<a class="headerlink" href="#qcgpu" title="Permalink to this headline">¶</a></h1>
  59. <a class="reference external image-reference" href="https://travis-ci.org/QCGPU/qcgpu"><img alt="Travis (.org)" src="https://img.shields.io/travis/QCGPU/qcgpu.svg?style=for-the-badge" /></a>
  60. <a class="reference external image-reference" href="https://pypi.python.org/pypi/qcgpu"><img alt="PyPi Version" src="https://img.shields.io/pypi/v/qcgpu.svg?style=for-the-badge" /></a>
  61. <a class="reference external image-reference" href="https://pypi.python.org/pypi/qcgpu/"><img alt="License" src="https://img.shields.io/pypi/l/qcgpu.svg?style=for-the-badge" /></a>
  62. <a class="reference external image-reference" href="https://github.com/QCGPU/qcgpu"><img alt="GitHub stars" src="https://img.shields.io/github/stars/qcgpu/qcgpu.svg?style=for-the-badge&amp;label=Stars" /></a>
  63. <p>Open Source, High Performance &amp; Hardware Accelerated, Quantum Computer Simulator.
  64. Read the <a class="reference external" href="https://arxiv.org/abs/1805.00988">research paper</a>.</p>
  65. <p><strong>Features:</strong></p>
  66. <ul class="simple">
  67. <li>Written with OpenCL. Accelerated your simuations with GPUs and other accelerators, while still running cross device and cross platform.</li>
  68. <li>Simulation of arbitrary quantum circuits</li>
  69. <li>Includes example algorthm implementations</li>
  70. <li>Support for arbitrary gate creation/application, with many built in.</li>
  71. </ul>
  72. </div>
  73. <div class="section" id="installing">
  74. <h1>Installing<a class="headerlink" href="#installing" title="Permalink to this headline">¶</a></h1>
  75. <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>
  76. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">qcgpu</span>
  77. </pre></div>
  78. </div>
  79. <p>For more information read the full installing docs, <a class="reference internal" href="installing.html#installing"><span class="std std-ref">Installing</span></a>.</p>
  80. <p>TODO: Fix this link</p>
  81. <div class="toctree-wrapper compound">
  82. <p class="caption"><span class="caption-text">Contents:</span></p>
  83. <ul>
  84. <li class="toctree-l1"><a class="reference internal" href="installing.html">Installing</a><ul>
  85. <li class="toctree-l2"><a class="reference internal" href="installing.html#prerequisites">Prerequisites</a></li>
  86. <li class="toctree-l2"><a class="reference internal" href="installing.html#installing-from-pypi">Installing from PyPI</a></li>
  87. <li class="toctree-l2"><a class="reference internal" href="installing.html#installing-from-source">Installing from Source</a></li>
  88. </ul>
  89. </li>
  90. </ul>
  91. </div>
  92. </div>
  93. <div class="section" id="indices-and-tables">
  94. <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
  95. <ul class="simple">
  96. <li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
  97. <li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
  98. <li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
  99. </ul>
  100. </div>
  101. </div>
  102. </div>
  103. <footer>
  104. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  105. <a href="installing.html" class="btn btn-neutral float-right" title="Installing" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
  106. </div>
  107. <hr/>
  108. <div role="contentinfo">
  109. <p>
  110. &copy; Copyright 2018, Adam Kelly.
  111. </p>
  112. </div>
  113. Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
  114. </footer>
  115. </div>
  116. </div>
  117. </section>
  118. </div>
  119. <script type="text/javascript">
  120. var DOCUMENTATION_OPTIONS = {
  121. URL_ROOT:'./',
  122. VERSION:'0.1.0',
  123. LANGUAGE:'None',
  124. COLLAPSE_INDEX:false,
  125. FILE_SUFFIX:'.html',
  126. HAS_SOURCE: true,
  127. SOURCELINK_SUFFIX: '.txt'
  128. };
  129. </script>
  130. <script type="text/javascript" src="_static/jquery.js"></script>
  131. <script type="text/javascript" src="_static/underscore.js"></script>
  132. <script type="text/javascript" src="_static/doctools.js"></script>
  133. <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
  134. <script type="text/javascript" src="_static/js/theme.js"></script>
  135. <script type="text/javascript">
  136. jQuery(function () {
  137. SphinxRtdTheme.Navigation.enable(true);
  138. });
  139. </script>
  140. </body>
  141. </html>