Merge pull request #55 from ChitambarLab/update-qnetvo-version

updating pennylane version

Author: bdoolittle

.github/workflows/build_documentation.yml

@@ -7,10 +7,23 @@ jobs:
   docs:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v1
-    - uses: ammaraskar/sphinx-action@master
+    - name: Cancel Previous Runs
+      uses: styfle/cancel-workflow-action@0.4.1
       with:
-        docs-folder: "docs/"
+        access_token: ${{ github.token }}
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.11
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install .
+        pip install -r docs/requirements.txt
+    - name: Build Documentation
+      run: |
+        sphinx-build -b html docs/source/ docs/build/html
     - name: Commit documentation changes
       run: |
         git clone https://github.com/ChitambarLab/qNetVO.git --branch gh-pages --single-branch gh-pages

.github/workflows/check_documentation.yml

@@ -7,7 +7,16 @@ jobs:
   docs:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v1
-    - uses: ammaraskar/sphinx-action@master
-      with:
-        docs-folder: "docs/"
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.11
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .
+          pip install -r docs/requirements.txt
+      - name: Build Documentation
+        run: |
+          sphinx-build -b html docs/source/ docs/build/html

.github/workflows/formatting_check.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v2
         with:
-          python-version: 3.8
+          python-version: 3.11
 
       - name: Install dependencies
         run: pip install black

.github/workflows/run_tests.yml

@@ -27,10 +27,10 @@ jobs:
 
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
       - uses: actions/checkout@v2
-      - name: Set up Python 3.8
+      - name: Set up Python 3.11
         uses: actions/setup-python@v2
         with:
-          python-version: 3.8
+          python-version: 3.11
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip

README.md

@@ -1,4 +1,4 @@
-# qNetVO: The Quantum Network Variational Optimizer
+# qNetVO: Quantum Network Variational Optimizer
 
 *Simulate and optimize quantum communication networks using quantum computers.*
 
@@ -32,7 +32,7 @@ $ pip install qnetvo
 Install PennyLane:
 
 ```
-$ pip install pennylane==0.33
+$ pip install pennylane==0.37
 ```
 
 Import packages:
@@ -48,7 +48,7 @@ Note
 </p>
 <p>
 For optimal use, qNetVO should be used with PennyLane.
-QNetVO is currently compatible with PennyLane v0.33.
+QNetVO is currently compatible with PennyLane v0.37.
 </p>
 </div>
 

docs/requirements.txt

@@ -1,7 +1,7 @@
 .
-sphinx>=3.0
+sphinx
 Pygments>=2.7.4
-m2r2==0.3.3
-sphinxcontrib-email==0.3.5
+sphinx-mdinclude>=0.6
+sphinxcontrib-email==0.3.6
 furo
-pennylane==0.28
+pennylane==0.37

docs/source/conf.py

@@ -39,7 +39,7 @@
     "sphinx.ext.mathjax",
     "sphinx.ext.napoleon",
     "sphinx.ext.viewcode",
-    "m2r2",
+    "sphinx_mdinclude",
     "sphinxcontrib.email",
 ]
 source_suffix = [".rst", ".md"]

environment.yml

@@ -3,14 +3,12 @@ channels:
   - defaults
 dependencies:
   - python=3.11
-  - black
   - sphinx
+  - black
   - pytest
   - notebook
   - matplotlib
   - pip
   - pip:
     - -r requirements.txt
-    - furo
-    - m2r2==0.3
-    - sphinxcontrib-email==0.3.5
+    - -r docs/requirements.txt

requirements.txt

@@ -1,7 +1,7 @@
-pennylane~=0.33
-qiskit==0.34
-pennylane-qiskit==0.20
+pennylane==0.37
+qiskit>=1
+pennylane-qiskit==0.37
 tensorflow>=2.0,<3.0
 dask[delayed]==2022.5
 tensornetwork>=0.3,<0.4
-flaky==3.7
+pytest-rerunfailures

setup.cfg

@@ -18,9 +18,9 @@ classifiers =
 package_dir =
     = src
 packages = find:
-python_requires = >=3.8
+python_requires = >=3.9
 install_requires =
-    pennylane~=0.33
+    pennylane==0.37
 
 [options.packages.find]
 where = src