Initiate Q-CTRL Qiskit Adapter

.github/workflows/on-push.yml

@@ -0,0 +1,72 @@
+name: Push workflow
+
+on:
+  push:
+    branches:
+      - '**'
+
+jobs:
+
+  housekeeping:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: Perform housekeeping checks
+      env:
+        GCLOUD_CONTAINER_AUTH: ${{ secrets.GCLOUD_CONTAINER_AUTH }}
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: |
+        source <(curl -sL http://ci.q-ctrl.com)
+        ./ci docker run asia.gcr.io/q-ctrl-api-development/python-37 /scripts/housekeeping.sh
+
+  linting:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: Install Python dependencies
+      env:
+        GCLOUD_CONTAINER_AUTH: ${{ secrets.GCLOUD_CONTAINER_AUTH }}
+      run: |
+        source <(curl -sL http://ci.q-ctrl.com)
+        ./ci vault login -r ${{ secrets.VAULT_ROLE_ID }} -s ${{ secrets.VAULT_SECRET_ID }}
+        ./ci docker run asia.gcr.io/q-ctrl-api-development/python-37 /scripts/install-python-dependencies.sh
+    - name: Run Pylint
+      run: |
+        ./ci docker run asia.gcr.io/q-ctrl-api-development/python-37 poetry run pylint_runner || true
+    - name: Run Pylama
+      run: |
+        ./ci docker run asia.gcr.io/q-ctrl-api-development/python-37 poetry run pylama || true
+    - name: Run Markdownlint
+      run: |
+        ./ci docker run asia.gcr.io/q-ctrl-api-development/python-37 mdl -- -ig . || true
+
+  pytest:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: [36, 37]
+    steps:
+    - uses: actions/checkout@v1
+    - name: Install Python dependencies
+      env:
+        GCLOUD_CONTAINER_AUTH: ${{ secrets.GCLOUD_CONTAINER_AUTH }}
+      run: |
+        source <(curl -sL http://ci.q-ctrl.com)
+        ./ci vault login -r ${{ secrets.VAULT_ROLE_ID }} -s ${{ secrets.VAULT_SECRET_ID }}
+        ./ci docker run asia.gcr.io/q-ctrl-api-development/python-${{ matrix.python }} /scripts/install-python-dependencies.sh
+    - name: Run Pytest
+      run: |
+        ./ci docker run asia.gcr.io/q-ctrl-api-development/python-${{ matrix.python }} /scripts/pytest.sh
+
+  publish_internally:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: Publish development version
+      env:
+        GCLOUD_CONTAINER_AUTH: ${{ secrets.GCLOUD_CONTAINER_AUTH }}
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: |
+        source <(curl -sL http://ci.q-ctrl.com)
+        ./ci vault login -r ${{ secrets.VAULT_ROLE_ID }} -s ${{ secrets.VAULT_SECRET_ID }}
+        ./ci docker run asia.gcr.io/q-ctrl-api-development/python-37 /scripts/publish-dev-version.sh

.github/workflows/on-release.yml

@@ -0,0 +1,32 @@
+name: Release workflow
+
+on:
+  release:
+    types: [published]
+
+jobs:
+
+  release:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: Update version in code
+      env:
+        GCLOUD_CONTAINER_AUTH: ${{ secrets.GCLOUD_CONTAINER_AUTH }}
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: |
+        source <(curl -sL http://ci.q-ctrl.com)
+        ./ci docker run asia.gcr.io/q-ctrl-api-development/python-37 /scripts/housekeeping.sh
+    - name: Publish publicly
+      env:
+        GCLOUD_CONTAINER_AUTH: ${{ secrets.GCLOUD_CONTAINER_AUTH }}
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: |
+        source <(curl -sL http://ci.q-ctrl.com)
+        ./ci vault login -r ${{ secrets.VAULT_ROLE_ID }} -s ${{ secrets.VAULT_SECRET_ID }}
+        ./ci docker run asia.gcr.io/q-ctrl-api-development/python-37 /scripts/publish-release-publicly.sh
+    - name: Publish internally
+      env:
+        GCLOUD_CONTAINER_AUTH: ${{ secrets.GCLOUD_CONTAINER_AUTH }}
+      run: |
+        ./ci docker run asia.gcr.io/q-ctrl-api-development/python-37 /scripts/publish-release-internally.sh

README.md

@@ -1,6 +1,6 @@
-# Q-CTRL Qiskit
+# Q-CTRL Qiskit Adaptor
 
-The aim of the Q-CTRL Qiskit package is to provide export functions allowing
+The aim of the Q-CTRL Qiskit Adaptor 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 can be install through `pip` or from source. We recommend
+Q-CTRL Qiskit Adaptor 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 you will need an installation of Python. We
+To use Q-CTRL Qiskit Adaptor 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.
+Use `pip` to install the latest version of Q-CTRL Qiskit Adaptor.
 
 ```shell
 pip install qctrl-qiskit

README.rst

@@ -1,8 +1,8 @@
 
-Q-CTRL Qiskit
-=============
+Q-CTRL Qiskit Adaptor
+=====================
 
-The aim of the Q-CTRL Qiskit package is to provide export functions allowing
+The aim of the Q-CTRL Qiskit Adaptor 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.
 
@@ -11,6 +11,7 @@ Anyone interested in quantum control is welcome to contribute to this project.
 Table of Contents
 -----------------
 
+
 * `Installation <#installation>`_
 * `Usage <#usage>`_
 * `Contributing <#contributing>`_
@@ -20,14 +21,14 @@ Table of Contents
 Installation
 ------------
 
-Q-CTRL Qiskit can be installed through ``pip`` or from source. We recommend
+Q-CTRL Qiskit Adaptor 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 you will need an installation of Python. We
+To use Q-CTRL Qiskit Adaptor 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
@@ -42,7 +43,7 @@ jupyter notebook editor <https://jupyter.org/install>`_ on its own.
 Using PyPi
 ^^^^^^^^^^
 
-Use ``pip`` to install the latest version of Q-CTRL Qiskit.
+Use ``pip`` to install the latest version of Q-CTRL Qiskit Adaptor.
 
 .. code-block:: shell
 

docs/index.rst

@@ -1,22 +1,22 @@
 
-Q-CTRL Qiskit
-=============
+Q-CTRL Qiskit Adaptor
+=====================
 
-Aim of the Q-CTRL Qiskit package is to provide easy to use export functions
+Aim of the Q-CTRL Qiskit Adaptor package is to provide easy to use export functions
 allowing users to deploy the quantum controls techniques, define in Q-CTRL Open
-control on IBMQ quantum hardware.
+Controls, on IBMQ quantum hardware.
 
 Installation
 ------------
 
-Q-CTRL Qiskit can be install through ``pip`` or from source. We recommend
+Q-CTRL Qiskit Adaptor 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 you will need an installation of Python. We
+To use Q-CTRL Qiskit Adaptor 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 Qiskit.
+Use ``pip`` to install the latest version of Q-CTRL Qiskit Adaptor.
 
 .. code-block:: shell
 
@@ -73,7 +73,7 @@ Once the clone is complete, you have two options:
    **Note:** if you are on Windows, you'll need to install
    `Poetry <https://poetry.eustace.io>`_ manually, and use:
 
-   .. code-block:: cmd
+   .. code-block:: shell
 
       cd python-qiskit
       poetry install

pyproject.toml

@@ -1,15 +1,16 @@
 [tool.poetry]
 name = "qctrl-qiskit"
-version = "0.0.1"
-description = "Q-CTRL Qiskit"
+version = "0.0.0"
+description = "Q-CTRL Qiskit Adapter"
 license = "Apache-2.0"
 authors = ["Q-CTRL <support@q-ctrl.com>"]
 readme = "README.md"
 keywords = [
     "quantum", 
     "computing", 
     "open source", 
-    "engineering"
+    "engineering",
+    "qiskit"
 ]
 classifiers = [
             "Development Status :: 5 - Production/Stable",
@@ -38,6 +39,8 @@ scipy = "^1.3"
 toml = "^0.10.0"
 qiskit-ibmq-provider = "^0.3.3"
 qiskit-terra = "^0.10.0"
+qctrl-open-controls = "^3.0.0"
+
 
 [tool.poetry.dev-dependencies]
 pytest = "*"

qctrlqiskit/__init__.py

@@ -18,7 +18,7 @@
 ===========
 """
 
-__version__ = "0.0.1"
+__version__ = "0.0.0"
 
 from .quantum_circuit import convert_dds_to_qiskit_quantum_circuit
 

qctrlqiskit/quantum_circuit.py

@@ -94,7 +94,7 @@ def convert_dds_to_qiskit_quantum_circuit(
     the real-circuit is :math:`gate\\_time \\times number\\_of\\_identity\\_gates +
     pulse\\_gate\\_time \\times number\\_of\\_pulses`.
 
-    Q-CTRL Open Controls support operation resulting in rotation around at most one axis at
+    Q-CTRL Qiskit Adapter supports operation resulting in rotation around at most one axis at
     any offset.
     """