Added "getting started" to Readme and as notebook and adjusted the docs.

carstenblank · Feb 28, 2019 · 1bcc3bc · 1bcc3bc
1 parent cdcbbf3
commit 1bcc3bc
Show file tree

Hide file tree

Showing 18 changed files with 305 additions and 243 deletions.
diff --git a/README.rst b/README.rst
@@ -36,9 +36,57 @@ Install from PyPI
 
     $ pip install acquantum-qiskit
 
+
+.. getting-started-start-inclusion-marker-do-not-remove
+
 Getting started
 ===============
 
+As this provider is only needed to actually run a quantum circuit, pretty much the whole stack
+is identical as already known. The only difference is that the provider must be instantiated
+explicitly and the credentials must be given: either directly through user/password or by
+setting system environment variables `ACQ_USER` and `ACQ_PWD`.
+
+.. code-block:: python
+
+    import qiskit
+    import qiskit.extensions.standard as standard
+    from qiskit.circuit.measure import measure
+    from qiskit.circuit import QuantumCircuit, QuantumRegister, ClassicalRegister
+
+    from acquantum_qiskit import AcQuantumProvider
+
+    q = QuantumRegister(2, "q")
+    r = QuantumRegister(1, "r")
+    c = ClassicalRegister(2, "c")
+    ca = ClassicalRegister(1, "c^a")
+    qc = QuantumCircuit(q, r, c, ca, name="TestCircuit")
+    standard.h(qc, q[0])
+    standard.cx(qc, q[0], q[1])
+    standard.x(qc, r)
+    measure(qc, q, c)
+    measure(qc, r, ca)
+
+    # Create the provider
+    provider = AcQuantumProvider()
+
+    # load_account without arguments tries to load from system environment varables
+    # the user (ACQ_USER) and password (ACQ_PWD)
+    provider.enable_account()
+
+    # if this is not what you want instantiate instead
+    # ===> uncomment this if you want this:
+    # provider.enable_account(user='your_user', password='xxxxxxxx')
+
+    backend = provider.get_backend("SIMULATE")  # type: AcQuantumBackend
+
+    # Execute and print out the results
+    job = qiskit.execute(qc, backend, shots=1024, seed=None)
+    result = job.result()
+    print(result.get_counts())
+
+
+.. getting-started-end-inclusion-marker-do-not-remove
 
 Contributing
 ============

diff --git a/docs/acquantum_qiskit.credentials.rst b/docs/acquantum_qiskit.credentials.rst
@@ -0,0 +1,13 @@
+acquantum_qiskit.credentials package
+=====================================
+
+Submodules
+----------
+
+Module contents
+---------------
+
+.. automodule:: acquantum_qiskit.credentials
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/acquantum_qiskit.models.rst b/docs/acquantum_qiskit.models.rst
@@ -0,0 +1,22 @@
+acquantum_qiskit.models package
+================================
+
+Submodules
+----------
+
+acquantum_qiskit.models.Model module
+-------------------------------------
+
+.. automodule:: acquantum_qiskit.models.Model
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: acquantum_qiskit.models
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/acquantum_qiskit.rst b/docs/acquantum_qiskit.rst
@@ -0,0 +1,70 @@
+acquantum_qiskit package
+===========================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    acquantum_qiskit.credentials
+    acquantum_qiskit.models
+
+Submodules
+----------
+
+acquantum_qiskit.acquantumbackend module
+-------------------------------------------
+
+.. automodule:: acquantum_qiskit.acquantumbackend
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+acquantum_qiskit.acquantumerrors module
+------------------------------------------
+
+.. automodule:: acquantum_qiskit.acquantumerrors
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+acquantum_qiskit.acquantumjob module
+---------------------------------------
+
+.. automodule:: acquantum_qiskit.acquantumjob
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+acquantum_qiskit.acquantumprovider module
+--------------------------------------------
+
+.. automodule:: acquantum_qiskit.acquantumprovider
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+acquantum_qiskit.acquantumsingleprovider module
+--------------------------------------------------
+
+.. automodule:: acquantum_qiskit.acquantumsingleprovider
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+acquantum_qiskit.backendconfiguration module
+-----------------------------------------------
+
+.. automodule:: acquantum_qiskit.backendconfiguration
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: acquantum_qiskit
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/getting_started.rst b/docs/getting_started.rst
@@ -0,0 +1,3 @@
+.. include:: ../README.rst
+  :start-after:	getting-started-start-inclusion-marker-do-not-remove
+  :end-before: getting-started-end-inclusion-marker-do-not-remove
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,17 +1,19 @@
 .. qiskit_alibaba_provider documentation master file, created by
-sphinx-quickstart on Wed Jan 23 13:20:27 2019.
-You can adapt this file completely to your liking, but it should at least
-contain the root `toctree` directive.
+    sphinx-quickstart on Wed Jan 23 13:20:27 2019.
+    You can adapt this file completely to your liking, but it should at least
+    contain the root `toctree` directive.
 
 Welcome to qiskit_alibaba_provider's documentation!
 ===================================================
 
+Welcome to the documentation of the qiskit-plugin of the Alibaba Quantum Computer!
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
-   providers
-   setup
+   getting_started
+   acquantum_qiskit
    test
 
 

diff --git a/docs/modules.rst b/docs/modules.rst
@@ -4,6 +4,6 @@ qiskit_alibaba_provider
 .. toctree::
    :maxdepth: 4
 
-   providers
+   acquantum_qiskit
    setup
    test
diff --git a/docs/providers.acquantum.credentials.rst b/docs/providers.acquantum.credentials.rst
diff --git a/docs/providers.acquantum.models.rst b/docs/providers.acquantum.models.rst
diff --git a/docs/providers.acquantum.rst b/docs/providers.acquantum.rst
diff --git a/docs/providers.rst b/docs/providers.rst
diff --git a/docs/setup.rst b/docs/setup.rst
diff --git a/.../test.providers.acquantum.credentials.rst → docs/test.acquantum_qiskit.credentials.rst b/.../test.providers.acquantum.credentials.rst → docs/test.acquantum_qiskit.credentials.rst
@@ -1,13 +1,13 @@
-test.providers.acquantum.credentials package
+test.acquantum_qiskit.credentials package
 ============================================
 
 Submodules
 ----------
 
-test.providers.acquantum.credentials.test\_credentials module
+test.acquantum_qiskit.credentials.test\_credentials module
 -------------------------------------------------------------
 
-.. automodule:: test.providers.acquantum.credentials.test_credentials
+.. automodule:: test.acquantum_qiskit.credentials.test_credentials
     :members:
     :undoc-members:
     :show-inheritance:
@@ -16,7 +16,7 @@ test.providers.acquantum.credentials.test\_credentials module
 Module contents
 ---------------
 
-.. automodule:: test.providers.acquantum.credentials
+.. automodule:: test.acquantum_qiskit.credentials
     :members:
     :undoc-members:
     :show-inheritance: