eegdash 0.3.3.dev178374711__tar.gz → 0.3.4.dev69__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of eegdash might be problematic. Click here for more details.

Files changed (50) hide show
  1. eegdash-0.3.4.dev69/MANIFEST.in +7 -0
  2. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/PKG-INFO +1 -1
  3. eegdash-0.3.4.dev69/docs/Makefile +31 -0
  4. eegdash-0.3.4.dev69/docs/source/conf.py +142 -0
  5. eegdash-0.3.4.dev69/docs/source/dataset_summary.rst +80 -0
  6. eegdash-0.3.4.dev69/docs/source/index.rst +56 -0
  7. eegdash-0.3.4.dev69/docs/source/install/install.rst +77 -0
  8. eegdash-0.3.4.dev69/docs/source/install/install_pip.rst +19 -0
  9. eegdash-0.3.4.dev69/docs/source/install/install_source.rst +80 -0
  10. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/eegdash/__init__.py +1 -1
  11. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/eegdash/data_utils.py +12 -1
  12. eegdash-0.3.4.dev69/eegdash/dataset_summary.csv +255 -0
  13. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/eegdash.egg-info/PKG-INFO +1 -1
  14. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/eegdash.egg-info/SOURCES.txt +9 -0
  15. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/pyproject.toml +4 -0
  16. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/LICENSE +0 -0
  17. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/README.md +0 -0
  18. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/eegdash/api.py +0 -0
  19. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/eegdash/data_config.py +0 -0
  20. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/eegdash/dataset.py +0 -0
  21. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/eegdash/features/__init__.py +0 -0
  22. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/eegdash/features/datasets.py +0 -0
  23. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/eegdash/features/decorators.py +0 -0
  24. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/eegdash/features/extractors.py +0 -0
  25. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/eegdash/features/feature_bank/__init__.py +0 -0
  26. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/eegdash/features/feature_bank/complexity.py +0 -0
  27. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/eegdash/features/feature_bank/connectivity.py +0 -0
  28. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/eegdash/features/feature_bank/csp.py +0 -0
  29. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/eegdash/features/feature_bank/dimensionality.py +0 -0
  30. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/eegdash/features/feature_bank/signal.py +0 -0
  31. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/eegdash/features/feature_bank/spectral.py +0 -0
  32. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/eegdash/features/feature_bank/utils.py +0 -0
  33. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/eegdash/features/inspect.py +0 -0
  34. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/eegdash/features/serialization.py +0 -0
  35. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/eegdash/features/utils.py +0 -0
  36. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/eegdash/mongodb.py +0 -0
  37. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/eegdash/preprocessing.py +0 -0
  38. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/eegdash/registry.py +0 -0
  39. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/eegdash/utils.py +0 -0
  40. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/eegdash.egg-info/dependency_links.txt +0 -0
  41. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/eegdash.egg-info/requires.txt +0 -0
  42. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/eegdash.egg-info/top_level.txt +0 -0
  43. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/setup.cfg +0 -0
  44. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/tests/test_correctness.py +0 -0
  45. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/tests/test_dataset.py +0 -0
  46. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/tests/test_dataset_registration.py +0 -0
  47. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/tests/test_eegdash.py +0 -0
  48. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/tests/test_functional.py +0 -0
  49. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/tests/test_init.py +0 -0
  50. {eegdash-0.3.3.dev178374711 → eegdash-0.3.4.dev69}/tests/test_mongo_connection.py +0 -0
@@ -0,0 +1,7 @@
1
+ include README.md
2
+ include LICENSE
3
+
4
+ include eegdash/dataset_summary.csv
5
+
6
+ recursive-include docs *.ipynb *.rst conf.py Makefile
7
+ recursive-exclude docs *checkpoint.ipynb
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: eegdash
3
- Version: 0.3.3.dev178374711
3
+ Version: 0.3.4.dev69
4
4
  Summary: EEG data for machine learning
5
5
  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>
6
6
  License-Expression: GPL-3.0-only
