Merge pull request #643 from int-brain-lab/iblrigv8dev

8.19.0

.github/workflows/main.yaml

@@ -6,13 +6,25 @@ on:
     paths-ignore:
       - 'docs/**'
   pull_request:
-    branches: [iblrigv8]
     paths-ignore:
       - 'docs/**'
 
 jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: chartboost/ruff-action@v1
+        name: ruff check
+        with:
+          args: 'check --output-format=github'
+      - uses: chartboost/ruff-action@v1
+        name: ruff format
+        with:
+          args: 'format --check'
   tests:
     name: build (${{ matrix.python-version }}, ${{ matrix.os }})
+    needs: ruff
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
@@ -31,12 +43,6 @@ jobs:
           cache: 'pip'
           cache-dependency-path: 'pyproject.toml'
 
-      - name: flake8
-        run: |
-          pip install --upgrade pip
-          pip install flake8 --quiet
-          python -m flake8
-
       - name: install requirements
         shell: bash -l {0}
         run: |
@@ -69,7 +75,7 @@ jobs:
           path: requirements_frozen.txt
 
   finish:
-    needs: tests
+    needs: [ruff, tests]
     if: ${{ always() }}
     runs-on: ubuntu-latest
     steps:

.pre-commit-config.yaml

@@ -23,7 +23,8 @@ repos:
     -   id: python-no-log-warn
     -   id: text-unicode-replacement-char
 
--   repo: https://github.com/pycqa/flake8
-    rev: 6.1.0
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.5
     hooks:
-    -   id: flake8
+    -   id: ruff
+    -   id: ruff-format

CHANGELOG.md

@@ -2,6 +2,17 @@ Changelog
 ---------
 
 
+8.19.0
+------
+* automated validation of rig components
+* adaptive reward parameter for trainingPhaseChoiceWorld
+* add validate_video entry-point
+* switch from flake8 to ruff for linting & code-checks
+* automatically set correct trigger-mode when setting up the cameras
+* support rotary encoder on arbitrary module port
+* add ambient sensor reading back to trial log
+* allow negative stimulus gain (reverse wheel contingency)
+
 8.18.0
 ------
 * valve calibration routine

docs/source/faq.rst

@@ -9,13 +9,13 @@ First Aid
 
 If your rig is acting up:
 
-*  Employ the **automated test-script** bundled with IBLRIG. This script helps identify common issues.
+*  Employ the **automated test-script** bundled with IBLRIG. This script helps identify common configuration issues.
    Execute it using PowerShell:
 
    .. code:: powershell
 
       C:\iblrigv8\venv\scripts\Activate.ps1
-      python C:\iblrigv8\scripts\hardware_validation\verify_hardware.py
+      validate_iblrig
 
 *  Check `the comprehensive user manual <https://doi.org/10.6084/m9.figshare.11634732.v6>`__ ("Appendix 3" on GoogleDrive).
    Verify if all connections are secure, and configurations align with the manual's guidelines.

docs/source/installation.rst

@@ -126,7 +126,15 @@ Installing iblrigv8
       pip install -e .
 
 
-4. Install Bonsai in portable mode:
+4. Install Spinnaker SDK and PySpin:
+
+   .. code-block:: powershell
+
+      install_spinnaker
+      install_pyspin
+
+
+5. Install Bonsai in portable mode:
 
    .. code-block:: powershell
 
@@ -135,7 +143,7 @@ Installing iblrigv8
       cd ..
 
 
-5. Install additional tasks and extractors for personal projects (optional):
+6. Install additional tasks and extractors for personal projects (optional):
 
    .. code-block:: powershell
 
@@ -144,7 +152,7 @@ Installing iblrigv8
       pip install -e .
 
 
-6. Continue with :ref:`the next section<Configuration instructions>`.
+7. Continue with :ref:`the next section<Configuration instructions>`.
 
 
 Configuration Instructions

docs/source/reference_developer_guide.rst

@@ -49,7 +49,8 @@ Running Tests Locally
 
 .. code-block:: console
 
-   flake8
+   ruff check .
+   ruff format .
    python -m unittest discover ./iblrig/test
 
 

iblrig/__init__.py

@@ -6,7 +6,7 @@
 # 5) git tag the release in accordance to the version number below (after merge!)
 # >>> git tag 8.15.6
 # >>> git push origin --tags
-__version__ = '8.18.0'
+__version__ = '8.19.0'
 
 
 from iblrig.version_management import get_detailed_version_string