Installation and Usage

The ER-detect toolbox is available as a Python package (with an optional graphical user interface) and as a Docker image.

Python Usage

1. First install ERdetect, in the command-line run:

pip install erdetect

2. To run:

• a) With a graphical user interface:

python -m erdetect ~/bids_data ~/output/ --gui

• b) From the commandline:

python -m erdetect ~/bids_data ~/output/ [--participant_label PARTICIPANT_LABEL [PARTICIPANT_LABEL ...]]

• c) To process a subset directly in a python script:

import erdetect
erdetect.process_subset('/bids_data_root/subj-01/ieeg/sub-01_run-06.edf', '/output_path/')

Docker Usage

To launch an instance of the container and analyse data in BIDS format, in the command-line interface/terminal:

docker run multimodalneuro/erdetect <bids_dir>:/data <output_dir>:/output [--participant_label PARTICIPANT_LABEL [PARTICIPANT_LABEL ...]]

For example, to run an analysis, type:

docker run -ti --rm \
-v /local_bids_data_root/:/data \
-v /local_output_path/:/output \
multimodalneuro/erdetect /data /output --participant_label 01