@@ -0,0 +1,31 @@
1
+ # Minimal makefile for Sphinx documentation
2
+ SPHINXOPTS ?=
3
+ SPHINXBUILD ?= sphinx-build
4
+ SOURCEDIR = source
5
+ BUILDDIR = build
6
+ PKG ?= eegdash
7
+ APIDIR := $(SOURCEDIR)/api
8
+
9
+ help:
10
+ @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
11
+
12
+ .PHONY: apidoc
13
+ apidoc:
14
+ @sphinx-apidoc -o "$(APIDIR)" "../$(PKG)" -f -e -M
15
+
16
+ # Standard build runs examples
17
+ html: apidoc
18
+
19
+ # Fast build: do NOT execute examples (sphinx-gallery)
20
+ .PHONY: html-noplot
21
+ html-noplot: apidoc
22
+ @python prepare_summary_tables.py ../eegdash/ $(BUILDDIR)
23
+ @$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" \
24
+ $(SPHINXOPTS) -D sphinx_gallery_conf.plot_gallery=0 $(O)
25
+
26
+ .PHONY: help apidoc
27
+ Makefile: ;
28
+
29
+ %: Makefile
30
+ @python prepare_summary_tables.py ../eegdash/ $(BUILDDIR)
31
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@@ -0,0 +1,142 @@
1
+ import os
2
+ from datetime import datetime, timezone
3
+
4
+ from sphinx_gallery.sorting import ExplicitOrder, FileNameSortKey
5
+
6
+ import eegdash
7
+
8
+ # -- Project information -----------------------------------------------------
9
+
10
+ project = "EEG Dash"
11
+ copyright = f"2025–{datetime.now(tz=timezone.utc).year}, {project} Developers"
12
+ author = "Arnaud Delorme"
13
+ release = eegdash.__version__
14
+ version = ".".join(release.split(".")[:2])
15
+
16
+
17
+ # -- General configuration ---------------------------------------------------
18
+
19
+ extensions = [
20
+ "sphinx.ext.autodoc",
21
+ "sphinx.ext.autosummary",
22
+ "sphinx.ext.doctest",
23
+ "sphinx.ext.todo",
24
+ "sphinx.ext.coverage",
25
+ "sphinx.ext.mathjax",
26
+ "sphinx.ext.ifconfig",
27
+ "sphinx.ext.intersphinx",
28
+ "sphinx.ext.githubpages",
29
+ "sphinx.ext.napoleon",
30
+ "sphinx_design",
31
+ # "autoapi.extension",
32
+ "numpydoc",
33
+ "sphinx_gallery.gen_gallery",
34
+ ]
35
+
36
+ templates_path = ["_templates"]
37
+ exclude_patterns = ["build", "Thumbs.db", ".DS_Store"]
38
+
39
+ # -- Options for HTML output -------------------------------------------------
40
+
41
+ html_theme = "pydata_sphinx_theme"
42
+ html_static_path = ["_static"]
43
+ html_logo = "_static/eegdash_icon.svg"
44
+ html_favicon = "_static/eegdash_icon.png"
45
+ html_title = "EEG Dash"
46
+ html_short_title = "EEG Dash"
47
+ html_css_files = ["custom.css"]
48
+
49
+ html_theme_options = {
50
+ "icon_links_label": "External Links", # for screen reader
51
+ "use_edit_page_button": False,
52
+ "navigation_with_keys": False,
53
+ "collapse_navigation": False,
54
+ "header_links_before_dropdown": 6,
55
+ "navigation_depth": 6,
56
+ "show_toc_level": 1,
57
+ "navbar_end": ["theme-switcher", "navbar-icon-links"],
58
+ "footer_start": ["copyright"],
59
+ "logo": {
60
+ "image_light": "_static/eegdash_long.png",
61
+ "image_dark": "_static/eegdash_long.png",
62
+ "alt_text": "EEG Dash Logo",
63
+ },
64
+ "external_links": [
65
+ {"name": "EEG2025 competition", "url": "https://eeg2025.github.io/"},
66
+ ],
67
+ "icon_links": [
68
+ {
69
+ "name": "GitHub",
70
+ "url": "https://github.com/sccn/EEGDash",
71
+ "icon": "fa-brands fa-github",
72
+ "type": "fontawesome",
73
+ },
74
+ {
75
+ "name": "PyPI",
76
+ "url": "https://pypi.org/project/eegdash/",
77
+ "icon": "fa-solid fa-box",
78
+ "type": "fontawesome",
79
+ },
80
+ {
81
+ "name": "Docs (Stable)",
82
+ "url": "https://sccn.github.io/EEGDash",
83
+ "icon": "fa-solid fa-book",
84
+ "type": "fontawesome",
85
+ },
86
+ {
87
+ "name": "Discord",
88
+ "url": "https://discord.gg/8jd7nVKwsc",
89
+ "icon": "fa-brands fa-discord",
90
+ "type": "fontawesome",
91
+ },
92
+ ],
93
+ }
94
+
95
+ html_sidebars = {"api": [], "dataset_summary": [], "installation": []}
96
+
97
+
98
+ # -- Extension configurations ------------------------------------------------
99
+
100
+
101
+ # Numpydoc
102
+ numpydoc_show_class_members = False
103
+
104
+ # Sphinx Gallery
105
+ EX_DIR = "../../examples" # relative to docs/source
106
+ sphinx_gallery_conf = {
107
+ "examples_dirs": [EX_DIR],
108
+ "gallery_dirs": ["generated/auto_examples"],
109
+ "nested_sections": False,
110
+ "backreferences_dir": "gen_modules/backreferences",
111
+ "inspect_global_variables": True,
112
+ "show_memory": True,
113
+ "show_api_usage": True,
114
+ "doc_module": ("eegdash", "numpy", "scipy", "matplotlib"),
115
+ "reference_url": {"eegdash": None},
116
+ "filename_pattern": r"/(?:plot|tutorial)_(?!_).*\.py",
117
+ "matplotlib_animations": True,
118
+ "first_notebook_cell": (
119
+ "# For tips on running notebooks in Google Colab:\n"
120
+ "# `pip install eegdash`\n"
121
+ "%matplotlib inline"
122
+ ),
123
+ "subsection_order": ExplicitOrder(
124
+ [
125
+ f"{EX_DIR}/core",
126
+ f"{EX_DIR}/eeg2025",
127
+ "*",
128
+ ]
129
+ ),
130
+ "within_subsection_order": FileNameSortKey,
131
+ }
132
+
133
+ # -- Custom Setup Function to fix the error -----------------------------------
134
+
135
+
136
+ def setup(app):
137
+ """Create the back-references directory if it doesn't exist."""
138
+ backreferences_dir = os.path.join(
139
+ app.srcdir, sphinx_gallery_conf["backreferences_dir"]
140
+ )
141
+ if not os.path.exists(backreferences_dir):
142
+ os.makedirs(backreferences_dir)
@@ -0,0 +1,80 @@
1
+ .. meta::
2
+ :hide_sidebar: true
3
+
4
+ :html_theme.sidebar_secondary.remove:
5
+ :html_theme.sidebar_primary.remove:
6
+
7
+ .. _data_summary:
8
+ .. automodule:: eegdash.dataset
9
+
10
+ .. currentmodule:: eegdash.dataset
11
+
12
+ EEG Dash Datasets
13
+ ==================
14
+
15
+
16
+ Columns definitions:
17
+ - **dataset**: Name of the dataset.
18
+ - **n_records**: Number of EEG records in the dataset.
19
+ - **n_subjects**: Number of subjects in the dataset.
20
+ - **n_tasks**: Number of experimental tasks in the dataset.
21
+ - **nchans_set**: Set of EEG channel counts used in the dataset.
22
+ - **sampling_freqs**: Set of sampling frequencies used in the dataset.
23
+ - **duration_hours_total**: Total duration of all recordings in hours.
24
+
25
+
26
+ Datasets
27
+ ======================
28
+
29
+ .. csv-table::
30
+ :file: ../build/dataset_summary.csv
31
+ :header-rows: 1
32
+ :class: sortable
33
+
34
+
35
+
36
+ .. raw:: html
37
+ <style>
38
+ /* Make this page full-width and remove side padding */
39
+ :root {
40
+ --pst-page-max-width: 100%;
41
+ --pst-content-max-width: 100%;
42
+ }
43
+ .bd-main .bd-content .bd-article-container {
44
+ max-width: 100%;
45
+ padding-left: 0;
46
+ padding-right: 0;
47
+ }
48
+ /* Ensure the DataTable uses the full width */
49
+ table.sortable { width: 100% !important; }
50
+ </style>
51
+
52
+ <link href="https://cdn.datatables.net/v/bm/jq-3.7.0/dt-2.3.2/af-2.7.0/b-3.2.4/b-html5-3.2.4/cr-2.1.1/fh-4.0.3/r-3.0.5/datatables.min.css"
53
+ rel="stylesheet"
54
+ integrity="sha384-aemAM3yl2c0KAZZkR1b1AwMH2u3r1NHOppsl5i6Ny1L5pfqn7SDH52qdaa1TbyN9"
55
+ crossorigin="anonymous">
56
+
57
+ <script src="https://cdn.datatables.net/v/bm/jq-3.7.0/dt-2.3.2/af-2.7.0/b-3.2.4/b-html5-3.2.4/cr-2.1.1/fh-4.0.3/r-3.0.5/datatables.min.js"
58
+ integrity="sha384-CKcCNsP1rMRsJFtrN6zMWK+KIK/FjYiV/d8uOp0LZtbEVzbidk105YcuVncAhBR8"
59
+ crossorigin="anonymous"></script>
60
+
61
+ <script>
62
+ document.addEventListener('DOMContentLoaded', function () {
63
+ const tables = document.querySelectorAll('table.sortable');
64
+ tables.forEach(function (tbl) {
65
+ // Use the jQuery plugin that ships in the bundle
66
+ $(tbl).DataTable({
67
+ paging: false,
68
+ searching: false,
69
+ info: false,
70
+ ordering: true,
71
+ responsive: true,
72
+ fixedHeader: true,
73
+ // Avoid re-initialization if this script runs more than once
74
+ retrieve: true,
75
+ scrollX: true
76
+ });
77
+ });
78
+ });
79
+ </script>
80
+
@@ -0,0 +1,56 @@
1
+ :html_theme.sidebar_secondary.remove:
2
+
3
+ EEGDASH Documentation
4
+ =====================
5
+
6
+ .. title:: EEG Dash
7
+
8
+ .. raw:: html
9
+
10
+ <style type="text/css">h1 {display:none;}</style>
11
+
12
+ EEG Dash Homepage
13
+ ==================
14
+
15
+ .. image:: _static/logos/eegdash.png
16
+ :alt: EEG Dash Logo
17
+ :class: logo mainlogo
18
+ :align: center
19
+ :scale: 40%
20
+
21
+
22
+ .. rst-class:: h4 text-center font-weight-light my-4
23
+
24
+ The EEG-DaSh data archive will establish a data-sharing resource for MEEG (EEG, MEG) data, enabling
25
+ large-scale computational advancements to preserve and share scientific data from publicly funded
26
+ research for machine learning and deep learning applications.
27
+
28
+ .. raw:: html
29
+
30
+ <h2 style="text-align: center;">Institutions</h2>
31
+
32
+
33
+ .. list-table::
34
+ :width: 100%
35
+ :class: borderless logos-row
36
+
37
+ * - .. image:: _static/logos/ucsd_white.png
38
+ :alt: University of California, San Diego (UCSD)
39
+ :class: logo mainlogo
40
+ :align: center
41
+ :width: 100%
42
+
43
+ - .. image:: _static/logos/bgu_white.png
44
+ :alt: Ben-Gurion University of the Negev (BGU)
45
+ :class: logo mainlogo
46
+ :align: center
47
+ :width: 100%
48
+
49
+ .. toctree::
50
+ :hidden:
51
+
52
+ Install <install/install>
53
+ API <api/modules.rst>
54
+ Dataset Summary <dataset_summary>
55
+ Examples <generated/auto_examples/index>
56
+
@@ -0,0 +1,77 @@
1
+ .. _installation:
2
+
3
+ ================
4
+ Installation
5
+ ================
6
+
7
+ EEGDash is written in Python 3, specifically for version 3.8 or above.
8
+
9
+ The package is distributed via Python package index (`PyPI <eegdash-pypi_>`_), and you can access the
10
+ source code via `Github <eegdash-github_>`_ repository.
11
+
12
+ There are different ways to install EEGDash, depending on your needs and:
13
+
14
+
15
+ .. grid:: 2
16
+
17
+ .. grid-item-card::
18
+ :text-align: center
19
+
20
+ .. rst-class:: font-weight-bold mb-0
21
+
22
+ Install via ``pip``
23
+
24
+ .. rst-class:: card-subtitle text-muted mt-0
25
+
26
+ For Beginners
27
+
28
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
29
+ .. image:: /_static/eegdash_install.gif
30
+ :alt: EEGDash Installer with pip
31
+
32
+ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
33
+
34
+
35
+ .. button-ref:: install_pip
36
+ :ref-type: ref
37
+ :color: primary
38
+ :shadow:
39
+ :class: font-weight-bold
40
+
41
+ Installing from PyPI
42
+
43
+
44
+ .. grid-item-card::
45
+ :text-align: center
46
+
47
+ .. rst-class:: font-weight-bold mb-0
48
+
49
+ Building from source code
50
+
51
+ .. rst-class:: card-subtitle text-muted mt-0
52
+
53
+ For Advanced Users
54
+
55
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
56
+ .. image:: https://mne.tools/stable/_images/mne_installer_console.png
57
+ :alt: Terminal Window
58
+
59
+ **Already familiar with Python?**
60
+ Follow our setup instructions for building from Github and start to contribute!
61
+ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
62
+
63
+ .. button-ref:: install_source
64
+ :ref-type: ref
65
+ :color: primary
66
+ :shadow:
67
+ :class: font-weight-bold
68
+
69
+ From Source Code
70
+
71
+ .. toctree::
72
+ :hidden:
73
+
74
+ install_pip
75
+ install_source
76
+
77
+ .. include:: /links.inc
@@ -0,0 +1,19 @@
1
+ .. _install_pip:
2
+
3
+ Installing from PyPI
4
+ ~~~~~~~~~~~~~~~~~~~~
5
+
6
+ EEGDash can be installed via pip from `PyPI <eegdash-pypi_>`_.
7
+
8
+ .. note::
9
+ We recommend the most updated version of pip to install from PyPI.
10
+
11
+ Below are the installation commands for the most common use cases.
12
+
13
+ .. code-block:: bash
14
+
15
+ pip install eegdash
16
+
17
+ This will install the eegdash package and its dependencies.
18
+
19
+ .. include:: /links.inc
@@ -0,0 +1,80 @@
1
+ .. _install_source:
2
+
3
+ Installing from sources
4
+ ~~~~~~~~~~~~~~~~~~~~~~~
5
+
6
+ If you want to test features under development or contribute to the library, or if you want to test the new tools that have been tested in EEGDash and not released yet, this is the right tutorial for you!
7
+
8
+ .. note::
9
+
10
+ If you are only trying to install EEGDash, we recommend the :doc:`Installing from PyPI </install/install_pip>` section for details on that.
11
+
12
+
13
+
14
+ Install preview version from PyPI
15
+ ----------------------------------
16
+
17
+
18
+ .. code-block:: bash
19
+
20
+ pip install --pre eegdash
21
+
22
+ You should will install the version of `eegdash` that is currently under development at main branch, which may not be stable.
23
+
24
+
25
+ Install directly from repository from GitHub
26
+ --------------------------------------------
27
+
28
+ Let's suppose that you want to install EEGDash from the source. The first thing you should do is clone the EEGDash repository to your computer and enter inside the repository.
29
+
30
+ .. code-block:: bash
31
+
32
+ git clone https://github.com/sccn/EEGDash && cd EEGDash
33
+
34
+ You should now be in the root directory of the EEGDash repository.
35
+
36
+ Installing EEGDash from the source with pip
37
+ -------------------------------------------
38
+
39
+ If you want to only install EEGDash from source once and not do any development
40
+ work, then the recommended way to build and install is to use ``pip``
41
+
42
+ For the latest development version, directly from GitHub:
43
+
44
+ .. code-block:: bash
45
+
46
+ pip install git+https://github.com/sccn/EEGDash.git
47
+
48
+ If you have a local clone of the EEGDash git repository:
49
+
50
+ .. code-block:: bash
51
+
52
+ pip install -e .
53
+
54
+ This will install EEGDash in editable mode, i.e., changes to the source code could be used
55
+ directly in python.
56
+
57
+ You could also install optional dependency, like to import datasets from `test` and `docs`.
58
+
59
+ .. code-block:: bash
60
+
61
+ pip install -e .[test,docs,dev]
62
+
63
+ There is also optional dependencies for unit testing and building documentation, you could install
64
+ them if you want to contribute to EEGDash.
65
+
66
+ .. code-block:: bash
67
+
68
+ pip install -e .[all]
69
+
70
+
71
+ Testing if your installation is working
72
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
73
+
74
+ To verify that EEGDash is installed and running correctly, run the following command:
75
+
76
+ .. code-block:: console
77
+
78
+ python -m "import eegdash; eegdash.__version__"
79
+
80
+ .. include:: /links.inc
@@ -7,4 +7,4 @@ __init__mongo_client()
7
7
 
