.. QGates documentation master file, created by
   sphinx-quickstart on Thu Nov 12 14:50:14 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

QGates
=======

Welcome to QGates's documentation!
----------------------------------

.. image:: https://media2.giphy.com/media/AvCPKNLbH6FoI/giphy.gif

.. toctree::
   :maxdepth: 4
   :caption: Contents:

   qgates


About
------

.. image:: https://travis-ci.com/a-poor/QGates.svg?branch=master
   :target: https://travis-ci.com/a-poor/QGates
   :alt: Build Status
.. image:: https://img.shields.io/pypi/v/qgates
   :target: https://pypi.org/project/qgates
   :alt: PyPI
.. image:: https://img.shields.io/pypi/pyversions/qgates
   :target: https://pypi.org/project/qgates
   :alt: PyPI - Python Version
.. image:: https://img.shields.io/github/last-commit/a-poor/qgates
   :target: https://github.com/a-poor/QGates
   :alt: GitHub last commit
.. image:: https://img.shields.io/pypi/l/qgates
   :target: https://github.com/a-poor/QGates
   :alt: PyPI - License
.. image:: https://readthedocs.org/projects/qgates/badge/?version=latest
   :target: https://qgates.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status

*created by Austin Poor*

A small library with some helper functions, quantum gates, and quantum states represented as `numpy <https://numpy.org>`_ matrices.

Originally written to help with the `Quantum Computing <http://science.slc.edu/~jmarshall/courses/fall/2019/quantum>`_ course I took at Sarah Lawrence College, taught by Professor James Marshall.

* GitHub: https://github.com/a-poor/QGates
* PyPi: https://pypi.org/project/qgates
* Read the Docs: https://qgates.readthedocs.io


Requirements
------------

* ``python>=3.6``
* ``numpy``


Installation
-------------
Installing with ``pip``:

.. code-block:: console

    $ pip install qgates


Examples
---------

.. image:: https://mybinder.org/badge_logo.svg
 :target: https://mybinder.org/v2/gh/a-poor/QGates/HEAD?filepath=examples%2Fqgates-example.ipynb

Check out the examples notebook in the GitHub repo, `here <https://github.com/a-poor/QGates/blob/master/examples/qgates-example.ipynb>`_.

Or open the notebook in `binder <https://mybinder.org/v2/gh/a-poor/QGates/HEAD?filepath=examples%2Fqgates-example.ipynb>`_.

------------

Submit a PR or an issue if you have any suggestions!