README.rst 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. QCGPU
  2. =====
  3. .. image:: https://img.shields.io/pypi/v/qcgpu.svg?style=for-the-badge
  4. :target: https://pypi.python.org/pypi/qcgpu
  5. :alt: PyPi Version
  6. .. image:: https://img.shields.io/pypi/l/qcgpu.svg?style=for-the-badge
  7. :target: https://pypi.python.org/pypi/qcgpu/
  8. :alt: License
  9. .. image:: https://img.shields.io/github/stars/qcgpu/qcgpu.svg?style=for-the-badge&label=Stars
  10. :alt: GitHub stars
  11. :target: https://github.com/QCGPU/qcgpu
  12. Open Source, High Performance & Hardware Accelerated, Quantum Computer Simulator.
  13. Read the `research paper`_.
  14. .. _`research paper`: https://arxiv.org/abs/1805.00988
  15. **Features:**
  16. * Written with OpenCL. Accelerated your simuations with GPUs and other accelerators, while still running cross device and cross platform.
  17. * Simulation of arbitrary quantum circuits
  18. * Includes example algorthm implementations
  19. * Support for arbitrary gate creation/application, with many built in.
  20. Installing
  21. ==========
  22. This library is distributed on PyPI_ and can be installed using pip::
  23. pip install qcgpu
  24. For more information read the full installing docs, :ref:`installing`.
  25. TODO: Fix this link
  26. .. _PyPI: https://pypi.python.org/pypi/qcgpu
  27. Configuration
  28. =============
  29. The ``sphinx_rtd_theme`` is highly customizable on both the page level and on a global level.
  30. To see all the possible configuration options read the configuring docs
  31. `here <https://sphinx-rtd-theme.readthedocs.io/en/latest/configuring.html>`__.
  32. Contributing
  33. ============
  34. If you would like to help improve the theme or have more control
  35. over the theme in case of a fork please read our contributing guide
  36. `here <https://sphinx-rtd-theme.readthedocs.io/en/latest/contributing.html>`__.