8
8
  __all__ = ["EEGDash", "EEGDashDataset", "EEGChallengeDataset"]
9
9
 
10
- __version__ = "0.3.3.dev178374711"
10
+ __version__ = "0.3.4.dev69"
@@ -2,10 +2,12 @@ import json
2
2
  import logging
3
3
  import os
4
4
  import re
5
+ import warnings
5
6
  from pathlib import Path
6
7
  from typing import Any
7
8
 
8
9
  import mne
10
+ import mne_bids
9
11
  import numpy as np
10
12
  import pandas as pd
11
13
  import s3fs
@@ -174,7 +176,16 @@ class EEGDashBaseDataset(BaseDataset):
174
176
  self._download_dependencies()
175
177
  self._download_s3()
176
178
  if self._raw is None:
177
- self._raw = mne.io.read_raw(fname=self.bidspath, verbose=False)
179
+ # capturing any warnings
180
+ # to-do: remove this once is fixed on the mne-bids side.
181
+ with warnings.catch_warnings(record=True) as w:
182
+ self._raw = mne_bids.read_raw_bids(
183
+ bids_path=self.bidspath, verbose="ERROR"
184
+ )
185
+ for warning in w:
186
+ logger.warning(
187
+ f"Warning while reading BIDS file: {warning.message}"
188
+ )
178
189
 
