Skip to content

Commit 4c4549c

Browse files
adding tools and editing CONTRIBUTING.md for quick venv setup (#763)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent cce27ca commit 4c4549c

File tree

3 files changed

+68
-4
lines changed

3 files changed

+68
-4
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,17 @@ For some quality checks and rare operations, you will need node.js and npm. -->
2828
Even though this is not required,
2929
having `make` installed will make it easier to easily serve the website locally.
3030

31+
### Quick setup with venv
32+
33+
For a minimal setup using Python's venv:
34+
35+
```bash
36+
python -m venv .venv
37+
source .venv/bin/activate # On Windows: .venv\Scripts\activate
38+
pip install -r requirements.txt
39+
mkdocs serve
40+
```
41+
3142
### Install and serve
3243

3344
Fork and clone the repository and its submodules

data/tools/converters.yml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -279,21 +279,25 @@
279279
comment: A tool for converting raw EEG and iEEG data into the BIDS standard data structure, prepared for LORIS (Longitudinal Online Research and Imaging
280280
System).
281281

282-
- name: EEGLAB
282+
- name: EEGLAB EEG-BIDS
283283
repo_url: https://github.com/sccn/eeglab
284284
status: active
285285
data_types:
286286
- MEG
287287
- EEG
288+
- iEEG
288289
expected_input:
289290
- EDF
290291
- BDF
291292
- Brain Vision Exchange Format
292293
- EEGLAB .set files
294+
- BIDS
293295
language:
294296
- MATLAB
297+
- Compiled
295298
documentation: https://eeglab.org/tutorials/04_Import/BIDS.html
296-
comment: <a href='https://github.com/arnodelorme/bids-MATLAB-tools'>See plugins</a>
299+
comment: EEGLAB with <a href='https://eeglab.org/plugins/EEG-BIDS/'>EEG-BIDS plugin</a> for importing and exporting BIDS datasets. Supports export to
300+
NWB format for iEEG data. A compiled standalone version is also available.
297301

298302
- name: Explore ASL
299303
repo_url: https://github.com/ExploreASL/ExploreASL

data/tools/tools.yml

Lines changed: 51 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,55 @@
3838
category: analysis
3939
description: MEG/EEG analysis package
4040

41+
- name: EEGLAB EEG-BIDS plugin
42+
repo_url: https://github.com/sccn/EEG-BIDS
43+
documentation: https://github.com/sccn/EEG-BIDS/wiki
44+
url: https://eeglab.org/plugins/EEG-BIDS/
45+
language:
46+
- MATLAB
47+
category: analysis
48+
description: EEGLAB plugin for importing and exporting BIDS-formatted experiments. Handles conversion from multiple data formats including EEGLAB .set
49+
files, EDF, BDF, and Brain Vision Exchange Format. Supports EEG, iEEG, and MEG data with export to NWB format for iEEG data.
50+
51+
- name: EEGBIDS standalone
52+
repo_url: https://github.com/sccn/EEG-BIDS
53+
documentation: https://github.com/sccn/EEG-BIDS/wiki
54+
url: https://eeglab.org/plugins/EEG-BIDS/
55+
language:
56+
- MATLAB
57+
- executable
58+
category: file handling
59+
description: Standalone compiled MATLAB version of the EEG-BIDS plugin with a graphic interface wizard. Available as part of the compiled EEGLAB distribution
60+
(EEGBIDS executable on Mac, EEGBIDS.bat on Windows). Does not require a paid MATLAB license. Allows importing and exporting BIDS-formatted EEG/MEG/iEEG
61+
data and converting BIDS to NWB format for iEEG data.
62+
63+
- name: EEGPrep
64+
repo_url: https://github.com/sccn/eegprep
65+
documentation: https://eegprep.org/
66+
url: https://eegprep.org/
67+
language:
68+
- Python
69+
category: analysis
70+
description: Python library to import and process BIDS datasets and output valid derivative BIDS. Implements the EEGLAB default pipeline in Python with
71+
Clean_rawdata and ICLabel for artifact removal, channel cleaning, and automated component classification. Made by the developers of EEGLAB.
72+
distribution:
73+
- name: pypi
74+
url: https://pypi.org/project/eegprep/
75+
76+
- name: EEGDash
77+
repo_url: https://github.com/sccn/EEG-Dash-Data
78+
documentation: https://eegdash.org/
79+
url: https://eegdash.org/
80+
language:
81+
- Python
82+
category: index and query
83+
description: Data-sharing resource for MEEG (EEG, MEG, iEEG) data enabling large-scale computational advancements. Aggregates datasets from 25 laboratories
84+
with over 27,000 participants including healthy subjects and clinical populations. Provides dataset catalog, search capabilities, and comprehensive
85+
API for programmatic access. Returns PyTorch Datasets for machine learning applications with support for BIDS-formatted datasets.
86+
distribution:
87+
- name: pypi
88+
url: https://pypi.org/project/eegdash/
89+
4190
- name: File mapper
4291
repo_url: https://github.com/DCAN-Labs/file-mapper
4392
language:
@@ -65,7 +114,7 @@
65114

66115
- name: Hierarchical Event Descriptors (HED) Python tools
67116
repo_url: https://github.com/hed-standard/hed-Python
68-
documentation: https://www.hed-resources.org
117+
documentation: https://www.hedtags.org/
69118
language:
70119
- Python
71120
category: data annotation
@@ -76,7 +125,7 @@
76125

77126
- name: Hierarchical Event Descriptors (HED) online tools
78127
url: https://hedtools.org/hed
79-
documentation: https://www.hed-resources.org
128+
documentation: https://www.hedtags.org
80129
language:
81130
- website
82131
category: data annotation

0 commit comments

Comments
 (0)