Fix dependency installation in python.yml GitHub Action (#656)

- Now GH action installs from the `requirements.txt` files used by tests and docs directly
- Also moves the logic that skips running the tutorial tests from the GH action to the test file itself (don't run for <3.12), to avoid any inconsistencies with GH actions PR vs Push vs running locally
- Removes the version pinning for doc and test requirements - this was actually preventing the installation of packages from working across Python versions, as the pinned package versions for earlier python versions were not always available. It was too stringent to pin these and I don't think there's much to be gained from having done so - if the latest versions of any of those packages do end up including changes that break our docs infrastructure, this will at worst mean that a docs build could fail, but that would be picked up in any PR and would not affect the current build. Might be worth discussing pinning of dependencies of `pygambit` itself in future though
- See comment below: The `paths-ignore` in the GitHub action yml was wrongly preventing some checks from running. I don't think it's a big problem to remove this completely, whilst PRs take a long time to run, we don't do docs PRs in high enough volume/speed for this to be too much of a problem
- Since Windows requires a specific manual installation of OpenSpiel, I have added a Warning that links to this in the How to run PyGambit tutorials on your computer and skipped running OpenSpiel notebook when running tests on Windows GH action. Also made a few other edits to this page whilst I was there.

Author: edwardchalstrey1

.github/ISSUE_TEMPLATE/tutorial_request.yml

@@ -32,4 +32,4 @@ body:
       description: Add links to any research papers or other resources the author will need to write this tutorial.
       value: "`[Markdown link text](url)`"
     validations:
-      required: false
+      required: false

.github/workflows/lint.yml

@@ -2,15 +2,7 @@ name: Linters and coding standards checks
 
 on:
   push:
-    paths-ignore:
-      - 'doc/**'
-      - '.github/ISSUE_TEMPLATE/**'
-      - 'README.md'
   pull_request:
-    paths-ignore:
-      - 'doc/**'
-      - '.github/ISSUE_TEMPLATE/**'
-      - 'README.md'
 
 jobs:
   clang-format:

.github/workflows/osxbinary.yml

@@ -2,10 +2,6 @@ name: MacOS static GUI binary
 
 on:
   push:
-    paths-ignore:
-      - 'doc/**'
-      - '.github/ISSUE_TEMPLATE/**'
-      - 'README.md'
     tags:
       - 'v*'
   schedule:

.github/workflows/python.yml

@@ -2,15 +2,7 @@ name: pygambit Python extension
 
 on:
   push:
-    paths-ignore:
-      - 'doc/**'
-      - '.github/ISSUE_TEMPLATE/**'
-      - 'README.md'
   pull_request:
-    paths-ignore:
-      - 'doc/**'
-      - '.github/ISSUE_TEMPLATE/**'
-      - 'README.md'
 
 jobs:
   linux:
@@ -29,7 +21,9 @@ jobs:
       - name: Set up dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install setuptools build cython pytest pytest-skip-slow wheel lxml numpy scipy nbformat nbclient ipykernel
+          pip install setuptools build cython wheel
+          pip install -r tests/requirements.txt
+          pip install -r doc/requirements.txt
       - name: Build source distribution
         run:
           python -m build
@@ -38,13 +32,7 @@ jobs:
           cd dist
           pip install -v pygambit*.tar.gz
       - name: Run tests
-        run: |
-          if [ "${{ matrix.python-version }}" = "3.9" ]; then
-            # Python 3.9 on linux skips the notebook execution test (notebooks may require newer kernels/deps)
-            pytest -q -k 'not test_execute_notebook'
-          else
-            pytest
-          fi
+        run: pytest
 
   macos-13:
     runs-on: macos-13
@@ -62,7 +50,9 @@ jobs:
       - name: Set up dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install cython pytest pytest-skip-slow wheel lxml numpy scipy nbformat nbclient ipykernel
+          pip install setuptools build cython wheel
+          pip install -r tests/requirements.txt
+          pip install -r doc/requirements.txt
       - name: Build extension
         run: |
           python -m pip install -v .
@@ -85,7 +75,9 @@ jobs:
       - name: Set up dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install cython pytest pytest-skip-slow wheel lxml numpy scipy nbformat nbclient ipykernel
+          pip install setuptools build cython wheel
+          pip install -r tests/requirements.txt
+          pip install -r doc/requirements.txt
       - name: Build extension
         run: |
           python -m pip install -v .
@@ -108,7 +100,9 @@ jobs:
       - name: Set up dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install cython pytest pytest-skip-slow wheel lxml numpy scipy nbformat nbclient ipykernel
+          pip install setuptools build cython wheel
+          pip install -r tests/requirements.txt
+          pip install nbformat nbclient ipykernel jupyter matplotlib
       - name: Build extension
         run: |
           python -m pip install -v .

.github/workflows/tools.yml

@@ -2,15 +2,7 @@ name: Build executables
 
 on:
   push:
-    paths-ignore:
-      - 'doc/**'
-      - '.github/ISSUE_TEMPLATE/**'
-      - 'README.md'
   pull_request:
-    paths-ignore:
-      - 'doc/**'
-      - '.github/ISSUE_TEMPLATE/**'
-      - 'README.md'
 
 jobs:
   linux:

.github/workflows/wheels.yml

@@ -3,10 +3,6 @@ name: pygambit wheels
 
 on:
   push:
-    paths-ignore:
-      - 'doc/**'
-      - '.github/ISSUE_TEMPLATE/**'
-      - 'README.md'
     tags:
       - 'v*'
   schedule:

.gitignore

@@ -44,4 +44,4 @@ Gambit.app/*
 doc/tutorials/games/*.nfg
 doc/tutorials/games/*.efg
 *.dmg
-Gambit.app/*
+Gambit.app/*

doc/requirements.txt

@@ -1,12 +1,12 @@
-Cython==3.1.2
-numpy==2.3.2
-scipy==1.16.1
-pydata-sphinx-theme==0.16.1
-sphinx_design==0.6.1
-sphinx-autobuild==2024.10.3
-nbsphinx==0.9.7
-ipython==9.4.0
-matplotlib==3.10.5
-pickleshare==0.7.5
-jupyter==1.1.1
-open_spiel==1.6.9
+Cython
+numpy
+scipy
+pydata-sphinx-theme
+sphinx_design
+sphinx-autobuild
+nbsphinx
+ipython
+matplotlib
+pickleshare
+jupyter
+open_spiel

doc/tutorials/running_locally.rst

@@ -3,22 +3,34 @@
 How to run PyGambit tutorials on your computer
 ==============================================
 
-The PyGambit tutorials are available as Jupyter notebooks and can be run interactively using any program that supports Jupyter notebooks, such as JupyterLab or VSCode.
-You will need a working installation of Python 3.9+ on your machine to run PyGambit (however the tutorials contain some syntax that may not be compatible with earlier versions of Python than 3.13).
+Running the PyGambit tutorials on your machine requires some familiarity with the basics of Python and how to use Git & GitHub.
+The tutorials are available as Jupyter notebooks and can be run interactively using any program that supports Jupyter notebooks, such as JupyterLab or VSCode.
+
+.. tip:: Create a virtual environment with Python 3.13 or higher
 
 1. To download the tutorials, open your OS's command prompt and clone the Gambit repository from GitHub, then navigate to the tutorials directory: ::
 
     git clone https://github.com/gambitproject/gambit.git
-    cd gambit/doc
 
-2. Install `pygambit` and other requirements (including `JupyterLab` and other packages used by the tutorials). We recommend creating a new virtual environment and installing both the requirements there. e.g. ::
+2. Install `pygambit`:
+
+   * To install the latest release from PyPI::
+
+       pip install pygambit
+
+   * Alternatively, to install the latest development version::
 
-    python -m venv pygambit-env
-    source pygambit-env/bin/activate
-    pip install pygambit
+       pip install .
+
+3. Install other requirements (including `JupyterLab`) used by the tutorials ::
+
+    cd gambit/doc
     pip install -r requirements.txt
 
-3. Open `JupyterLab` and click on any of the tutorial notebooks (files ending in `.ipynb`) ::
+   .. warning::
+       Windows users will encounter an error when installing the requirements, which include the OpenSpiel library. Users wishing to run the OpenSpiel tutorial will need to install this manually; see the `OpenSpiel installation instructions <https://openspiel.readthedocs.io/en/latest/windows.html>`_ for details.
+
+4. Open `JupyterLab` and click on any of the tutorial notebooks (files ending in `.ipynb`) ::
 
     cd tutorials
     jupyter lab

tests/requirements.txt

@@ -1,4 +1,4 @@
-pytest==9.0.0
-nbformat==5.10.4
-nbclient==0.10.2
-ipykernel==6.30.1
+pytest
+nbformat
+nbclient
+ipykernel