diff --git a/CODEOWNERS b/CODEOWNERS index 0d26771d7261..be78aa782549 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 +# other repository + qiskit-tutorial @ewinston @awcross1 @jaygambetta qiskit-api-py @pacomf diff --git a/README.rst b/README.rst index a0d4d18da145..10c538dc3529 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 ---------------------- @@ -112,7 +114,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,11 +218,19 @@ 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. + +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. -In future releases, anyone who contributes code to this project can -include their name here. License ------- @@ -231,8 +241,8 @@ 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 -`contribution guidelines `__. +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-ci.org/QISKit/qiskit-sdk-py.svg?branch=master + :target: https://travis-ci.org/QISKit/qiskit-sdk-py 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