Merge branch 'master' of github.com:quantumlib/cirq into v0.3.0-dev

# Conflicts:
#	cirq/_version.py

Author: Strilanc

.readthedocs.yml

@@ -0,0 +1,6 @@
+requirements_file: docs/requirements.txt
+build:
+  image: latest
+python:
+  version: 3.6
+  pip_install: true

README.rst

@@ -9,6 +9,9 @@ circuits and running them against quantum computers and simulators.
   :target: https://travis-ci.com/quantumlib/Cirq
   :alt: Build Status
 
+.. image:: https://badge.fury.io/py/cirq.svg
+    :target: https://badge.fury.io/py/cirq
+
 Installation
 ------------
 
@@ -65,6 +68,15 @@ Contributing
 We welcome contributions. Please follow these
 `guidelines <https://github.com/quantumlib/cirq/blob/master/CONTRIBUTING.md>`__.
 
+See Also
+--------
+
+For those interested in using quantum computers to solve problems in
+chemistry and materials science, we encourage exploring
+`OpenFermion <https://github.com/quantumlib/openfermion>`__ and
+its sister library for compiling quantum simulation algorithms in Cirq,
+`OpenFermion-Cirq <https://github.com/quantumlib/openfermion-cirq>`__.
+
 Disclaimer
 ----------
 

docs/api.rst

@@ -10,9 +10,9 @@ Circuits
     :toctree: generated/
 
     Circuit
-    InsertStrategy
     Moment
-    Schedule
+    InsertStrategy
+    OP_TREE
 
 
 Operations
@@ -22,6 +22,21 @@ Operations
     :toctree: generated/
 
     Operation
+    GateOperation
+    CompositeOperation
+    QasmConvertableOperation
+
+
+Schedules
+---------
+
+.. autosummary::
+    :toctree: generated/
+
+    Schedule
+    ScheduledOperation
+    Duration
+    Timestamp
 
 Gates
 ^^^^^
@@ -32,61 +47,166 @@ Gates
     Gate
     MeasurementGate
 
+Gate Features and Effects
+'''''''''''''''''''''''''
+
+.. autosummary::
+    :toctree: generated
+
+    KnownMatrix
+    ParameterizableEffect
+    CompositeGate
+    ExtrapolatableEffect
+    ReversibleEffect
+    InterchangeableQubitsGate
+    PhaseableEffect
+    TextDiagrammable
+    BoundedEffect
+    SingleQubitGate
+    TwoQubitGate
+    QasmConvertableGate
+    EigenGate
 
 Single Qubit Gates
 ''''''''''''''''''
 
 .. autosummary::
     :toctree: generated/
 
-    H
+    RotXGate
+    RotYGate
+    RotZGate
+    HGate
     X
     Y
     Z
