FIX: Fixes

Author: larsoner

examples/io/read_bci2k.py

@@ -6,7 +6,7 @@
 In this example, we use MNE-Python to read a BCI2000 ``.dat`` file.
 BCI2000 is a general-purpose brain-computer interface (BCI) system widely
 used in EEG research. The file is downloaded from the MNE testing data
-repository using :mod:`pooch`.
+repository using ``pooch``.
 
 """  # noqa: D205 D400
 

mne/datasets/config.py

@@ -87,7 +87,7 @@
 # update the checksum in the MNE_DATASETS dict below, and change version
 # here: ↓↓↓↓↓↓↓↓
 RELEASES = dict(
-    testing="0.172",
+    testing="0.173",
     misc="0.27",
     phantom_kit="0.2",
     ucl_opm_auditory="0.2",
@@ -115,7 +115,7 @@
 # Testing and misc are at the top as they're updated most often
 MNE_DATASETS["testing"] = dict(
     archive_name=f"{TESTING_VERSIONED}.tar.gz",
-    hash="md5:9d031f1a91d2bd903a9464ca2cd7dc09",
+    hash="md5:0973c25cd0e3ca43a75ea6953ace1daa",
     url=(
         "https://codeload.github.com/mne-tools/mne-testing-data/"
         f"tar.gz/{RELEASES['testing']}"

mne/io/_read_raw.py

@@ -26,6 +26,7 @@ def _get_supported():
     from . import (
         read_raw_ant,
         read_raw_artemis123,
+        read_raw_bci2k,
         read_raw_bdf,
         read_raw_boxy,
         read_raw_brainvision,
@@ -79,7 +80,10 @@ def _get_supported():
         ".ds": dict(CTF=read_raw_ctf),
         ".txt": dict(BOXY=read_raw_boxy),
         # Curry
-        ".dat": dict(CURRY=read_raw_curry),
+        ".dat": dict(
+            CURRY=read_raw_curry,
+            BCI2K=read_raw_bci2k,
+        ),
         ".dap": dict(CURRY=read_raw_curry),
         ".rs3": dict(CURRY=read_raw_curry),
         ".cdt": dict(CURRY=read_raw_curry),
@@ -130,6 +134,7 @@ def read_raw(fname, *, preload=False, verbose=None, **kwargs) -> BaseRaw:
 
     * `~mne.io.read_raw_ant`
     * `~mne.io.read_raw_artemis123`
+    * `~mne.io.read_raw_bci2k`
     * `~mne.io.read_raw_bdf`
     * `~mne.io.read_raw_boxy`
     * `~mne.io.read_raw_brainvision`

mne/io/tests/test_read_raw.py

@@ -15,6 +15,7 @@
 
 base = Path(__file__).parents[1]
 test_base = Path(testing.data_path(download=False))
+bci2k_fname = test_base / "BCI2k" / "bci2k_test.dat"
 
 
 @pytest.mark.parametrize("fname", ["x.xxx", "x"])
@@ -129,7 +130,7 @@ def test_all_reader_documented():
     missing_from_doc = set(functions) - set(reader_lines)
     if len(missing_from_doc) != 0 or len(missing_from_read_raw) != 0:
         raise AssertionError(
-            "Functions missing from documentation:\n\t"
+            "Functions missing from documentation of mne.io.read_raw:\n\t"
             + "\n\t".join(missing_from_doc)
             + "\n\nFunctions missing from read_raw:\n\t"
             + "\n\t".join(missing_from_read_raw)
@@ -156,3 +157,9 @@ def test_all_reader_documented_in_docstring():
         )
     if sorted(documented) != documented:
         raise AssertionError("Functions in docstring are not sorted.")
+
+
+def test_bci2k():
+    """Test reading BCI2k files with read_raw."""
+    raw = read_raw(bci2k_fname, preload=True)
+    assert "RawBCI2k" in repr(raw)