Merge pull request #3 from qctrl/convert-adapter

changed adaptor to adapter and Pyquil to pyQuil

Author: Rajib Chakravorty

README.md

@@ -1,6 +1,6 @@
-# Q-CTRL Pyquil Adaptor
+# Q-CTRL pyQuil Adapter
 
-The aim of the Q-CTRL Pyquil Adaptor package is to provide export functions allowing
+The aim of the Q-CTRL pyQuil 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 Rigetti quantum hardware 
 and simulators.
@@ -18,13 +18,13 @@ Anyone interested in quantum control is welcome to contribute to this project.
 
 ## Installation
 
-Q-CTRL Pyquil Adaptor can be installed through `pip` or from source. We recommend
+Q-CTRL pyQuil 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 Pyquil Adaptor you will need an installation of Python. We
+To use Q-CTRL pyQuil 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
@@ -38,7 +38,7 @@ jupyter notebook editor](https://jupyter.org/install) on its own.
 
 ### Using PyPi
 
-Use `pip` to install the latest version of Q-CTRL Pyquil Adaptor.
+Use `pip` to install the latest version of Q-CTRL pyQuil Adapter.
 
 ```shell
 pip install qctrl-pyquil

README.rst

@@ -1,8 +1,8 @@
 
-Q-CTRL Pyquil Adaptor
+Q-CTRL pyQuil Adapter
 =====================
 
-The aim of the Q-CTRL Pyquil Adaptor package is to provide export functions allowing
+The aim of the Q-CTRL pyQuil 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 Rigetti quantum hardware 
 and simulators.
@@ -22,14 +22,14 @@ Table of Contents
 Installation
 ------------
 
-Q-CTRL Pyquil Adaptor can be installed through ``pip`` or from source. We recommend
+Q-CTRL pyQuil 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 Pyquil Adaptor you will need an installation of Python. We
+To use Q-CTRL pyQuil 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
@@ -44,7 +44,7 @@ jupyter notebook editor <https://jupyter.org/install>`_ on its own.
 Using PyPi
 ^^^^^^^^^^
 
-Use ``pip`` to install the latest version of Q-CTRL Pyquil Adaptor.
+Use ``pip`` to install the latest version of Q-CTRL pyQuil Adapter.
 
 .. code-block:: shell
 

docs/index.rst

@@ -1,22 +1,22 @@
 
-Q-CTRL Pyquil Adaptor
+Q-CTRL pyQuil Adapter
 =====================
 
-Aim of the Q-CTRL Pyquil Adaptor package is to provide easy to use export functions
+Aim of the Q-CTRL pyQuil 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 Rigetti quantum devices and simulators.
 
 Installation
 ------------
 
-Q-CTRL Pyquil Adaptor can be install through ``pip`` or from source. We recommend
+Q-CTRL pyQuil 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 Pyquil Adaptor you will need an installation of Python. We
+To use Q-CTRL pyQuil 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
@@ -31,7 +31,7 @@ jupyter notebook editor <https://jupyter.org/install>`_ on its own.
 Using PyPi
 ^^^^^^^^^^
 
-Use ``pip`` to install the latest version of Q-CTRL Pyquil Adaptor.
+Use ``pip`` to install the latest version of Q-CTRL pyQuil Adapter.
 
 .. code-block:: shell
 

poetry.lock

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "qctrl-pyquil"
 version = "0.0.1"
-description = "Q-CTRL Pyquil Adapter"
+description = "Q-CTRL pyQuil Adapter"
 license = "Apache-2.0"
 authors = ["Q-CTRL <[email protected]>"]
 readme = "README.md"

pyproject.toml

@@ -38,7 +38,7 @@ def convert_dds_to_pyquil_program(
         algorithm=INSTANT_UNITARY):
 
     """Converts a Dynamic Decoupling Sequence into quantum program
-    as defined in Pyquil.
+    as defined in pyQuil.
 
     Parameters
     ----------
@@ -63,7 +63,7 @@ def convert_dds_to_pyquil_program(
     Returns
     -------
     pyquil.Program
-        The Pyquil program containting gates specified by the rotations of
+        The pyQuil program containing gates specified by the rotations of
         dynamic decoupling sequence
 
     Raises

qctrlpyquil/program.py

@@ -25,7 +25,7 @@
     long_description=readme,
     name='qctrl-pyquil',
     version='0.0.1',
-    description='Q-CTRL Pyquil Adapter',
+    description='Q-CTRL pyQuil Adapter',
     python_requires='<3.8,>=3.6.4',
     project_urls={"repository": "https://github.com/qctrl/python-pyquil"},
     author='Q-CTRL',

setup.py

@@ -15,7 +15,7 @@
 
 """
 ===================================
-Tests conversion to Pyquil program
+Tests conversion to PyQuil program
 ===================================
 """
 
@@ -31,7 +31,7 @@
 def test_pyquil_program():
 
     """Tests if the Dynamic Decoupling Sequence gives rise to Identity
-    operation in Pyquil
+    operation in PyQuil
     """
     _duration = 5e-6
     _offsets = [0, 1e-6, 2.5e-6, 4e-6, 5e-6]