eegdash 0.4.0.dev132__py3-none-any.whl → 0.4.0.dev150__py3-none-any.whl

eegdash/__init__.py

@@ -1,3 +1,14 @@
+# Authors: The EEGDash contributors.
+# License: GNU General Public License
+# Copyright the EEGDash contributors.
+
+"""EEGDash: A comprehensive platform for EEG data management and analysis.
+
+EEGDash provides a unified interface for accessing, querying, and analyzing large-scale
+EEG datasets. It integrates with cloud storage, MongoDB databases, and machine learning
+frameworks to streamline EEG research workflows.
+"""
+
 from .api import EEGDash, EEGDashDataset
 from .dataset import EEGChallengeDataset
 from .hbn import preprocessing
@@ -7,4 +18,4 @@ _init_mongo_client()
 
 __all__ = ["EEGDash", "EEGDashDataset", "EEGChallengeDataset", "preprocessing"]
 
-__version__ = "0.4.0.dev132"
+__version__ = "0.4.0.dev150"

eegdash/api.py

@@ -1,14 +1,23 @@
+# Authors: The EEGDash contributors.
+# License: GNU General Public License
+# Copyright the EEGDash contributors.
+
+"""High-level interface to the EEGDash metadata database.
+
+This module provides the main EEGDash class which serves as the primary entry point for
+interacting with the EEGDash ecosystem. It offers methods to query, insert, and update
+metadata records stored in the EEGDash MongoDB database, and includes utilities to load
+EEG data from S3 for matched records.
+"""
+
 import os
 from pathlib import Path
 from typing import Any, Mapping
 
 import mne
-import numpy as np
-import xarray as xr
 from docstring_inheritance import NumpyDocstringInheritanceInitMeta
 from dotenv import load_dotenv
-from joblib import Parallel, delayed
-from mne_bids import find_matching_paths, get_bids_path_from_fname, read_raw_bids
+from mne_bids import find_matching_paths
 from pymongo import InsertOne, UpdateOne
 from rich.console import Console
 from rich.panel import Panel
@@ -316,38 +325,6 @@ class EEGDash:
                         f"Conflicting constraints for '{key}': disjoint sets {r_val!r} and {k_val!r}"
                     )
 
-    def load_eeg_data_from_bids_file(self, bids_file: str) -> xr.DataArray:
-        """Load EEG data from a local BIDS-formatted file.
-
-        Parameters
-        ----------
-        bids_file : str
-            Path to a BIDS-compliant EEG file (e.g., ``*_eeg.edf``, ``*_eeg.bdf``,
-            ``*_eeg.vhdr``, ``*_eeg.set``).
-
-        Returns
-        -------
-        xr.DataArray
-            EEG data with dimensions ``("channel", "time")``.
-
-        """
-        bids_path = get_bids_path_from_fname(bids_file, verbose=False)
-        raw_object = read_raw_bids(bids_path=bids_path, verbose=False)
-        eeg_data = raw_object.get_data()
-
-        fs = raw_object.info["sfreq"]
-        max_time = eeg_data.shape[1] / fs
-        time_steps = np.linspace(0, max_time, eeg_data.shape[1]).squeeze()  # in seconds
-
-        channel_names = raw_object.ch_names
-
-        eeg_xarray = xr.DataArray(
-            data=eeg_data,
-            dims=["channel", "time"],
-            coords={"time": time_steps, "channel": channel_names},
-        )
-        return eeg_xarray
-
     def add_bids_dataset(
         self, dataset: str, data_dir: str, overwrite: bool = True
     ) -> None:
@@ -411,39 +388,6 @@ class EEGDash:
             logger.info("Upserted: %s", result.upserted_count)
             logger.info("Errors: %s ", result.bulk_api_result.get("writeErrors", []))
 
-    def get(self, query: dict[str, Any]) -> list[xr.DataArray]:
-        """Download and return EEG data arrays for records matching a query.
-
-        Parameters
-        ----------
-        query : dict
-            MongoDB query used to select records.
-
-        Returns
-        -------
-        list of xr.DataArray
-            EEG data for each matching record, with dimensions ``("channel", "time")``.
-
-        Notes
-        -----
-        Retrieval runs in parallel. Downloaded files are read and discarded
-        (no on-disk caching here).
-
-        """
-        sessions = self.find(query)
-        results = []
-        if sessions:
-            logger.info("Found %s records", len(sessions))
-            results = Parallel(
-                n_jobs=-1 if len(sessions) > 1 else 1, prefer="threads", verbose=1
-            )(
-                delayed(downloader.load_eeg_from_s3)(
-                    downloader.get_s3path("s3://openneuro.org", session["bidspath"])
-                )
-                for session in sessions
-            )
-        return results
-
     def _add_request(self, record: dict):
         """Internal helper method to create a MongoDB insertion request for a record."""
         return InsertOne(record)
