Merge image_v3.1 into master for v3.1 release

Author: grahams

.github/workflows/python-package.yml

@@ -13,18 +13,18 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.8', '3.9', '3.10']
+        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install flake8 pytest pyfakefs==4.5.6 pytest-cov pytest-asyncio codecov
+        pip install flake8 pytest pyfakefs==5.8.0 pytest-cov pytest-asyncio codecov
         # Install required dependencies for pynq since we import it in setup.py
         pip install numpy cffi ipython
         # Install PYNQ-Utils and PYNQ-Metadata
@@ -34,7 +34,7 @@ jobs:
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names
-        flake8 pynq --count --select=E9,F63,F7,F82 --show-source --statistics
+        flake8 pynq --count --select=E9,F63,F7,F82 --show-source --statistics --ignore=F824
         # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
         flake8 pynq --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
     - name: Install PYNQ
@@ -44,14 +44,14 @@ jobs:
       run: |
         pytest --doctest-modules --junitxml=junit/test-results-${{ matrix.python-version }}.xml
     - name: Upload pytest test results
-      uses: actions/upload-artifact@v1
+      uses: actions/upload-artifact@v4
       with:
         name: pytest-results-${{ matrix.python-version }}
         path: junit/test-results-${{ matrix.python-version }}.xml
       # Use always() to always run this step to publish test results when there are test failures
       if: ${{ always() }}
     - name: Upload coverage
-      uses: codecov/codecov-action@v1
+      uses: codecov/codecov-action@v5
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
 

.gitignore

@@ -47,3 +47,10 @@ __pycache__/
 ######################
 GNUmakefile
 user.props
+
+# Miscellaneous
+######################
+.vscode/
+.venv/
+*.egg-info/
+.coverage

.readthedocs.yml

@@ -7,9 +7,9 @@ version: 2
 
 # Set the version of Python and other tools you might need
 build:
-  os: ubuntu-20.04
+  os: ubuntu-22.04
   tools:
-    python: "3.9"
+    python: "3.10"
     # You can also specify other tool versions:
     # nodejs: "16"
     # rust: "1.55"

README.md

@@ -43,20 +43,6 @@ All board related files including Vivado projects, bitstreams, and example noteb
 
 In Linux, you can rebuild the overlay by running *make* in the corresponding overlay folder (e.g. `/boards/Pynq-Z1/base`). In Windows, you need to source the appropriate tcl files in the corresponding overlay folder.
 
-## Alveo support
-
-Starting from PYNQ version `2.5.1`, Alveo support has also been introduced. It is now possible to use PYNQ to tap into the potential of hardware acceleration in the data center space.
-
-To get PYNQ on an Alveo-enabled system, simply install it through PIP:
-
-```console
-pip install pynq
-```
-
-For Alveo cards, PYNQ currently requires a <a href="https://github.com/Xilinx/XRT" target="_blank">Xilinx Runtime (XRT)</a> version above or equal to `2.3` to be installed in the system. In terms of Operating System, any XRT-supported version of either RedHat/CentOS or Ubuntu can be used.
-
-For more information, please see the Alveo <a href="https://pynq.readthedocs.io/en/latest/getting_started/alveo_getting_started.html" target="_blank">getting started guide</a>.
-
 ## Contribute
 
 Contributions to this repository are welcomed. Please refer to <a href="https://github.com/Xilinx/PYNQ/blob/master/CONTRIBUTING.md" target="_blank">CONTRIBUTING.md</a>