179
190
  # === BaseDataset and PyTorch Dataset interface ===
180
191
 
@@ -0,0 +1,255 @@
1
+ dataset,n_records,n_subjects,n_tasks,nchans_set,sampling_freqs,duration_hours_total
2
+ ds002718,18,18,1,74,250,14.844
3
+ ds005505,1342,136,10,129,500,125.366
4
+ ds004745,6,6,1,,1000,0.0
5
+ ds005514,2885,295,10,129,500,213.008
6
+ ds005512,2320,257,10,129,500,196.205
7
+ ds005510,1227,135,10,129,500,112.464
8
+ ds005511,3100,381,10,"6,129",500,285.629
9
+ ds005509,3326,330,10,129,500,274.559
10
+ ds005508,3342,324,10,129,500,269.281
11
+ ds005507,1812,184,10,129,500,168.649
12
+ ds005506,1405,150,10,129,500,127.896
13
+ ds004854,1,1,1,64,128,0.535
14
+ ds004853,1,1,1,64,128,0.535
15
+ ds004844,68,17,1,64,1024,21.252
16
+ ds004843,92,14,1,64,256,29.834
17
+ ds004842,102,14,1,64,256,20.102
18
+ ds004852,1,1,1,64,128,0.535
19
+ ds004851,1,1,1,64,128,0.535
20
+ ds004850,1,1,1,64,128,0.535
21
+ ds004855,1,1,1,64,128,0.535
22
+ ds004849,1,1,1,64,128,0.535
23
+ ds004841,147,20,1,64,256,29.054
24
+ ds004661,17,17,1,64,128,10.137
25
+ ds004660,42,21,1,32,"2048,512",23.962
26
+ ds004657,119,24,1,64,"1024,8192",27.205
27
+ ds004362,1526,109,1,64,"128,160",48.592
28
+ ds004010,24,24,1,64,1000,26.457
29
+ ds002181,226,226,1,125,500,7.676
30
+ ds004554,16,16,1,99,1000,0.024
31
+ ds005697,50,50,1,"65,69",1000,77.689
32
+ ds004350,240,24,5,64,256,41.265
33
+ ds004785,17,17,1,32,500,0.019
34
+ ds004504,88,88,1,19,500,19.608
35
+ ds004635,55,55,1,129,1000,20.068
36
+ ds005787,448,19,1,"64,66","1000,500",23.733
37
+ ds005079,60,1,15,65,500,3.25
38
+ ds005342,32,32,1,17,250,33.017
39
+ ds005034,100,25,2,129,1000,37.525
40
+ ds002680,350,14,1,31,1000,21.244
41
+ ds003805,1,1,1,19,500,0.033
42
+ ds003838,130,65,2,63,1000,136.757
43
+ ds002691,20,20,1,32,250,6.721
44
+ ds003690,375,75,3,"64,66",500,46.771
45
+ ds004040,4,2,1,64,512,4.229
46
+ ds003061,39,13,1,79,256,8.196
47
+ ds005672,3,3,1,"65,69",1000,4.585
48
+ ds005410,81,81,1,63,1000,22.976
49
+ ds003753,25,25,1,64,500,10.104
50
+ ds005565,24,24,1,,500,11.436
51
+ ds002893,52,49,1,33,"250,250.0293378038558",36.114
52
+ ds002578,2,2,1,256,256,1.455
53
+ ds005089,36,36,1,63,1000,68.82
54
+ ds003822,25,25,1,64,500,12.877
55
+ ds003670,62,25,1,32,2000,72.772
56
+ ds005048,35,35,1,,250,5.203
57
+ ds004574,146,146,1,"63,64,66",500,31.043
58
+ ds004519,40,40,1,62,250,0.067
59
+ ds004602,546,182,3,128,"250,500",87.11
60
+ ds004784,6,1,6,128,512,0.518
61
+ ds004771,61,61,1,34,256,0.022
62
+ ds003518,137,110,1,64,500,89.888
63
+ ds005207,39,20,1,"6,10,12,14,15,16,17,18","128,250",422.881
64
+ ds005866,60,60,1,,500,15.976
65
+ ds003523,221,91,1,64,500,84.586
66
+ ds004347,48,24,1,64,"128,512",6.389
67
+ ds004588,42,42,1,24,300,4.957
68
+ ds005811,448,19,1,62,"1000,500",23.733
69
+ ds003987,69,23,1,64,500.0930232558139,52.076
70
+ ds004317,50,50,1,60,500,37.767
71
+ ds004033,36,18,2,64,500,42.645
72
+ ds004315,50,50,1,60,500,21.104
73
+ ds003474,122,122,1,64,500,36.61
74
+ ds003509,84,56,1,64,500,48.535
75
+ ds005868,48,48,1,,500,13.094
76
+ ds003516,25,25,1,47,500,22.57
77
+ ds004942,62,62,1,65,1000,28.282
78
+ ds004348,18,9,2,34,200,35.056
79
+ ds004625,543,32,9,120,500,28.397
80
+ ds003517,34,17,1,64,500,13.273
81
+ ds004368,40,39,1,63,128,0.033
82
+ ds004584,149,149,1,"63,64,66",500,6.641
83
+ ds003506,84,56,1,64,500,35.381
84
+ ds003570,40,40,1,64,2048,26.208
85
+ ds003490,75,50,1,64,500,12.76
86
+ ds004117,85,23,1,69,"1000,250,500,500.059",15.941
87
+ ds004505,25,25,1,120,250,30.398
88
+ ds004580,147,147,1,"63,64,66",500,36.514
89
+ ds004532,137,110,1,64,500,49.651
90
+ ds004902,218,71,2,61,"500,5000",18.118
91
+ ds004295,26,26,1,66,"1024,512",34.313
92
+ ds003519,54,27,1,64,500,20.504
93
+ ds003458,23,23,1,64,500,10.447
94
+ ds003004,34,34,1,"134,180,189,196,201,206,207,208,209,211,212,213,214,215,218,219,220,221,222,223,224,226,227,229,231,232,235",256,49.072
95
+ ds004200,20,20,1,37,1000,14.123
96
+ ds004015,36,36,1,18,500,47.29
97
+ ds004595,53,53,1,64,500,17.078
98
+ ds004626,52,52,1,68,1000,21.359
99
+ ds004475,30,30,1,"113,115,118,119,120,122,123,124,125,126,127,128",512,26.899
100
+ ds004515,54,54,1,64,500,20.61
101
+ ds004883,516,172,3,128,500,137.855
102
+ ds003739,120,30,4,128,256,20.574
103
+ ds004389,260,26,4,42,10000,30.932
104
+ ds004367,40,40,1,68,1200,24.81
105
+ ds004369,41,41,1,4,500,37.333
106
+ ds004579,139,139,1,"63,64,66",500,55.703
107
+ ds005416,23,23,1,64,1000,24.68
108
+ ds001785,54,18,3,63,"1000,1024",14.644
109
+ ds001971,273,20,1,108,512,46.183
110
+ ds004388,399,40,3,67,10000,43.327
111
+ ds003478,243,122,1,64,500,23.57
112
+ ds004306,15,12,1,124,1024,18.183
113
+ ds005305,165,165,1,64,"2048,512",14.136
114
+ ds005114,223,91,1,64,500,125.701
115
+ ds003039,16,16,1,64,500,14.82
116
+ ds003602,699,118,6,35,1000,159.35
117
+ ds003655,156,156,1,19,500,130.923
118
+ ds003522,200,96,1,64,500,57.079
119
+ ds003801,20,20,1,24,250,13.689
120
+ ds005296,62,62,1,,500,37.205
121
+ ds004561,23,23,1,62,10000,11.379
122
+ ds005131,63,58,2,64,500,52.035
123
+ ds005028,66,11,3,,,0.0
124
+ ds005170,225,5,1,,,0.0
125
+ ds004840,51,9,3,8,"1024,256,512",11.306
126
+ ds004718,51,51,1,64,1000,21.836
127
+ ds002725,105,21,5,30,1000,0.0
128
+ ds004408,380,19,1,128,512,20.026
129
+ ds004796,235,79,3,,1000,0.0
130
+ ds004511,134,45,3,139,3000,48.922
131
+ ds004817,20,20,1,63,1000,0.0
132
+ ds003190,280,19,1,0,256,29.891
133
+ ds004917,24,24,1,,,0.0
134
+ ds004357,16,16,1,63,1000,0.0
135
+ ds005397,26,26,1,64,500,27.923
136
+ ds003846,60,19,1,64,500,24.574
137
+ ds004024,497,13,3,64,20000,55.503
138
+ ds005815,137,26,4,30,"1000,500",38.618
139
+ ds005429,61,15,3,64,"2500,5000",14.474
140
+ ds003702,47,47,1,61,500,0.0
141
+ ds004577,130,103,1,"19,21,24",200,22.974
142
+ ds003574,18,18,1,64,500,0.0
143
+ ds005779,250,19,16,"64,67,70",5000,16.65
144
+ ds005185,356,20,3,8,500,0.0
145
+ ds001787,40,24,1,64,256,27.607
146
+ ds003505,37,19,2,128,2048,0.0
147
+ ds005340,15,15,1,2,10000,35.297
148
+ ds005363,43,43,1,64,1000,43.085
149
+ ds005121,39,34,1,58,512,41.498
150
+ ds004256,53,53,2,64,500,42.337
151
+ ds005420,72,37,2,20,500,5.485
152
+ ds002034,167,14,4,64,512,37.248
153
+ ds003825,50,50,1,"63,128",1000,0.0
154
+ ds004587,114,103,1,59,10000,25.491
155
+ ds004598,20,9,1,,10000,0.0
156
+ ds005383,240,30,1,30,200,8.327
157
+ ds003195,20,10,2,19,200,4.654
158
+ ds005403,32,32,1,62,10000,13.383
159
+ ds004621,167,42,4,,1000,0.0
160
+ ds005863,357,127,4,27,500,0.0
161
+ ds005594,16,16,1,64,1000,12.934
162
+ ds002336,54,10,6,,5000,0.0
163
+ ds004043,20,20,1,63,1000,0.0
164
+ ds005106,42,42,1,32,500,0.012
165
+ ds004284,18,18,1,129,1000,9.454
166
+ ds005620,202,21,3,"64,65",5000,21.811
167
+ ds002720,165,18,10,19,1000,0.0
168
+ ds005307,73,7,1,"72,104",10000,1.335
169
+ ds002094,43,20,3,30,5000,18.593
170
+ ds002833,80,20,1,257,1000,11.604
171
+ ds002218,18,18,1,0,256,16.52
172
+ ds005021,36,36,1,64,1024,0.0
173
+ ds004264,21,21,1,31,1000,0.0
174
+ ds004446,237,30,1,129,1000,33.486
175
+ ds004980,17,17,1,64,"499.9911824,499.9912809,499.991385,499.9914353,499.9914553,499.9915179,499.9917272,499.9917286,499.9917378,499.9919292,499.9919367,499.9923017,499.9923795,500",36.846
176
+ ds002722,94,19,5,32,1000,0.0
177
+ ds003944,82,82,1,61,"1000,3000.00030000003",6.999
178
+ ds004279,60,56,1,64,1000,53.729
179
+ ds005876,29,29,1,32,1000,16.017
180
+ ds003816,1077,48,8,127,1000,159.313
181
+ ds005385,3264,608,2,64,1000,169.62
182
+ ds004572,516,52,10,58,1000,52.624
183
+ ds005095,48,48,1,63,1000,16.901
184
+ ds004460,40,20,1,160,1000,27.494
185
+ ds005189,30,30,1,61,1000,0.0
186
+ ds005274,22,22,1,6,500,0.0
187
+ ds004075,116,29,4,,1000,0.0
188
+ ds004447,418,22,1,"128,129",1000,23.554
189
+ ds004952,245,10,1,128,1000,123.411
190
+ ds002724,96,10,4,32,1000,0.0
191
+ ds005571,45,24,2,64,5000,0.0
192
+ ds004262,21,21,1,31,1000,0.0
193
+ ds005273,33,33,1,63,1000,58.055
194
+ ds004520,33,33,1,62,250,0.055
195
+ ds004444,465,30,1,129,1000,55.687
196
+ ds004582,73,73,1,59,10000,34.244
197
+ ds002723,44,8,6,32,1000,0.0
198
+ ds003751,38,38,1,128,250,19.95
199
+ ds003421,80,20,1,257,1000,11.604
200
+ ds002158,117,20,1,,,0.0
201
+ ds004951,23,11,1,63,1000,29.563
202
+ ds004802,38,38,1,65,"2048,512",0.0
203
+ ds004816,20,20,1,63,1000,0.0
204
+ ds005873,2850,125,1,2,256,11935.09
205
+ ds003194,29,15,2,"19,21",200,7.178
206
+ ds004356,24,22,1,34,10000,0.0
207
+ ds004381,437,18,1,"4,5,7,8,10",20000,11.965
208
+ ds004196,4,4,1,64,512,1.511
209
+ ds005692,59,30,1,24,5000,112.206
210
+ ds002338,85,17,4,,5000,0.0
211
+ ds004022,21,7,1,"16,18",500,0.0
212
+ ds004603,37,37,1,64,1024,30.653
213
+ ds004752,136,15,1,"0,8,10,19,20,21,23","200,2000,4000,4096",0.302
214
+ ds003768,255,33,2,,,0.0
215
+ ds003947,61,61,1,61,"1000,3000.00030000003",5.266
216
+ ds005530,21,17,1,10,500,154.833
217
+ ds005555,256,128,1,"2,8,9,11,12,13",256,2002.592
218
+ ds004477,9,9,1,79,2048,13.557
219
+ ds005688,89,20,5,4,"10000,20000",2.502
220
+ ds003766,124,31,4,129,1000,39.973
221
+ ds005540,103,59,1,64,"1200,600",0.0
222
+ ds004152,21,21,1,31,1000,0.0
223
+ ds003626,30,10,1,,,0.0
224
+ ds002814,168,21,1,68,1200,0.0
225
+ ds003645,108,18,1,,,0.0
226
+ ds005586,23,23,1,60,1000,33.529
227
+ ds003810,50,10,1,15,125,0.0
228
+ ds003969,392,98,4,64,"1024,2048",66.512
229
+ ds004000,86,43,2,128,2048,0.0
230
+ ds004995,20,20,1,,,0.0
231
+ ds003638,57,57,1,64,512,40.597
232
+ ds004521,34,34,1,62,250,0.057
233
+ ds001849,120,20,1,30,5000,0.0
234
+ ds004252,1,1,1,,,0.0
235
+ ds004448,280,56,1,129,1000,43.732
236
+ ds005795,39,34,2,72,500,0.0
237
+ ds004018,32,16,1,63,1000,0.0
238
+ ds004324,26,26,1,28,500,19.216
239
+ ds003887,24,24,1,128,1000,0.0
240
+ ds004860,31,31,1,32,"2048,512",0.0
241
+ ds002721,185,31,6,19,1000,0.0
242
+ ds003555,30,30,1,,1024,0.0
243
+ ds005486,445,159,1,,"25000,5000",0.0
244
+ ds005520,69,23,3,67,1000,60.73
245
+ ds005262,186,12,1,,,0.0
246
+ ds002778,46,31,1,40,512,2.518
247
+ ds003885,24,24,1,128,1000,0.0
248
+ ds005406,29,29,1,63,1000,15.452
249
+ ds003710,48,13,1,32,5000,9.165
250
+ ds003343,59,20,1,16,500,6.551
251
+ ds005345,26,26,1,64,500,0.0
252
+ ds004067,84,80,1,63,2000,0.0
253
+ ds001810,263,47,1,64,512,91.205
254
+ ds005515,2516,533,8,129,500,198.849
255
+ ds005516,3397,430,8,129,500,256.932
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: eegdash
3
- Version: 0.3.3.dev178374711
3
+ Version: 0.3.4.dev69
4
4
  Summary: EEG data for machine learning
