Dev

.github/workflows/test_dev.yml

@@ -10,15 +10,9 @@ on:
 
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
-  # This workflow contains a single job called "build"
-  build:
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest]
-        python: [3.8]  
-    # The type of runner that the job will run on
-    runs-on:  ${{ matrix.os }}
+  test-dev:
+    runs-on: ubuntu-latest
+    if : ${{ github.event.pull_request.head.repo.fork == false }} # runs only when fork==false
 
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
@@ -29,8 +23,11 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v3
         with:
-          python-version: ${{ matrix.python }}
-
+          python-version: 3.8
+      - name: Log in with Azure
+        uses: azure/login@v1
+        with:
+          creds: '${{ secrets.AZURE_CREDENTIALS }}'
       - name: Install OpenQAOA
         run: |
           python -m pip install --user virtualenv
@@ -39,30 +36,35 @@ jobs:
           python -m pip install --upgrade pip
           pip install .[tests]
           pip install ipykernel
-
-      - name: Install qvm
+      - name: Setup IBMQ account
+        env:
+          IBMQ_TOKEN: ${{ secrets.IBMQ_TOKEN }} 
         run: |
-          find /usr/lib -name "libffi.so*"
-          sudo ln -s /usr/lib/x86_64-linux-gnu/libffi.so /usr/lib/x86_64-linux-gnu/libffi.so.6
-          wget -q https://downloads.rigetti.com/qcs-sdk/forest-sdk-2.23.0-linux-deb.tar.bz2
-          tar -xf forest-sdk-2.23.0-linux-deb.tar.bz2
-          cd forest-sdk-2.23.0-linux-deb/
-          sudo apt-get update
-          sudo apt-get install -y screen libblas-dev libblas3 libgfortran5 liblapack-dev liblapack3
-          sudo ./forest-sdk-2.23.0-linux-deb.run
-          qvm --version
-          quilc --version
-          echo "Starting qvm and quilc"
-          screen -d -m qvm -S
-          screen -d -m quilc -S
-          cd ..
-
+          IBMQ_TOKEN=$IBMQ_TOKEN
+          source env/bin/activate
+          python -c'from qiskit_ibm_provider import IBMProvider; import os; IBMProvider.save_account(os.environ.get("IBMQ_TOKEN"))'
+      - name: Setup AWS
+        env:
+          ACCESS_KEY: ${{ secrets.ACCESS_KEY }} 
+          SECRET_ACCESS_KEY: ${{ secrets.SECRET_ACCESS_KEY }} 
+        run: |
+          python -m pip install awscli
+          aws configure set aws_access_key_id $ACCESS_KEY
+          aws configure set aws_secret_access_key $SECRET_ACCESS_KEY
+          aws configure set region us-west-1
+          aws configure set output json
+      - name: Build the docker stack
+        run: |
+          docker login -u AWS -p $(aws ecr get-login-password --region us-east-1) 292282985366.dkr.ecr.us-east-1.amazonaws.com
+          docker network create local_bridge
+          docker build -t amazon-braket-oq-dev .
+          docker-compose up -d
       - name: Run tests
         run: |
           source env/bin/activate
           ipython kernel install --name "env" --user
-          python -m pytest -v -m 'not (qpu or api or docker_aws)' --cov --cov-report=xml:coverage.xml
-          
+          pytest tests/ -m 'not (qpu or sim)' --cov --cov-report=xml:coverage.xml
+
       - name: Upload coverage reports to Codecov with GitHub Action
         uses: codecov/codecov-action@v3
         with:
@@ -71,6 +73,7 @@ jobs:
 
   docs:
     runs-on: ubuntu-latest
+    if : github.event.pull_request.draft == false &&  github.event.pull_request.head.repo.fork == false
     steps:
       - name: Check out openqaoa
         uses: actions/checkout@v3

.github/workflows/test_dev_ext.yml