+    H
+    S
+    T
+
 
 Two Qubit Gates
 ''''''''''''''''
 
 .. autosummary::
     :toctree: generated/
 
-    CNOT
+    Rot11Gate
+    CNotGate
+    SwapGate
+    ISwapGate
     CZ
+    CNOT
+    ISWAP
+
+Three Qubit Gates
+''''''''''''''''''
+
+.. autosummary::
+   :toctree: generated/
+
+    CCZ
+    CCX
+    CSWAP
+    TOFFOLI
+    FREDKIN
+
 
 Qubits
 ------
 
-General classes for qubits.
+General classes for qubits and related concepts.
 
 .. autosummary::
     :toctree: generated/
 
     QubitId
     NamedQubit
+    LineQubit
+    GridQubit
+    QubitOrder
+    QubitOrderOrList
+    QubitOrder.DEFAULT
+
+
+Devices
+-------
+
+Classes characterizing constraints of hardware.
 
-See also:
+.. autosummary::
+    :toctree: generated/
 
-* :ref:`Google Qubits <api-google-qubits>`
+    Device
+    UnconstrainedDevice
 
+Placement
+---------
+
+Classes for placing circuits onto circuits.
+
+.. autosummary::
+    :toctree: generated/
+
+    LinePlacementStrategy
+    GreedySequenceSearchStrategy
+    AnnealSequenceSearchStrategy
+    line_on_device
+
+Parameterization
+----------------
+
+Classes for parameterized circuits.
+
+.. autosummary::
+    :toctree: generated/
+
+    Symbol
+    ParamResolver
+    Sweep
+    Points
+    Linspace
+    Sweepable
+
+Optimization
+------------
+
+Classes for compiling.
+
+.. autosummary::
+    :toctree: generated/
+
+    OptimizationPass
+    PointOptimizer
+    PointOptimizationSummary
+    ExpandComposite
+    DropEmptyMoments
+    DropNegligible
 
 Implementations
 ---------------
 
-Packages to use specific hardware implementations of quantum circuits.
+Packages to use specific hardware implementations.
 
 Google
 ^^^^^^
 
-Quantum hardware implementation by the Google Quantum AI Lab.
+Quantum hardware from Google.
 
-Engine
+Gates
 ''''''
 
 .. autosummary::
     :toctree: generated/
 
-    google.Engine
-    google.JobConfig
+    google.XmonGate
+    google.Exp11Gate
+    google.ExpWGate
+    google.ExpZGate
+    google.XmonMeasurementGate
+    google.single_qubit_matrix_to_native_gates
+    google.two_qubit_matrix_to_native_gates
+    google.ConvertToXmonGates
 
 Devices
 '''''''
@@ -96,6 +216,7 @@ Devices
 
     google.Bristlecone
     google.Foxtail
+    google.XmonDevice
 
 Simulator
 '''''''''
@@ -108,12 +229,12 @@ Simulator
     google.XmonStepResult
     google.XmonSimulateTrialResult
 
-.. _api-google-qubits:
-
-Qubits
-''''''
+Optimizers
+''''''''''
 
 .. autosummary::
     :toctree: generated/
 
-    devices.GridQubit
+    google.optimized_for_xmon
+    google.EjectZ
+    google.EjectFullW

docs/requirements.txt

@@ -1,5 +1,3 @@
 recommonmark >= 0.4.0
 Sphinx
 sphinx_rtd_theme
-
--e ..

python2.7-generate.sh

@@ -86,8 +86,8 @@ cp "${in_dir}/LICENSE" "${out_dir}/LICENSE"
 cp "${in_dir}/setup.py" "${out_dir}/setup.py"
 
 # Substitute versions (failing via grep triggering -e if not present.)
-grep "python_requires='>=3.5'" "${out_dir}/setup.py" > /dev/null
-sed -i "s/python_requires='>=3.5'/python_requires='==2.7.*'/" "${out_dir}/setup.py"
+grep "python_requires='>=3.5.3'" "${out_dir}/setup.py" > /dev/null
+sed -i "s/python_requires='>=3.5.3'/python_requires='==2.7.*'/" "${out_dir}/setup.py"
 
 # Mark every file as using utf8 encoding.
 files_to_update=$(find ${out_dir} | grep "\.py$" | grep -v "_pb2\.py$")

setup.py

@@ -19,8 +19,16 @@
 __version__ = None
 exec(open('cirq/_version.py').read())
 
+description = ('A framework for creating, editing, and invoking '
+               'Noisy Intermediate Scale Quantum (NISQ) circuits.')
+
 # Readme file as long_description:
-long_description = io.open('README.rst', encoding='utf-8').read()
+long_description = ('====\n'
+                    'Cirq\n'
+                    '====\n')
+stream = io.open('README.rst', encoding='utf-8')
+stream.readline()
+long_description += stream.read()
 
 # Read in requirements
 requirements = open('runtime-requirements.txt').readlines()
@@ -36,8 +44,10 @@
     url='http://github.com/quantumlib/cirq',
     author='The Cirq Developers',
     author_email='[email protected]',
-    python_requires='>=3.5',
+    python_requires='>=3.5.3',
     install_requires=requirements,
     license='Apache 2',
+    description=description,
+    long_description=long_description,
     packages=cirq_packages,
     package_data={'cirq.api.google.v1': ['*.proto']})