5
5
  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>
6
6
  License-Expression: GPL-3.0-only
@@ -1,11 +1,20 @@
1
1
  LICENSE
2
+ MANIFEST.in
2
3
  README.md
3
4
  pyproject.toml
5
+ docs/Makefile
6
+ docs/source/conf.py
7
+ docs/source/dataset_summary.rst
8
+ docs/source/index.rst
9
+ docs/source/install/install.rst
10
+ docs/source/install/install_pip.rst
11
+ docs/source/install/install_source.rst
4
12
  eegdash/__init__.py
5
13
  eegdash/api.py
6
14
  eegdash/data_config.py
7
15
  eegdash/data_utils.py
8
16
  eegdash/dataset.py
17
+ eegdash/dataset_summary.csv
9
18
  eegdash/mongodb.py
10
19
  eegdash/preprocessing.py
11
20
  eegdash/registry.py
@@ -100,6 +100,7 @@ all = [
100
100
 
101
101
  [tool.setuptools]
102
102
  py-modules = []
103
+ include-package-data = true
103
104
 
104
105
  [tool.setuptools.dynamic]
105
106
  version = {attr = "eegdash.__version__"}
@@ -110,6 +111,9 @@ include = ["eegdash*"]
110
111
  exclude = []
111
112
  namespaces = false
112
113
 
114
+ [tool.setuptools.package-data]
115
+ eegdash = ["dataset_summary.csv"]
116
+
113
117
  [tool.ruff]
114
118
  lint.ignore-init-module-imports = true
115
119
  line-length = 88