Merge remote-tracking branch 'upstream/main' into nk

* upstream/main:
  ENH: Add encoding parameter to Nihon Kohden reader (mne-tools#13458)
  [MAINT] Automatic SPEC0 dependency version management (mne-tools#13451)

Author: larsoner

.github/workflows/spec_zero.yml

@@ -0,0 +1,62 @@
+name: SPEC0
+
+on:  # yamllint disable-line rule:truthy
+  schedule:
+    - cron: '0 0 * * 1'  # At 00:00 every Monday
+  workflow_dispatch:
+    inputs:
+      ssh:
+        description: 'Enable ssh debugging'
+        required: false
+        default: false
+        type: boolean
+
+jobs:
+  update_versions:
+    permissions:
+      contents: write
+      pull-requests: write
+    name: Update dependency versions
+    runs-on: ubuntu-latest
+    env:
+      GH_TOKEN: ${{ github.token }}
+      GITHUB_TOKEN: ${{ github.token }}
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          persist-credentials: true
+      - name: Triage SSH
+        run: |
+          if [[ "${{ inputs.ssh }}" == "true" ]] || [[ "$COMMIT_MESSAGE" == *"[actions ssh]"* ]]; then
+            echo "ENABLE_SSH=true" | tee -a $GITHUB_ENV
+          else
+            echo "ENABLE_SSH=false" | tee -a $GITHUB_ENV
+          fi
+      - name: Setup Remote SSH Connection
+        if: env.ENABLE_SSH == 'true'
+        uses: mxschmitt/action-tmate@v3
+        timeout-minutes: 10
+        with:
+          detached: true
+      - uses: actions/setup-python@v6
+        with:
+          python-version: '3.12'
+      - run: pip install packaging requests tomlkit
+      - run: python tools/dev/spec_zero_update_versions.py
+      - run: |
+          git diff && git status --porcelain
+          if [[ $(git status --porcelain) ]]; then
+            echo "dirty=true" >> $GITHUB_OUTPUT
+          fi
+        id: status
+      - name: Create PR
+        run: |
+          set -xeo pipefail
+          git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git config --global user.name "github-actions[bot]"
+          git checkout -b spec_zero
+          git commit -am "MAINT: Update dependency specifiers"
+          git push origin spec_zero
+          PR_NUM=$(gh pr create --base main --head spec_zero --title "MAINT: Update dependency specifiers" --body "Created by spec_zero [GitHub action](https://github.com/mne-tools/mne-python/actions/runs/${{ github.run_id }})." --label "no-changelog-entry-needed")
+          echo "Opened https://github.com/mne-tools/mne-python/pull/${PR_NUM}" >> $GITHUB_STEP_SUMMARY
+        if: steps.status.outputs.dirty == 'true'

.yamllint.yml

@@ -6,3 +6,5 @@ ignore: |
 rules:
   line-length: disable
   document-start: disable
+  new-lines:
+    type: platform

doc/changes/dev/13451.other.rst

@@ -0,0 +1 @@
+Add a SPEC0-like policy in which minimum-supported versions for select dependencies are set to the latest minor release that was available 2 years prior, by `Thomas Binns`_

doc/changes/dev/13458.apichange.rst

@@ -0,0 +1 @@
+Add ``encoding`` parameter to :func:`mne.io.read_raw_nihon` for better handling of annotation decoding, by `Tom Ma`_.

mne/io/nihon/nihon.py

@@ -23,7 +23,9 @@ def _ensure_path(fname):
 
 
 @fill_doc
-def read_raw_nihon(fname, preload=False, verbose=None) -> "RawNihon":
+def read_raw_nihon(
+    fname, preload=False, *, encoding="utf-8", verbose=None
+) -> "RawNihon":
     """Reader for an Nihon Kohden EEG file.
 
     Parameters
@@ -32,6 +34,9 @@ def read_raw_nihon(fname, preload=False, verbose=None) -> "RawNihon":
         Path to the Nihon Kohden data file (``.EEG``).
     preload : bool
         If True, all data are loaded at initialization.
+    %(encoding_nihon)s
+
+        .. versionadded:: 1.11
     %(verbose)s
 
     Returns
@@ -44,7 +49,7 @@ def read_raw_nihon(fname, preload=False, verbose=None) -> "RawNihon":
     --------
     mne.io.Raw : Documentation of attributes and methods of RawNihon.
     """
-    return RawNihon(fname, preload, verbose)
+    return RawNihon(fname, preload, encoding=encoding, verbose=verbose)
 
 
 _valid_headers = [
@@ -317,7 +322,7 @@ def _parse_sub_event_log(sub_event_log):
     return t_sub_desc, t_sub_onset
 
 
-def _read_nihon_annotations(fname):
+def _read_nihon_annotations(fname, encoding="utf-8"):
     fname = _ensure_path(fname)
     log_fname = fname.with_suffix(".LOG")
     if not log_fname.exists():
@@ -348,15 +353,10 @@ def _read_nihon_annotations(fname):
                     t_onset += t_sub_onset
 
                 t_desc = t_desc.rstrip(b"\x00")
-                for enc in _encodings:
-                    try:
-                        t_desc = t_desc.decode(enc)
-                    except UnicodeDecodeError:
-                        pass
-                    else:
-                        break
-                else:
-                    warn(f"Could not decode log as one of {_encodings}")
+                try:
+                    t_desc = t_desc.decode(encoding)
+                except UnicodeDecodeError:
+                    warn(f"Could not decode log as {encoding}")
                     continue
 
                 all_onsets.append(t_onset)
@@ -416,6 +416,9 @@ class RawNihon(BaseRaw):
         Path to the Nihon Kohden data ``.eeg`` file.
     preload : bool
         If True, all data are loaded at initialization.
+    %(encoding_nihon)s
+
+        .. versionadded:: 1.11
     %(verbose)s
 
     See Also
@@ -424,7 +427,7 @@ class RawNihon(BaseRaw):
     """
 
     @verbose
-    def __init__(self, fname, preload=False, verbose=None):
+    def __init__(self, fname, preload=False, *, encoding="utf-8", verbose=None):
         fname = _check_fname(fname, "read", True, "fname")
         data_name = fname.name
         logger.info(f"Loading {data_name}")
@@ -470,7 +473,7 @@ def __init__(self, fname, preload=False, verbose=None):
         )
 
         # Get annotations from LOG file
-        annots = _read_nihon_annotations(fname)
+        annots = _read_nihon_annotations(fname, encoding)
 
         # Annotate acquisition skips
         controlblock = header["controlblocks"][0]

mne/utils/docs.py

@@ -1285,6 +1285,11 @@ def _reflow_param_docstring(docstring, has_first_line=True, width=75):
     encoding according to the EDF+ standard).
 """
 
+docdict["encoding_nihon"] = """
+encoding : str
+    Text encoding of Nihon Kohden annotations. See :ref:`standard-encodings`.
+"""
+
 docdict["encoding_nirx"] = """
 encoding : str
     Text encoding of the NIRX header file. See :ref:`standard-encodings`.

pyproject.toml

@@ -111,7 +111,7 @@ full-no-qt = [
   "nibabel",
   "nilearn",
   "numba",
-  "openmeeg >= 2.5.7",  # released: 2023/11/16
+  "openmeeg >= 2.5.7",
   "pandas >= 2.1",  # released: 2023/08/30
   "pillow",  # for `Brain.save_image` and `mne.Report`
   "pyarrow",  # only needed to avoid a deprecation warning in pandas