diff --git a/README.md b/README.md index f3c7ce9..c51ce8a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Q-CTRL Qiskit Adaptor +# Q-CTRL Qiskit Adapter -The aim of the Q-CTRL Qiskit Adaptor package is to provide export functions allowing +The aim of the Q-CTRL Qiskit Adapter package is to provide export functions allowing users to deploy established error-robust quantum control protocols from the open literature and defined in Q-CTRL Open Controls on IBM Quantum hardware. @@ -17,13 +17,13 @@ Anyone interested in quantum control is welcome to contribute to this project. ## Installation -Q-CTRL Qiskit Adaptor can be installed through `pip` or from source. We recommend +Q-CTRL Qiskit Adapter can be installed through `pip` or from source. We recommend the `pip` distribution to get the most recent stable release. If you want the latest features then install from source. ### Requirements -To use Q-CTRL Qiskit Adaptor you will need an installation of Python. We +To use Q-CTRL Qiskit Adapter you will need an installation of Python. We recommend using the [Anaconda](https://www.anaconda.com/) distribution of Python. Anaconda includes standard numerical and scientific Python packages which are optimally compiled for your machine. Follow the [Anaconda @@ -37,7 +37,7 @@ jupyter notebook editor](https://jupyter.org/install) on its own. ### Using PyPi -Use `pip` to install the latest version of Q-CTRL Qiskit Adaptor. +Use `pip` to install the latest version of Q-CTRL Qiskit Adapter. ```shell pip install qctrl-qiskit diff --git a/README.rst b/README.rst index 40fc5da..604a1a8 100644 --- a/README.rst +++ b/README.rst @@ -1,8 +1,8 @@ -Q-CTRL Qiskit Adaptor +Q-CTRL Qiskit Adapter ===================== -The aim of the Q-CTRL Qiskit Adaptor package is to provide export functions allowing +The aim of the Q-CTRL Qiskit Adapter package is to provide export functions allowing users to deploy established error-robust quantum control protocols from the open literature and defined in Q-CTRL Open Controls on IBM Quantum hardware. @@ -21,14 +21,14 @@ Table of Contents Installation ------------ -Q-CTRL Qiskit Adaptor can be installed through ``pip`` or from source. We recommend +Q-CTRL Qiskit Adapter can be installed through ``pip`` or from source. We recommend the ``pip`` distribution to get the most recent stable release. If you want the latest features then install from source. Requirements ^^^^^^^^^^^^ -To use Q-CTRL Qiskit Adaptor you will need an installation of Python. We +To use Q-CTRL Qiskit Adapter you will need an installation of Python. We recommend using the `Anaconda `_ distribution of Python. Anaconda includes standard numerical and scientific Python packages which are optimally compiled for your machine. Follow the `Anaconda @@ -43,7 +43,7 @@ jupyter notebook editor `_ on its own. Using PyPi ^^^^^^^^^^ -Use ``pip`` to install the latest version of Q-CTRL Qiskit Adaptor. +Use ``pip`` to install the latest version of Q-CTRL Qiskit Adapter. .. code-block:: shell diff --git a/docs/index.rst b/docs/index.rst index a3dcbc4..9b7f8c8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,22 +1,22 @@ -Q-CTRL Qiskit Adaptor +Q-CTRL Qiskit Adapter ===================== -Aim of the Q-CTRL Qiskit Adaptor package is to provide easy to use export functions +Aim of the Q-CTRL Qiskit Adapter package is to provide easy to use export functions allowing users to deploy the quantum controls techniques, define in Q-CTRL Open Controls, on IBMQ quantum hardware. Installation ------------ -Q-CTRL Qiskit Adaptor can be install through ``pip`` or from source. We recommend +Q-CTRL Qiskit Adapter can be install through ``pip`` or from source. We recommend the ``pip`` distribution to get the most recent stable release. If you want the latest features then install from source. Requirements ^^^^^^^^^^^^ -To use Q-CTRL Qiskit Adaptor you will need an installation of Python. We +To use Q-CTRL Qiskit Adapter you will need an installation of Python. We recommend using the `Anaconda `_ distribution of Python. Anaconda includes standard numerical and scientific Python packages which are optimally compiled for your machine. Follow the `Anaconda @@ -31,7 +31,7 @@ jupyter notebook editor `_ on its own. Using PyPi ^^^^^^^^^^ -Use ``pip`` to install the latest version of Q-CTRL Qiskit Adaptor. +Use ``pip`` to install the latest version of Q-CTRL Qiskit Adapter. .. code-block:: shell