@@ -0,0 +1,98 @@
+name: test_dev_ext
+
+# Controls when the workflow will run
+on:
+  pull_request:
+    branches:
+    - dev
+  # Manual trigger
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  test-dev-ext:
+    runs-on: ubuntu-latest
+    if : ${{ github.event.pull_request.head.repo.fork == true }}
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: 3.8
+      - name: Install qvm
+        run: |
+          find /usr/lib -name "libffi.so*"
+          sudo ln -s /usr/lib/x86_64-linux-gnu/libffi.so /usr/lib/x86_64-linux-gnu/libffi.so.6
+          wget -q https://downloads.rigetti.com/qcs-sdk/forest-sdk-2.23.0-linux-deb.tar.bz2
+          tar -xf forest-sdk-2.23.0-linux-deb.tar.bz2
+          cd forest-sdk-2.23.0-linux-deb/
+          sudo apt-get update
+          sudo apt-get install -y screen libblas-dev libblas3 libgfortran5 liblapack-dev liblapack3
+          sudo ./forest-sdk-2.23.0-linux-deb.run
+          qvm --version
+          quilc --version
+          echo "Starting qvm and quilc"
+          screen -d -m qvm -S
+          screen -d -m quilc -S
+          cd ..
+      - name: Install OpenQAOA
+        run: |
+          python -m pip install --user virtualenv
+          python -m venv env
+          source env/bin/activate
+          python -m pip install --upgrade pip
+          pip install .[tests]
+          pip install ipykernel
+      - name: Run tests
+        run: |
+          source env/bin/activate
+          ipython kernel install --name "env" --user
+          pytest tests/ -v -m 'not (qpu or docker_aws or api or sim or braket_api)'
+
+  docs-ext:
+    runs-on: ubuntu-latest
+    if : github.event.pull_request.draft == false && github.event.pull_request.head.repo.fork == true
+    steps:
+      - name: Check out openqaoa
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: 3.8
+
+      - name: Install OpenQAOA
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[docs]
+
+      - name: Install qvm
+        run: |
+          find /usr/lib -name "libffi.so*"
+          sudo ln -s /usr/lib/x86_64-linux-gnu/libffi.so /usr/lib/x86_64-linux-gnu/libffi.so.6
+          wget -q https://downloads.rigetti.com/qcs-sdk/forest-sdk-2.23.0-linux-deb.tar.bz2
+          tar -xf forest-sdk-2.23.0-linux-deb.tar.bz2
+          cd forest-sdk-2.23.0-linux-deb/
+          sudo apt-get update
+          sudo apt-get install -y screen libblas-dev libblas3 libgfortran5 liblapack-dev liblapack3
+          sudo ./forest-sdk-2.23.0-linux-deb.run
+          qvm --version
+          quilc --version
+          echo "Starting qvm and quilc"
+          screen -d -m qvm -S
+          screen -d -m quilc -S
+          cd ..
+
+      - name: Build and test Sphinx docs
+        run: |
+          sudo apt-get install pandoc
+          mkdir ./docs/source/notebooks
+          cp ./examples/*.ipynb ./docs/source/notebooks/
+          cd docs/
+          make html SPHINXOPTS="-W --keep-going"

.github/workflows/test_main_linux.yml

@@ -19,16 +19,19 @@ jobs:
     # The type of runner that the job will run on
     runs-on:  ${{ matrix.os }}
 
-    # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
       - uses: actions/checkout@v3
         with:
           ref: ${{ github.event.pull_request.head.sha }}
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v3
         with:
           python-version: ${{ matrix.python }}
-
+      - name: Log in with Azure
+        uses: azure/login@v1
+        with:
+          creds: '${{ secrets.AZURE_CREDENTIALS }}'
       - name: Install OpenQAOA
         run: |
           python -m pip install --user virtualenv
@@ -37,37 +40,42 @@ jobs:
           python -m pip install --upgrade pip
           pip install .[tests]
           pip install ipykernel
-             
-      - name: QVM on ubuntu
-        if: ${{ matrix.os=='ubuntu-latest' }} 
+      - name: Setup IBMQ account
+        env:
+          IBMQ_TOKEN: ${{ secrets.IBMQ_TOKEN }} 
         run: |
-          find /usr/lib -name "libffi.so*"
-          sudo ln -s /usr/lib/x86_64-linux-gnu/libffi.so /usr/lib/x86_64-linux-gnu/libffi.so.6
-          wget -q https://downloads.rigetti.com/qcs-sdk/forest-sdk-2.23.0-linux-deb.tar.bz2
-          tar -xf forest-sdk-2.23.0-linux-deb.tar.bz2
-          cd forest-sdk-2.23.0-linux-deb/
-          sudo apt-get update
-          sudo apt-get install -y screen libblas-dev libblas3 libgfortran5 liblapack-dev liblapack3
-          sudo ./forest-sdk-2.23.0-linux-deb.run
-          qvm --version
-          quilc --version
-          echo "Starting qvm and quilc"
-          screen -d -m qvm -S
-          screen -d -m quilc -S
-          cd ..
-
+          IBMQ_TOKEN=$IBMQ_TOKEN
+          source env/bin/activate
+          python -c'from qiskit_ibm_provider import IBMProvider; import os; IBMProvider.save_account(os.environ.get("IBMQ_TOKEN"))'
+      - name: Setup AWS
+        env:
+          ACCESS_KEY: ${{ secrets.ACCESS_KEY }} 
+          SECRET_ACCESS_KEY: ${{ secrets.SECRET_ACCESS_KEY }} 
+        run: |
+          python -m pip install awscli
+          aws configure set aws_access_key_id $ACCESS_KEY
+          aws configure set aws_secret_access_key $SECRET_ACCESS_KEY
+          aws configure set region us-west-1
+          aws configure set output json
+      - name: Build the docker stack
+        run: |
+          docker login -u AWS -p $(aws ecr get-login-password --region us-east-1) 292282985366.dkr.ecr.us-east-1.amazonaws.com
+          docker network create local_bridge
+          docker build -t amazon-braket-oq-dev .
+          docker-compose up -d
       - name: Run tests
         run: |
           source env/bin/activate
           ipython kernel install --name "env" --user
-          python -m pytest -v -m 'not (qpu or api or docker_aws)' 
+          pytest tests/ -m 'not (qpu or sim)' --cov --cov-report=xml:coverage.xml
 
       - name: Upload coverage reports to Codecov with GitHub Action
         uses: codecov/codecov-action@v3
         with:
           token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
           files: ./coverage.xml
 
+
   docs:
     runs-on: ubuntu-latest
     steps:

.github/workflows/test_main_macos.yml

@@ -56,4 +56,4 @@ jobs:
         run: |
           source env/bin/activate
           ipython kernel install --user --name "env"
-          python -m pytest -v -m 'not (qpu or api or docker_aws)'
+          pytest tests/ -m 'not (qpu or api or docker_aws or braket_api or sim)'

.github/workflows/test_main_windows.yml

@@ -57,15 +57,10 @@ jobs:
           Start-Process -FilePath "C:\Program Files\Rigetti Computing\Forest SDK for Windows\quilc.exe" -ArgumentList "-S" -PassThru
           Start-Process -FilePath "C:\Program Files\Rigetti Computing\Forest SDK for Windows\qvm.exe" -ArgumentList "-S" -PassThru
 
-      # Run all tests and compute coverage reports
+      # Run all tests 
       - name: Run tests
-        env:
-          IBMQ_TOKEN: ${{ secrets.IBMQ_TOKEN }}
-          IBMQ_HUB: ibm-q
-          IBMQ_GROUP: open
-          IBMQ_PROJECT: main
         shell: pwsh
         run: |
           .\env\Scripts\Activate.ps1
           ipython kernel install --name "env" --user
-          python -m pytest -v -m 'not (qpu or api or docker_aws)'
+          pytest tests/ -m 'not (qpu or api or docker_aws or braket_api or sim)'

Dockerfile

@@ -0,0 +1,8 @@
+# The dockerfile for OpenQAOA braket jobs
+FROM 292282985366.dkr.ecr.us-east-1.amazonaws.com/amazon-braket-pytorch-jobs:1.9.1-gpu-py38-cu111-ubuntu20.04
+
+RUN mkdir -p /openqaoa
+
+ADD ./ /openqaoa/
+
+RUN pip3 install /openqaoa/.

README.md

@@ -29,26 +29,31 @@ Check out OpenQAOA website [https://openqaoa.entropicalabs.com/](https://openqao
 
 ## Installation instructions
 
-You can install the latest version of OpenQAOA directly from PyPi. First, create a virtual environment with python3.8+ and then simply pip install openqaoa with the following command
+You can install the latest version of OpenQAOA directly from PyPI. First, create a virtual environment with python3.8, 3.9, 3.10 and then pip install openqaoa with the following command
 
-```bash
+```
 pip install openqaoa
 ```
 
 Alternatively, you can install manually directly from the GitHub repository by
 
 1. Clone the git repository:
 
-```bash
-git clone [email protected]:entropicalabs/openqaoa.git
 ```
+git clone https://github.com/entropicalabs/openqaoa.git
+```
+
+2. Creating a python `virtual environment` for this project is recommended. (for instance, using conda). Instructions on how to create a virtual environment can be found [here](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-with-commands). Make sure to use **python 3.8** (or newer) for the environment.
 
-2. Creating a python `virtual environment` for this project is recommended. (for instance, using conda). Instructions on how to create a virtual environment can be found [here](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-with-commands). Make sure to use **python 3.8** for the environment.
+3. After cloning the repository `cd openqaoa` and pip install the package. 
 
-3. After cloning the repository `cd openqaoa` and pip install in edit mode. Use the following command for a vanilla install with the `scipy` optimizers:
+```
+pip install .
+```
+If you are interested in running the tests or the docs you can do so my using the installment modifiers `[docs]` and `[tests]`. For example,
 
-```bash
-pip install -e .
+```
+pip install .[tests]
 ```
 
 Should you face any issue during the installation, please drop us an email at [email protected] or open an issue!
@@ -83,18 +88,19 @@ Devices are serviced both locally and on the cloud. For the IBM Quantum experien
 | [Amazon Braket](https://docs.aws.amazon.com/braket/latest/developerguide/braket-devices.html)    | IonQ, Rigetti, OQC, and simulators |
 | [IBMQ](https://quantum-computing.ibm.com/)    | Please check the IBMQ backends available to your account |
 | [Rigetti QCS](https://qcs.rigetti.com/sign-in)     | Aspen-11, Aspen-M-1, and QVM simulator |
+| [Azure](https://azure.microsoft.com/en-us/products/quantum) | IonQ, Quantinuum, Rigetti, QCI |
 
 
 ## Running the tests
 
 To run the test, first, make sure to have installed all the optional testing dependencies by running `pip install .[tests]` (note, the braket must to be escaped if you are using the popular zsh shell), and then just type `pytest tests/.` from the project's root folder.
 
-> :warning: **Some tests require authentication**: all tests flagged `api` or `qpu` require valid qpu crendentials to be specified in `tests/credentials.json`
+> :warning: **Some tests require authentication**: Please, check the flags in `pytest.ini`. Currently these testes are marked `qpu`, `api`, `docker_aws`, `braket_api`, `sim`
 
-> :warning: **Some tests require authentication**: Please, note that the PyQuil-Rigetti tests contained in `test_pyquil_qvm.py` requires an active `qvm` (see Rigetti's documentation [here](https://pyquil-docs.rigetti.com/en/v3.1.0/qvm.html))
+> :warning: **Some tests require Rigetti's QVM or a valid AWS Jobs docker**: Please, note these tests are marked as `qvm` and `docker_aws` (see Rigetti's documentation [here](https://pyquil-docs.rigetti.com/en/v3.1.0/qvm.html) for more information).
 
 ## Contributing and feedback
 
 If you find any bugs or errors, have feature requests, or code you would like to contribute, feel free to open an issue or send us a pull request on GitHub.
 
-We are always interested to hear about projects built with EntropicaQAOA. If you have an application you'd like to tell us about, drop us an email at [email protected].
+We are always interested to hear about projects built with EntropicaQAOA. If you have an application you'd like to tell us about, drop us an email at [[email protected]](mailto:[email protected])