From c235cd97fe7bd177fca529071161146d395f163a Mon Sep 17 00:00:00 2001 From: Jay Gambetta Date: Fri, 4 Aug 2017 16:47:40 -0400 Subject: [PATCH 1/7] Update README.rst --- README.rst | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index a0d4d18da145..4c9e494ff4d7 100644 --- a/README.rst +++ b/README.rst @@ -26,9 +26,9 @@ Organization The *tutorial* directory contains Jupyter notebooks demonstrating components of the SDK. Take a look at the `index `__ to get started. The SDK uses the -`Python API `__ to interact with +`Python API `__ to interact with the QX and expresses quantum circuits using -`OpenQASM `__. Python example +`OpenQASM `__. Python example programs can be found in the *examples* directory, and test scripts are located in *test*. The *qiskit* directory is the main module of the SDK. @@ -112,7 +112,7 @@ machine: .. code:: sh - git clone https://github.com/IBM/qiskit-sdk-py + git clone https://github.com/QISKit/qiskit-sdk-py cd qiskit-sdk-py - If you don't have Git installed, click the "Clone or download" button @@ -216,8 +216,7 @@ on the project's GitHub wiki. Authors (alphabetical) ---------------------- -The first release of QISKit was developed by Jim Challenger, Andrew -Cross, Ismael Faro, Jay Gambetta, Jesus Perez, and John Smolin. +Jim Challenger, Andrew Cross, Ismael Faro, Jay Gambetta, Juan Gomez, Paco Martin, Antonio Mezzacapo, Jesus Perez, and John Smolin, Erick Winston, Chris Wood. In future releases, anyone who contributes code to this project can include their name here. @@ -234,5 +233,5 @@ Do you want to help? :sunglasses: If you'd like to contribute please take a look to our `contribution guidelines `__. -.. |Build Status| image:: https://travis.ibm.com/IBMQuantum/qiskit-sdk-py-dev.svg?token=GMH4xFrA9iezVJKqw2zH&branch=master - :target: https://travis.ibm.com/IBMQuantum/qiskit-sdk-py-dev +.. |Build Status| image:: https://travis.com/QISKit/qiskit-sdk-py-dev.svg?token=GMH4xFrA9iezVJKqw2zH&branch=master + :target: https://travis.ibm.com/QISKit/qiskit-sdk-py From 298ca56453512d5675d2eada519dbbee82e07e15 Mon Sep 17 00:00:00 2001 From: Jay Gambetta Date: Fri, 4 Aug 2017 16:50:44 -0400 Subject: [PATCH 2/7] Update CODEOWNERS --- CODEOWNERS | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/CODEOWNERS b/CODEOWNERS index 0d26771d7261..411b83a41930 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -1,13 +1,14 @@ # Where component owners are known, add them here. -qiskit/core/* @ewinston @awcross1 @pacomf @jaygambetta @ismael -qiskit/core/simulators/* @ewinston @cjwood +qiskit/core/* @ewinston @awcross1 @pacomf @jaygambetta @ismaelfaro +qiskit/core/simulators/* @ewinston @chriseclectic qiskit/doc/* @ewinston @pacomf -qiskit/tools/qcvv/* @cjwood -qiskit/tools/qi/* @cjwood +qiskit/tools/qcvv/* @chriseclectic +qiskit/tools/qi/* @chriseclectic qiskit/tools/apps/* @amezzac #other repository + qiskit-tutorial @ewinston @awcross1 @jaygambetta qiskit-api-py @pacomf From 5fa35312372c8ca0e63eacd6b633caca5434268f Mon Sep 17 00:00:00 2001 From: Jay Gambetta Date: Fri, 4 Aug 2017 16:50:52 -0400 Subject: [PATCH 3/7] Update CODEOWNERS --- CODEOWNERS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CODEOWNERS b/CODEOWNERS index 411b83a41930..be78aa782549 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -8,7 +8,7 @@ qiskit/tools/qcvv/* @chriseclectic qiskit/tools/qi/* @chriseclectic qiskit/tools/apps/* @amezzac -#other repository +# other repository qiskit-tutorial @ewinston @awcross1 @jaygambetta qiskit-api-py @pacomf From f50bf683aed362db401e0310807ab6a5574d9848 Mon Sep 17 00:00:00 2001 From: Jay Gambetta Date: Fri, 4 Aug 2017 17:07:47 -0400 Subject: [PATCH 4/7] Update README.rst --- README.rst | 35 +++++++++++++++++++++++------------ 1 file changed, 23 insertions(+), 12 deletions(-) diff --git a/README.rst b/README.rst index 4c9e494ff4d7..7a480e3bce88 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,5 @@ -Quantum Information Software Kit (QISKit) SDK Python -==================================================== +Quantum Information Software Kit (QISKit) +========================================= |Build Status| @@ -23,13 +23,7 @@ next instance. Organization ------------ -The *tutorial* directory contains Jupyter notebooks demonstrating -components of the SDK. Take a look at the -`index `__ to get started. The SDK uses the -`Python API `__ to interact with -the QX and expresses quantum circuits using -`OpenQASM `__. Python example -programs can be found in the *examples* directory, and test scripts are +Python example programs can be found in the *examples* directory, and test scripts are located in *test*. The *qiskit* directory is the main module of the SDK. Structure @@ -85,8 +79,16 @@ fixed couplings given by a *CouplingGraph*. The four circuit representations and how they are currently transformed into each other are summarized in this figure: +.. image:: images/circuit_representations.png + :width: 200px + :align: center + Several unroller backends and their outputs are summarized here: +.. image:: images/unroller_backends.png + :width: 200px + :align: center + Installation and setup ---------------------- @@ -218,8 +220,17 @@ Authors (alphabetical) Jim Challenger, Andrew Cross, Ismael Faro, Jay Gambetta, Juan Gomez, Paco Martin, Antonio Mezzacapo, Jesus Perez, and John Smolin, Erick Winston, Chris Wood. -In future releases, anyone who contributes code to this project can -include their name here. +In future releases, anyone who contributes code to this project can include their name here. + +Other QISKit projects +--------------------- + +- `OpenQasm `__ Examples and tools for the OpenQASM intermediate representation. +- `Python API `__ API Client to use IBM Q experience in Python. +- `Tutorial `__ Jupyter notebooks for using QISKit. +- `QX Information `__ Information about the different IBM Q experience backends. +- `QX User Guide `__ The users guides for the IBM Q experience. + License ------- @@ -231,7 +242,7 @@ Do you want to help? -------------------- :sunglasses: If you'd like to contribute please take a look to our -`contribution guidelines `__. +`contribution guidelines `__. .. |Build Status| image:: https://travis.com/QISKit/qiskit-sdk-py-dev.svg?token=GMH4xFrA9iezVJKqw2zH&branch=master :target: https://travis.ibm.com/QISKit/qiskit-sdk-py From 56ca2996a2f01e3a9787a2fc44f02d1bbfe45ddf Mon Sep 17 00:00:00 2001 From: Erick Winston Date: Fri, 4 Aug 2017 17:11:17 -0400 Subject: [PATCH 5/7] move authors --- doc/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index aebeb78cd758..5b7fb5b93616 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -66,8 +66,8 @@ # General information about the project. project = 'QISKit SDK' -copyright = '2017, Jim Challenger, Andrew Cross, Ismael Faro, Jay Gambetta, Jesus Perez, and John Smolin' -author = 'Jim Challenger, Andrew Cross, Ismael Faro, Jay Gambetta, Jesus Perez, and John Smolin' +copyright = '' +author = '' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the From a46039fe06aa64141e337c985b216f469c5b1dba Mon Sep 17 00:00:00 2001 From: Erick Winston Date: Fri, 4 Aug 2017 17:28:35 -0400 Subject: [PATCH 6/7] minor readme fix --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 7a480e3bce88..9fddc00c4758 100644 --- a/README.rst +++ b/README.rst @@ -241,7 +241,7 @@ QISKit is released under the `Apache license, version Do you want to help? -------------------- -:sunglasses: If you'd like to contribute please take a look to our +If you'd like to contribute please take a look to our `contribution guidelines `__. .. |Build Status| image:: https://travis.com/QISKit/qiskit-sdk-py-dev.svg?token=GMH4xFrA9iezVJKqw2zH&branch=master From 0816f0cc7d677efebc90542994f2917f747db20f Mon Sep 17 00:00:00 2001 From: Jay Gambetta Date: Fri, 4 Aug 2017 17:34:11 -0400 Subject: [PATCH 7/7] Update README.rst --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 9fddc00c4758..10c538dc3529 100644 --- a/README.rst +++ b/README.rst @@ -244,5 +244,5 @@ Do you want to help? If you'd like to contribute please take a look to our `contribution guidelines `__. -.. |Build Status| image:: https://travis.com/QISKit/qiskit-sdk-py-dev.svg?token=GMH4xFrA9iezVJKqw2zH&branch=master - :target: https://travis.ibm.com/QISKit/qiskit-sdk-py +.. |Build Status| image:: https://travis-ci.org/QISKit/qiskit-sdk-py.svg?branch=master + :target: https://travis-ci.org/QISKit/qiskit-sdk-py