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

v8.22.1

.github/workflows/documentation.yaml

@@ -1,15 +1,15 @@
 name: Docs
 on:
   workflow_dispatch:
-    paths:
-      - '.github/workflows/documentation.yaml'
-      - 'docs/**'
   push:
     branches:
       - iblrigv8
     paths:
       - '.github/workflows/documentation.yaml'
       - 'docs/**'
+      - 'CHANGELOG.md'
+      - 'README.md'
+      - 'pyproject.toml'
 permissions:
     contents: write
 jobs:

.github/workflows/main.yaml

@@ -1,6 +1,7 @@
-name: iblrigv8 CI
+name: CI
 
 on:
+  workflow_dispatch:
   push:
     branches: [iblrigv8]
     paths-ignore:
@@ -41,7 +42,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
           cache: true
       - name: Install requirements
-        run: pdm sync -dG test
+        run: pdm sync -G project-extraction -dG test -dG ci
       - name: Install audio library (Ubuntu only)
         if: matrix.os == 'ubuntu-latest'
         run: sudo apt-get install -y libportaudio2

.pre-commit-config.yaml

@@ -13,10 +13,12 @@ repos:
     -   id: check-xml
 
 -   repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.5.1
+    rev: v0.5.7
     hooks:
     -   id: ruff
         types_or: [ python, pyi ]
-        args: [ --fix ]
     -   id: ruff-format
         types_or: [ python, pyi ]
+
+default_language_version:
+    python: python3

README.md

@@ -1,14 +1,22 @@
-# iblrigv8
+IBLRIG
+======
 
-Welcome to the International Brain Laboratory decision making task implementation.
+Welcome to the International Brain Laboratory's decision-making task implementation.
 
-The task is implemented in the Bpod system (Sanworks) and uses the Bonsai visual programming language (on Windows) for the visual stimuli and Python for all other purposes.
+The task is implemented using the Bpod Finite State Machine ([SanWorks](https://sanworks.io/)) and uses [Bonsai](https://bonsai-rx.org/) visual programming language (on Windows) for the visual stimuli and [Python](https://www.python.org/) for all other purposes.
 
-> **Documentation and installation steps: [int-brain-lab.github.io/iblrig](https://int-brain-lab.github.io/iblrig)**
 
----
+Links
+-----
 
+* [Documentation and Installation Steps](https://int-brain-lab.github.io/iblrig)
+* [Standardized and reproducible measurement of decision-making in mice](https://doi.org/10.7554/eLife.63711)
+* [Appendix 3: IBL protocol for setting up the behavioral training rig](https://doi.org/10.6084/m9.figshare.11634732.v6)
+
+
+[![CI](https://github.com/int-brain-lab/iblrig/actions/workflows/main.yaml/badge.svg?branch=iblrigv8)](https://github.com/int-brain-lab/iblrig/actions/workflows/main.yaml?query=branch%3Aiblrigv8)
 [![Coverage Status](https://coveralls.io/repos/github/int-brain-lab/iblrig/badge.svg?branch=iblrigv8)](https://coveralls.io/github/int-brain-lab/iblrig?branch=iblrigv8)
-![License](https://img.shields.io/github/license/int-brain-lab/iblrig)
-![GitHub tag](https://img.shields.io/github/v/tag/int-brain-lab/iblrig)
+[![License](https://img.shields.io/github/license/int-brain-lab/iblrig)](https://github.com/int-brain-lab/iblrig/blob/iblrigv8/LICENSE)
+[![GitHub tag](https://img.shields.io/github/v/tag/int-brain-lab/iblrig)](https://github.com/int-brain-lab/iblrig/tags)
 [![GitHub Discussions](https://img.shields.io/github/discussions/int-brain-lab/iblrig)](https://github.com/int-brain-lab/iblrig/discussions)
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)