README.rst
1.. image:: https://quantumai.google/site-assets/images/marketing/icons/ic-qcs.png
2 :target: https://github.com/quantumlib/cirq/
3 :alt: cirq-google
4 :width: 500px
5
6`Cirq <https://quantumai.google/cirq>`__ is a Python library for writing, manipulating, and optimizing quantum
7circuits and running them against quantum computers and simulators.
8
9This module is **cirq-google**, which provides everything you'll need to run Cirq quantum algorithms on the Google Quantum Computing Service.
10It also contains additional tools for calibration and characterization of the Google quantum devices.
11
12Documentation
13-------------
14
15Access to Google Hardware is currently restricted to those in an approved group. In order to do this, you will need to apply for access, typically in partnership with a Google sponsor.
16
17To get started with the Quantum Computing Service, checkout the following guide and tutorial:
18
19- `Access and authentication <https://quantumai.google/cirq/google/access>`__
20- `Getting started guide <https://quantumai.google/cirq/tutorials/google/start>`__
21
22Installation
23------------
24
25To install the stable version of only **cirq-google**, use `pip install cirq-google`.
26To install the pre-release version of only **cirq-google**, use `pip install cirq-google --pre`.
27
28Note, that this will install both cirq-google and cirq-core as well.
29
30To get all the optional modules installed as well, you'll have to use `pip install cirq` or `pip install cirq --pre` for the pre-release version.
31