@@ -549,16 +493,54 @@ class EEGDashDataset(BaseConcatDataset, metaclass=NumpyDocstringInheritanceInitM
 
     Examples
     --------
-    # Find by single subject
-    >>> ds = EEGDashDataset(dataset="ds005505", subject="NDARCA153NKE")
-
-    # Find by a list of subjects and a specific task
-    >>> subjects = ["NDARCA153NKE", "NDARXT792GY8"]
-    >>> ds = EEGDashDataset(dataset="ds005505", subject=subjects, task="RestingState")
-
-    # Use a raw MongoDB query for advanced filtering
-    >>> raw_query = {"dataset": "ds005505", "subject": {"$in": subjects}}
-    >>> ds = EEGDashDataset(query=raw_query)
+    Basic usage with dataset and subject filtering:
+
+    >>> from eegdash import EEGDashDataset
+    >>> dataset = EEGDashDataset(
+    ...     cache_dir="./data",
+    ...     dataset="ds002718",
+    ...     subject="012"
+    ... )
+    >>> print(f"Number of recordings: {len(dataset)}")
+
+    Filter by multiple subjects and specific task:
+
+    >>> subjects = ["012", "013", "014"]
+    >>> dataset = EEGDashDataset(
+    ...     cache_dir="./data",
+    ...     dataset="ds002718",
+    ...     subject=subjects,
+    ...     task="RestingState"
+    ... )
+
+    Load and inspect EEG data from recordings:
+
+    >>> if len(dataset) > 0:
+    ...     recording = dataset[0]
+    ...     raw = recording.load()
+    ...     print(f"Sampling rate: {raw.info['sfreq']} Hz")
+    ...     print(f"Number of channels: {len(raw.ch_names)}")
+    ...     print(f"Duration: {raw.times[-1]:.1f} seconds")
+
+    Advanced filtering with raw MongoDB queries:
+
+    >>> from eegdash import EEGDashDataset
+    >>> query = {
+    ...     "dataset": "ds002718",
+    ...     "subject": {"$in": ["012", "013"]},
+    ...     "task": "RestingState"
+    ... }
+    >>> dataset = EEGDashDataset(cache_dir="./data", query=query)
+
+    Working with dataset collections and braindecode integration:
+
+    >>> # EEGDashDataset is a braindecode BaseConcatDataset
+    >>> for i, recording in enumerate(dataset):
+    ...     if i >= 2:  # limit output
+    ...         break
+    ...     print(f"Recording {i}: {recording.description}")
+    ...     raw = recording.load()
+    ...     print(f"  Channels: {len(raw.ch_names)}, Duration: {raw.times[-1]:.1f}s")
 
     Parameters
     ----------
@@ -966,3 +948,6 @@ class EEGDashDataset(BaseConcatDataset, metaclass=NumpyDocstringInheritanceInitM
                 )
             )
         return datasets
+
+
+__all__ = ["EEGDash", "EEGDashDataset"]

eegdash/bids_eeg_metadata.py

@@ -1,3 +1,14 @@
+# Authors: The EEGDash contributors.
+# License: GNU General Public License
+# Copyright the EEGDash contributors.
+
+"""BIDS metadata processing and query building utilities.
+
+This module provides functions for processing BIDS-formatted EEG metadata, building database
+queries from user parameters, and enriching metadata records with participant information.
+It handles the translation between user-friendly query parameters and MongoDB query syntax.
+"""
+
 import re
 from pathlib import Path
 from typing import Any
@@ -374,3 +385,11 @@ def enrich_from_participants(
     extras = participants_extras_from_tsv(bids_root, subject)
     attach_participants_extras(raw, description, extras)
     return extras
+
+
+__all__ = [
+    "participants_row_for_subject",
+    "participants_extras_from_tsv",
+    "attach_participants_extras",
+    "enrich_from_participants",
+]

eegdash/const.py

@@ -1,3 +1,21 @@
+# Authors: The EEGDash contributors.
+# License: GNU General Public License
+# Copyright the EEGDash contributors.
+
+"""Configuration constants and mappings for EEGDash.
+
+This module contains global configuration settings, allowed query fields, and mapping
+constants used throughout the EEGDash package. It defines the interface between EEGDash
+releases and OpenNeuro dataset identifiers, as well as validation rules for database queries.
+"""
+
+__all__ = [
+    "config",
+    "ALLOWED_QUERY_FIELDS",
+    "RELEASE_TO_OPENNEURO_DATASET_MAP",
+    "SUBJECT_MINI_RELEASE_MAP",
+]
+
 ALLOWED_QUERY_FIELDS = {
     "data_name",
     "dataset",

eegdash/data_utils.py

@@ -1,3 +1,14 @@
+# Authors: The EEGDash contributors.
+# License: GNU General Public License
+# Copyright the EEGDash contributors.
+
+"""Data utilities and dataset classes for EEG data handling.
+
+This module provides core dataset classes for working with EEG data in the EEGDash ecosystem,
+including classes for individual recordings and collections of datasets. It integrates with
+braindecode for machine learning workflows and handles data loading from both local and remote sources.
+"""
+
 import io
 import json
 import os
@@ -661,3 +672,6 @@ class EEGBIDSDataset:
         for list_field in ["name", "type", "units"]:
             channel_tsv[list_field] = list(channel_tsv[list_field].values())
         return channel_tsv
+
+
+__all__ = ["EEGDashBaseDataset", "EEGBIDSDataset", "EEGDashBaseRaw"]

eegdash/dataset/__init__.py

@@ -1,4 +1,22 @@
+"""Public API for dataset helpers and dynamically generated datasets."""
+
+from . import dataset as _dataset_mod  # triggers dynamic class registration
 from .dataset import EEGChallengeDataset
 from .registry import register_openneuro_datasets
 
-__all__ = ["EEGChallengeDataset", "register_openneuro_datasets"]
+# Re-export dynamically generated dataset classes at the package level so that
+# ``eegdash.dataset`` shows them in the API docs and users can import as
+# ``from eegdash.dataset import DSXXXXX``.
+_dyn_names = []
+for _name in getattr(_dataset_mod, "__all__", []):
+    if _name == "EEGChallengeDataset":
+        # Already imported explicitly above
+        continue
+    _obj = getattr(_dataset_mod, _name, None)
+    if _obj is not None:
+        globals()[_name] = _obj
+        _dyn_names.append(_name)
+
+__all__ = ["EEGChallengeDataset", "register_openneuro_datasets"] + _dyn_names
+
+del _dataset_mod, _name, _obj, _dyn_names

eegdash/dataset/dataset_summary.csv

@@ -10,7 +10,6 @@
 8,ds005508,3342,324,10,129,500,269.281,229.81 GB,246753736933,0,,,,,
 9,ds005507,1812,184,10,129,500,168.649,139.37 GB,149646718160,0,,,,,
 10,ds005506,1405,150,10,129,500,127.896,111.88 GB,120126449650,0,,,,,
-11,test,2,1,1,64,500,20.556,0 B,0,0,,,,,
 12,ds004854,1,1,1,64,128,0.535,79.21 MB,83057080,0,,,,,
 13,ds004853,1,1,1,64,128,0.535,79.21 MB,83057080,0,,,,,
 14,ds004844,68,17,1,64,1024,21.252,22.33 GB,23976121966,0,ds004844,,,Multisensory,Decision-making

eegdash/dataset/registry.py

@@ -57,14 +57,8 @@ def register_openneuro_datasets(
 
         init = make_init(dataset_id)
 
-        doc = f"""OpenNeuro dataset ``{dataset_id}``.
-
-        {_markdown_table(row_series)}
-
-        This class is a thin convenience wrapper for the dataset ``{dataset_id}``.
-        Constructor arguments are forwarded to :class:`{base_class.__name__}`; see the
-        base class documentation for parameter details and examples.
-        """
+        # Generate rich docstring with dataset metadata
+        doc = _generate_rich_docstring(dataset_id, row_series, base_class)
 
         # init.__doc__ = doc
 
@@ -90,6 +84,94 @@ def register_openneuro_datasets(
     return registered
 
 
+def _generate_rich_docstring(dataset_id: str, row_series: pd.Series, base_class) -> str:
+    """Generate a comprehensive docstring for a dataset class."""
+    # Extract metadata with safe defaults
+    n_subjects = row_series.get("n_subjects", "Unknown")
+    n_records = row_series.get("n_records", "Unknown")
+    n_tasks = row_series.get("n_tasks", "Unknown")
+    modality = row_series.get("modality of exp", "")
+    exp_type = row_series.get("type of exp", "")
+    subject_type = row_series.get("Type Subject", "")
+    duration = row_series.get("duration_hours_total", "Unknown")
+    size = row_series.get("size", "Unknown")
+
+    # Create description based on available metadata
+    description_parts = []
+    if modality and str(modality).strip():
+        description_parts.append(f"**Modality**: {modality}")
+    if exp_type and str(exp_type).strip():
+        description_parts.append(f"**Type**: {exp_type}")
+    if subject_type and str(subject_type).strip():
+        description_parts.append(f"**Subjects**: {subject_type}")
+
+    description = (
+        " | ".join(description_parts)
+        if description_parts
+        else "EEG dataset from OpenNeuro"
+    )
+
+    # Generate the docstring
+    docstring = f"""OpenNeuro dataset ``{dataset_id}``.
+
+{description}
+
+This dataset contains {n_subjects} subjects with {n_records} recordings across {n_tasks} tasks.
+Total duration: {duration} hours. Dataset size: {size}.
+
+{_markdown_table(row_series)}
+
+This dataset class provides convenient access to the ``{dataset_id}`` dataset through the EEGDash interface.
+It inherits all functionality from :class:`~{base_class.__module__}.{base_class.__name__}` with the dataset filter pre-configured.
+
+Parameters
+----------
+cache_dir : str
+    Directory to cache downloaded data.
+query : dict, optional
+    Additional MongoDB-style filters to AND with the dataset selection.
+    Must not contain the key ``dataset``.
+s3_bucket : str, optional
+    Base S3 bucket used to locate the data.
+**kwargs
+    Additional arguments passed to the base dataset class.
+
+Examples
+--------
+Basic usage:
+
+>>> from eegdash.dataset import {dataset_id.upper()}
+>>> dataset = {dataset_id.upper()}(cache_dir="./data")
+>>> print(f"Number of recordings: {{len(dataset)}}")
+
+Load a specific recording:
+
+>>> if len(dataset) > 0:
+...     recording = dataset[0]
+...     raw = recording.load()
+...     print(f"Sampling rate: {{raw.info['sfreq']}} Hz")
+...     print(f"Number of channels: {{len(raw.ch_names)}}")
+
+Filter by additional criteria:
+
+>>> # Get subset with specific task or subject
+>>> filtered_dataset = {dataset_id.upper()}(
+...     cache_dir="./data",
+...     query={{"task": "RestingState"}}  # if applicable
+... )
+
+Notes
+-----
+More details available in the `NEMAR documentation <https://nemar.org/dataexplorer/detail?dataset_id={dataset_id}>`__.
+
+See Also
+--------
+{base_class.__name__} : Base dataset class with full API documentation
+"""
+
+    return docstring
+
+
 def _markdown_table(row_series: pd.Series) -> str:
     """Create a reStructuredText grid table from a pandas Series."""
     if row_series.empty:
@@ -128,7 +210,12 @@ def _markdown_table(row_series: pd.Series) -> str:
     table = tabulate(df, headers="keys", tablefmt="rst", showindex=False)
 
     # Add a caption for the table
-    caption = f"Short overview of dataset {dataset_id} more details in the `Nemar documentation <https://nemar.org/dataexplorer/detail?dataset_id={dataset_id}>`_."
+    # Use an anonymous external link (double underscore) to avoid duplicate
+    # target warnings when this docstring is repeated across many classes.
+    caption = (
+        f"Short overview of dataset {dataset_id} more details in the "
+        f"`NeMAR documentation <https://nemar.org/dataexplorer/detail?dataset_id={dataset_id}>`__."
+    )
     # adding caption below the table
     # Indent the table to fit within the admonition block
     indented_table = "\n".join("    " + line for line in table.split("\n"))

eegdash/downloader.py

@@ -1,13 +1,19 @@
+# Authors: The EEGDash contributors.
+# License: GNU General Public License
+# Copyright the EEGDash contributors.
+
+"""File downloading utilities for EEG data from cloud storage.
+
+This module provides functions for downloading EEG data files and BIDS dependencies from
+AWS S3 storage, with support for caching and progress tracking. It handles the communication
+between the EEGDash metadata database and the actual EEG data stored in the cloud.
+"""
+
 import re
-import tempfile
 from pathlib import Path
 from typing import Any
-from urllib.parse import urlsplit
 
-import mne
-import numpy as np
 import s3fs
-import xarray as xr
 from fsspec.callbacks import TqdmCallback
 
 
@@ -97,80 +103,9 @@ def _filesystem_get(filesystem: s3fs.S3FileSystem, s3path: str, filepath: Path):
     return filepath
 
 
-def load_eeg_from_s3(s3path: str):
-    """Load EEG data from an S3 URI into an ``xarray.DataArray``.
-
-    Preserves the original filename, downloads sidecar files when applicable
-    (e.g., ``.fdt`` for EEGLAB, ``.vmrk``/``.eeg`` for BrainVision), and uses
-    MNE's direct readers.
-
-    Parameters
-    ----------
-    s3path : str
-        An S3 URI (should start with "s3://").
-
-    Returns
-    -------
-    xr.DataArray
-        EEG data with dimensions ``("channel", "time")``.
-
-    Raises
-    ------
-    ValueError
-        If the file extension is unsupported.
-
-    """
-    filesystem = get_s3_filesystem()
-    # choose a temp dir so sidecars can be colocated
-    with tempfile.TemporaryDirectory() as tmpdir:
-        # Derive local filenames from the S3 key to keep base name consistent
-        s3_key = urlsplit(s3path).path  # e.g., "/dsXXXX/sub-.../..._eeg.set"
-        basename = Path(s3_key).name
-        ext = Path(basename).suffix.lower()
-        local_main = Path(tmpdir) / basename
-
-        # Download main file
-        with (
-            filesystem.open(s3path, mode="rb") as fsrc,
-            open(local_main, "wb") as fdst,
-        ):
-            fdst.write(fsrc.read())
-
-        # Determine and fetch any required sidecars
-        sidecars: list[str] = []
-        if ext == ".set":  # EEGLAB
-            sidecars = [".fdt"]
-        elif ext == ".vhdr":  # BrainVision
-            sidecars = [".vmrk", ".eeg", ".dat", ".raw"]
-
-        for sc_ext in sidecars:
-            sc_key = s3_key[: -len(ext)] + sc_ext
-            sc_uri = f"s3://{urlsplit(s3path).netloc}{sc_key}"
-            try:
-                # If sidecar exists, download next to the main file
-                info = filesystem.info(sc_uri)
-                if info:
-                    sc_local = Path(tmpdir) / Path(sc_key).name
-                    with (
-                        filesystem.open(sc_uri, mode="rb") as fsrc,
-                        open(sc_local, "wb") as fdst,
-                    ):
-                        fdst.write(fsrc.read())
-            except Exception:
-                # Sidecar not present; skip silently
-                pass
-
-        # Read using appropriate MNE reader
-        raw = mne.io.read_raw(str(local_main), preload=True, verbose=False)
-
-        data = raw.get_data()
-        fs = raw.info["sfreq"]
-        max_time = data.shape[1] / fs
-        time_steps = np.linspace(0, max_time, data.shape[1]).squeeze()
-        channel_names = raw.ch_names
-
-        return xr.DataArray(
-            data=data,
-            dims=["channel", "time"],
-            coords={"time": time_steps, "channel": channel_names},
-        )
+__all__ = [
+    "download_s3_file",
+    "download_dependencies",
+    "get_s3path",
+    "get_s3_filesystem",
+]

eegdash/features/serialization.py

@@ -1,6 +1,8 @@
-"""Convenience functions for storing and loading of features datasets.
+"""Convenience functions for storing and loading features datasets.
+
+See Also:
+    https://github.com/braindecode/braindecode//blob/master/braindecode/datautil/serialization.py#L165-L229
 
-see also: https://github.com/braindecode/braindecode//blob/master/braindecode/datautil/serialization.py#L165-L229
 """
 
 from pathlib import Path
@@ -15,7 +17,7 @@ from .datasets import FeaturesConcatDataset, FeaturesDataset
 
 
 def load_features_concat_dataset(path, ids_to_load=None, n_jobs=1):
-    """Load a stored FeaturesConcatDataset of FeaturesDatasets from files.
+    """Load a stored features dataset from files.
 
     Parameters
     ----------
@@ -28,7 +30,9 @@ def load_features_concat_dataset(path, ids_to_load=None, n_jobs=1):
 
     Returns
     -------
-    concat_dataset: FeaturesConcatDataset of FeaturesDatasets
+    concat_dataset: eegdash.features.datasets.FeaturesConcatDataset
+        A concatenation of multiple eegdash.features.datasets.FeaturesDataset
+        instances loaded from the given directory.
 
     """
     # Make sure we always work with a pathlib.Path

eegdash/hbn/__init__.py

@@ -1,3 +1,14 @@
+# Authors: The EEGDash contributors.
+# License: GNU General Public License
+# Copyright the EEGDash contributors.
+
+"""Healthy Brain Network (HBN) specific utilities and preprocessing.
+
+This module provides specialized functions for working with the Healthy Brain Network
+dataset, including preprocessing pipelines, annotation handling, and windowing utilities
+tailored for HBN EEG data analysis.
+"""
+
 from .preprocessing import hbn_ec_ec_reannotation
 from .windows import (
     add_aux_anchors,

eegdash/hbn/preprocessing.py

@@ -1,3 +1,14 @@
+# Authors: The EEGDash contributors.
+# License: GNU General Public License
+# Copyright the EEGDash contributors.
+
+"""Preprocessing utilities specific to the Healthy Brain Network dataset.
+
+This module contains preprocessing classes and functions designed specifically for
+HBN EEG data, including specialized annotation handling for eyes-open/eyes-closed
+paradigms and other HBN-specific preprocessing steps.
+"""
+
 import mne
 import numpy as np
 

eegdash/hbn/windows.py

@@ -1,3 +1,15 @@
+# Authors: The EEGDash contributors.
+# License: GNU General Public License
+# Copyright the EEGDash contributors.
+
+"""Windowing and trial processing utilities for HBN datasets.
+
+This module provides functions for building trial tables, adding auxiliary anchors,
+annotating trials with targets, and filtering recordings based on various criteria.
+These utilities are specifically designed for working with HBN EEG data structures
+and experimental paradigms.
+"""
+
 import logging
 
 import mne

eegdash/logging.py

@@ -1,3 +1,13 @@
+# Authors: The EEGDash contributors.
+# License: GNU General Public License
+# Copyright the EEGDash contributors.
+
+"""Logging configuration for EEGDash.
+
+This module sets up centralized logging for the EEGDash package using Rich for enhanced
+console output formatting. It provides a consistent logging interface across all modules.
+"""
+
 import logging
 
 from rich.logging import RichHandler
@@ -21,3 +31,5 @@ root_logger.setLevel(logging.INFO)
 logger = logging.getLogger("eegdash")
 
 logger.setLevel(logging.INFO)
+
+__all__ = ["logger"]

eegdash/mongodb.py

@@ -1,3 +1,14 @@
+# Authors: The EEGDash contributors.
+# License: GNU General Public License
+# Copyright the EEGDash contributors.
+
+"""MongoDB connection and operations management.
+
+This module provides thread-safe MongoDB connection management and high-level database
+operations for the EEGDash metadata database. It includes methods for finding, adding,
+and updating EEG data records with proper connection pooling and error handling.
+"""
+
 import threading
 
 from pymongo import MongoClient
@@ -64,3 +75,6 @@ class MongoConnectionManager:
                 except Exception:
                     pass
             cls._instances.clear()
+
+
+__all__ = ["MongoConnectionManager"]

eegdash/paths.py

@@ -1,3 +1,14 @@
+# Authors: The EEGDash contributors.
+# License: GNU General Public License
+# Copyright the EEGDash contributors.
+
+"""Path utilities and cache directory management.
+
+This module provides functions for resolving consistent cache directories and path
+management throughout the EEGDash package, with integration to MNE-Python's
+configuration system.
+"""
+
 from __future__ import annotations
 
 import os
@@ -26,3 +37,6 @@ def get_default_cache_dir() -> Path:
 
     # 3) Default to a project-local hidden folder
     return Path.cwd() / ".eegdash_cache"
+
+
+__all__ = ["get_default_cache_dir"]

eegdash/utils.py

@@ -1,3 +1,13 @@
+# Authors: The EEGDash contributors.
+# License: GNU General Public License
+# Copyright the EEGDash contributors.
+
+"""General utility functions for EEGDash.
+
+This module contains miscellaneous utility functions used across the EEGDash package,
+including MongoDB client initialization and configuration helpers.
+"""
+
 from mne.utils import get_config, set_config, use_log_level
 
 
@@ -9,3 +19,6 @@ def _init_mongo_client():
                 "mongodb+srv://eegdash-user:mdzoMjQcHWTVnKDq@cluster0.vz35p.mongodb.net/?retryWrites=true&w=majority&appName=Cluster0",
                 set_env=True,
             )
+
+
+__all__ = ["_init_mongo_client"]

{eegdash-0.4.0.dev132.dist-info → eegdash-0.4.0.dev150.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eegdash
-Version: 0.4.0.dev132
+Version: 0.4.0.dev150
 Summary: EEG data for machine learning
 Author-email: Young Truong <dt.young112@gmail.com>, Arnaud Delorme <adelorme@gmail.com>, Aviv Dotan <avivd220@gmail.com>, Oren Shriki <oren70@gmail.com>, Bruno Aristimunha <b.aristimunha@gmail.com>
 License-Expression: GPL-3.0-only
@@ -35,7 +35,6 @@ Requires-Dist: python-dotenv
 Requires-Dist: s3fs
 Requires-Dist: scipy
 Requires-Dist: tqdm
-Requires-Dist: xarray
 Requires-Dist: h5io>=0.2.4
 Requires-Dist: pymatreader
 Requires-Dist: eeglabio
@@ -58,6 +57,7 @@ Requires-Dist: sphinx_gallery; extra == "docs"
 Requires-Dist: sphinx_rtd_theme; extra == "docs"
 Requires-Dist: pydata-sphinx-theme; extra == "docs"
 Requires-Dist: sphinx-autobuild; extra == "docs"
+Requires-Dist: sphinx-copybutton; extra == "docs"
 Requires-Dist: sphinx-sitemap; extra == "docs"
 Requires-Dist: numpydoc; extra == "docs"
 Requires-Dist: memory_profiler; extra == "docs"
@@ -65,6 +65,7 @@ Requires-Dist: ipython; extra == "docs"
 Requires-Dist: lightgbm; extra == "docs"
 Requires-Dist: plotly; extra == "docs"
 Requires-Dist: nbformat; extra == "docs"
+Requires-Dist: graphviz; extra == "docs"
 Provides-Extra: all
 Requires-Dist: eegdash[docs]; extra == "all"
 Requires-Dist: eegdash[dev]; extra == "all"

eegdash-0.4.0.dev150.dist-info/RECORD

@@ -0,0 +1,37 @@
+eegdash/__init__.py,sha256=E0583aFzz3UAElK7BMSDvWmuTNyiEkhJXjqlNsxg7n0,704
+eegdash/api.py,sha256=vcme_BXxc0KpyLwQfrzV7lojM0s16P7KPq-62Gu9ee4,37241
+eegdash/bids_eeg_metadata.py,sha256=0fA5FDM4OlSS83JziRI7-hPvh-KRvwKBpT1dMeB4znk,14307
+eegdash/const.py,sha256=-cwrtncqJHZ19lGf2MK-IgKy7hTMfb6H-CeL50Oonyg,7883
+eegdash/data_utils.py,sha256=5g88vIuU_KTixWF2BV6wtQTs8ba23OPIMkrsEklmiE8,26548
+eegdash/downloader.py,sha256=ukkol-2Y-8FGgociwJR-3TqBfvbUuCuMt2L6E_6baDY,3638
+eegdash/logging.py,sha256=Jux2A3YM9m2ksETErEfUG7wnB7jpJw6v1JH9tQuYVJc,974
+eegdash/mongodb.py,sha256=oXjiNLf0-46r_0RbxG8Y8wQZl8MIcfGQt4_qieU2MqU,2469
+eegdash/paths.py,sha256=4-ae23KeXMP5yaKAJCNW7pQGV19c00ll0EGElV2rZn8,1255
+eegdash/utils.py,sha256=e7LdirPY0dAfMZNWTbgAguqzu-dq0zo-mtXB9nIzf_c,758
+eegdash/dataset/__init__.py,sha256=HKDfV2DHBv63BqYLBWDMvU8jbFNRC7DqQbxL7RG1DKQ,863
+eegdash/dataset/dataset.py,sha256=e_rliu4E-uPtz_miUSzGukUahCHHhyXB2Gu3pm3cyHo,7062
+eegdash/dataset/dataset_summary.csv,sha256=a5Y21LmBPKLVRt5uKNXO7lSRDjsDmJLzv6-3HryF5JU,23614
+eegdash/dataset/registry.py,sha256=KmPDfazhdsIyUouo3qdqDaHiTKHCZcEvXQJeHphZijY,7057
+eegdash/features/__init__.py,sha256=BXNhjvL4_SSFAY1lcP9nyGpkbJNtoOMH4AHlF6OyABo,4078
+eegdash/features/datasets.py,sha256=eV4d86EU4fu1yoIMdPQnot6YZDRGG4qE9h77lk7iVhU,18317
+eegdash/features/decorators.py,sha256=v0qaJz_dcX703p1fvFYbAIXmwK3d8naYGlq7fRVKn_w,1313
+eegdash/features/extractors.py,sha256=H7h6tP3dKoRcjDJpWWAo0ppmokCq5QlhqMcehYwYV9s,6845
+eegdash/features/inspect.py,sha256=PmbWhx5H_WqpnorUpWONUSkUtaIHkZblRa_Xyk7Szyc,1569
+eegdash/features/serialization.py,sha256=LmDrQEb-NLNgak_LabdDnr_J_v0QyLPzm_E8IiIHgMQ,2960
+eegdash/features/utils.py,sha256=eM6DdyOpdVfNh7dSPykJ0WaTDtaGvkCQWAmW0G8v60Y,3784
+eegdash/features/feature_bank/__init__.py,sha256=YsMXLC1FEtHL3IEw9pYw1fc5IY0x_hr2qWQowI5gZj8,2991
+eegdash/features/feature_bank/complexity.py,sha256=iy9uaLInsYdxKZlXHTWlgEpP9fVI-v9TqLGfnS15-Eg,3258
+eegdash/features/feature_bank/connectivity.py,sha256=bQ6KlxWm5GNpCS9ypLqBUr2L171Yq7wpBQT2tRQKTZ4,2159
+eegdash/features/feature_bank/csp.py,sha256=jKPrmqBj7FliybNbg035cVZddvVSkhk9OazcscDpipU,3303
+eegdash/features/feature_bank/dimensionality.py,sha256=j_Ds71Y1AbV2uLFQj8EuXQ4kzofLBlQtPV5snMkF7i4,3965
+eegdash/features/feature_bank/signal.py,sha256=3Tb8z9gX7iZipxQJ9DSyy30JfdmW58kgvimSyZX74p8,3404
+eegdash/features/feature_bank/spectral.py,sha256=bNB7skusePs1gX7NOU6yRlw_Gr4UOCkO_ylkCgybzug,3319
+eegdash/features/feature_bank/utils.py,sha256=DGh-Q7-XFIittP7iBBxvsJaZrlVvuY5mw-G7q6C-PCI,1237
+eegdash/hbn/__init__.py,sha256=hsI5pmIuYDzr--aE5UiToO-P9XL5fVRKahZzdsAodro,794
+eegdash/hbn/preprocessing.py,sha256=cfsLXnGuUaVJ3NhueDgmdc0w7jflmIi69occuB4bs7M,2609
+eegdash/hbn/windows.py,sha256=23KyVl0pQn4o40wM3Rsu8nl5tN-REAusU7wcv9L4a5U,10351
+eegdash-0.4.0.dev150.dist-info/licenses/LICENSE,sha256=asisR-xupy_NrQBFXnx6yqXeZcYWLvbAaiETl25iXT0,931
+eegdash-0.4.0.dev150.dist-info/METADATA,sha256=YbiJANCGZcLMSn2pjX73kOm0QO_pFzYTVifwtVhAZ_A,6804
+eegdash-0.4.0.dev150.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+eegdash-0.4.0.dev150.dist-info/top_level.txt,sha256=zavO69HQ6MyZM0aQMR2zUS6TAFc7bnN5GEpDpOpFZzU,8
+eegdash-0.4.0.dev150.dist-info/RECORD,,

eegdash-0.4.0.dev132.dist-info/RECORD

@@ -1,37 +0,0 @@
-eegdash/__init__.py,sha256=X0mp26TKeJDAerze3q3hnCgN6V9Sokwwvj_eDdjswaE,284
-eegdash/api.py,sha256=0YNbL1u-Wh51r-dRU2ijUmfOTIharr3OFGgLOxEznX0,37813
-eegdash/bids_eeg_metadata.py,sha256=XUkQp2M8zQ_wH5JC8lQiVR0TWssOjSdrdEWkgwGjiZ8,13699
-eegdash/const.py,sha256=qdFBEL9kIrsj9CdxbXhBkR61R3CrTGSaj5Iq0YOACIs,7313
-eegdash/data_utils.py,sha256=dePEXcJefo3gmD534bb576p8v9jErDNLDHQoDGHqH-g,26006
-eegdash/downloader.py,sha256=B-8u0c39F4inV-v_WgYZrUKAGPQOdfqC2RX1qNrRQYM,5808
-eegdash/logging.py,sha256=SZdB7WLT5b2okecWpvLx4UWUxg3DiA11Z5d9lhYdDyc,616
-eegdash/mongodb.py,sha256=GD3WgA253oFgpzOHrYaj4P1mRjNtDMT5Oj4kVvHswjI,2006
-eegdash/paths.py,sha256=246xkectTxDAYcREs1Qma_F1Y-oSmLlb0hn0F2Za5Ss,866
-eegdash/utils.py,sha256=7TfQ9D0LrAJ7FgnSXEvWgeHWK2QqaqS-_WcWXD86ObQ,408
-eegdash/dataset/__init__.py,sha256=Qmzki5G8GaFlzTb10e4SmC3WkKuJyo1Ckii15tCEHAo,157
-eegdash/dataset/dataset.py,sha256=e_rliu4E-uPtz_miUSzGukUahCHHhyXB2Gu3pm3cyHo,7062
-eegdash/dataset/dataset_summary.csv,sha256=XF0vdHz77DFyVLTaET8lL5gQQ4r-q1xAfSDWH5GTPLA,23655
-eegdash/dataset/registry.py,sha256=genOqAuf9cQBnHhPqRwfLP7S1XsnkLot6sLyJozPtf4,4150
-eegdash/features/__init__.py,sha256=BXNhjvL4_SSFAY1lcP9nyGpkbJNtoOMH4AHlF6OyABo,4078
-eegdash/features/datasets.py,sha256=eV4d86EU4fu1yoIMdPQnot6YZDRGG4qE9h77lk7iVhU,18317
-eegdash/features/decorators.py,sha256=v0qaJz_dcX703p1fvFYbAIXmwK3d8naYGlq7fRVKn_w,1313
-eegdash/features/extractors.py,sha256=H7h6tP3dKoRcjDJpWWAo0ppmokCq5QlhqMcehYwYV9s,6845
-eegdash/features/inspect.py,sha256=PmbWhx5H_WqpnorUpWONUSkUtaIHkZblRa_Xyk7Szyc,1569
-eegdash/features/serialization.py,sha256=snXuHVd0CoT2ese0iWi5RwZrVHCGc0oCZ8-SXqGY88I,2848
-eegdash/features/utils.py,sha256=eM6DdyOpdVfNh7dSPykJ0WaTDtaGvkCQWAmW0G8v60Y,3784
-eegdash/features/feature_bank/__init__.py,sha256=YsMXLC1FEtHL3IEw9pYw1fc5IY0x_hr2qWQowI5gZj8,2991
-eegdash/features/feature_bank/complexity.py,sha256=iy9uaLInsYdxKZlXHTWlgEpP9fVI-v9TqLGfnS15-Eg,3258
-eegdash/features/feature_bank/connectivity.py,sha256=bQ6KlxWm5GNpCS9ypLqBUr2L171Yq7wpBQT2tRQKTZ4,2159
-eegdash/features/feature_bank/csp.py,sha256=jKPrmqBj7FliybNbg035cVZddvVSkhk9OazcscDpipU,3303
-eegdash/features/feature_bank/dimensionality.py,sha256=j_Ds71Y1AbV2uLFQj8EuXQ4kzofLBlQtPV5snMkF7i4,3965
-eegdash/features/feature_bank/signal.py,sha256=3Tb8z9gX7iZipxQJ9DSyy30JfdmW58kgvimSyZX74p8,3404
-eegdash/features/feature_bank/spectral.py,sha256=bNB7skusePs1gX7NOU6yRlw_Gr4UOCkO_ylkCgybzug,3319
-eegdash/features/feature_bank/utils.py,sha256=DGh-Q7-XFIittP7iBBxvsJaZrlVvuY5mw-G7q6C-PCI,1237
-eegdash/hbn/__init__.py,sha256=U8mK64napnKU746C5DOwkX7W7sg3iW5kb_cVv2pfFq0,394
-eegdash/hbn/preprocessing.py,sha256=zMkDFXQxWLn-Iy0cHRk-JL5c479HpclgIAGm-xuKPFg,2196
-eegdash/hbn/windows.py,sha256=Obv4L2hP8ACancUawkMYbiusfvhAw-mG_vqyDDMwOJ8,9890
-eegdash-0.4.0.dev132.dist-info/licenses/LICENSE,sha256=asisR-xupy_NrQBFXnx6yqXeZcYWLvbAaiETl25iXT0,931
-eegdash-0.4.0.dev132.dist-info/METADATA,sha256=2_hkPms-a1bnPet5DKAXRy4vO33LLtnQYgea7EMwFUk,6735
-eegdash-0.4.0.dev132.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-eegdash-0.4.0.dev132.dist-info/top_level.txt,sha256=zavO69HQ6MyZM0aQMR2zUS6TAFc7bnN5GEpDpOpFZzU,8
-eegdash-0.4.0.dev132.dist-info/RECORD,,