From 55ffd9c300ba9d03455999876a6f2223e1338f6b Mon Sep 17 00:00:00 2001 From: John Griffiths Date: Tue, 5 Dec 2023 04:57:41 +0000 Subject: [PATCH] more of the same --- doc/misc/ntcs_phase1_instructions.md | 36 ++++++++++++++-------------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/doc/misc/ntcs_phase1_instructions.md b/doc/misc/ntcs_phase1_instructions.md index d0f9a1e4..26451ca5 100644 --- a/doc/misc/ntcs_phase1_instructions.md +++ b/doc/misc/ntcs_phase1_instructions.md @@ -2,13 +2,13 @@ Welcome to the **NeuroTech Challenge Series (NTCS)**, **Phase 1 (P1)** instructions page. -**NTCSP1** is an international citizen science research study, run by researchers at the University of Toronto and the [CAMH KCNI](www.krembilneuroinformatics.ca), in collaboration with [OpenBCI](https://openbci.com), [NeuroTechX](www.neurotechx.com), and the eeg-notebooks core developer team. +**NTCSP1** is an international citizen science research study, run by researchers at the University of Toronto and the [CAMH KCNI](www.krembilneuroinformatics.ca), in collaboration with [OpenBCI](https://openbci.com), [NeuroTechX](www.neurotechx.com), and the eeg-expy core developer team. If this is the first time you are learning about NTCS, check out the [NTCS website](https://neurotech-challenge.com/) for additional info about this and other upcoming challenges and opportunities. If you are ready to get going with NTCSP1, have been directed here by other comms from us, or would simply like to browse through to getter a better idea of what's involved, you are in the right place. -These instructions, and NTCS in general, also double up as an excellent practical introduction to the `eeg-notebooks` software. +These instructions, and NTCS in general, also double up as an excellent practical introduction to the `eeg-expy` software. **Have fun** and **thank you** for joining on NTCSP1! @@ -51,7 +51,7 @@ Videos 2-5 include live demos and discussions showing you the specific steps you [![ Running the N170 experiment, reviewing and uploading your data](http://img.youtube.com/vi/zYeNrSjNk5g/0.jpg)](https://youtu.be/zYeNrSjNk5g?t=1s "Running the N170 experiment, reviewing and uploading your data") -Additionally, you might be interested to check out **JG's [introductory lecture on eeg-notebooks](https://www.youtube.com/watch?v=C834sFQvL1c&t=103s)**. This is not mandatory however for NTCSP1. +Additionally, you might be interested to check out **JG's [introductory lecture on eeg-notebooks / eeg-expy ](https://www.youtube.com/watch?v=C834sFQvL1c&t=103s)**. This is not mandatory however for NTCSP1. [![ Intro to EEG Notebooks](http://img.youtube.com/vi/C834sFQvL1c/0.jpg)](https://youtu.be/C834sFQvL1c?t=1s "Intro to EEG-Notebooks") @@ -64,7 +64,7 @@ The end-to-end sequence of steps for participating in NTCS are as follows: - Register for the study by completing the **[informed consent form](https://is.gd/neurotech_ch)**. - **Check your e-mail**. This will give you a personalized link for uploading your recorded data. It will also give you these instructions. - **Install miniconda**. -- Set up your miniconda environment and **install eeg-notebooks**. +- Set up your miniconda environment and **install eeg-expy**. - **Setup your eeg-device** (See specific instructions for [OpenBCI](), [Muse](), [Neurosity](), [Gtec]() devices). - **Run the experiment** using the script prompts - Locate the recorded data on your local machine and **run the data zipper command** @@ -115,7 +115,7 @@ The consent form is located at this link: [https://is.gd/neurotech_ch](https://i ### 2. Check your e-mail. Check your inbox for the email address you provided in the consent form. This email includes instructions to run the experiment along with a unique link for you to upload your data. This email is unique to you. Please do not share it with anyone. You can use this link an infinite number of times to upload your data. Aside from the link, the rest of the instructions are the same for everyone and they are denoted below in this page for your reference as well. -When you click on the unique uploader link, you will be directed to a small form where you can upload your `.zip` file generated by eeg-notebooks securely to the CAMH servers. The data will be anonymized for further use and access. In this page, you will also answer a few anonymous questions regarding age, sex, and background neurological conditions. If you would like to upload another file, go back to your inbox and click on the link again, and rinse and repeat! +When you click on the unique uploader link, you will be directed to a small form where you can upload your `.zip` file generated by eeg-expy securely to the CAMH servers. The data will be anonymized for further use and access. In this page, you will also answer a few anonymous questions regarding age, sex, and background neurological conditions. If you would like to upload another file, go back to your inbox and click on the link again, and rinse and repeat! ### 3. Install miniconda Miniconda makes it easy to manage multiple different Python installations on the same machine. While using miniconda environments is not required, we strongly recommend it. @@ -125,18 +125,18 @@ Get the latest version of minconda: [https://docs.conda.io/en/latest/miniconda.h Installation instructions: [https://conda.io/projects/conda/en/latest/user-guide/install/index.html](https://conda.io/projects/conda/en/latest/user-guide/install/index.html) -### 4. Set up environment and install eeg-notebooks -Follow the instructions on this page of the eeg-notebooks docs -[https://neurotechx.github.io/eeg-notebooks/getting_started/installation.html](https://neurotechx.github.io/eeg-notebooks/getting_started/installation.html) +### 4. Set up environment and install eeg-expy +Follow the instructions on this page of the eeg-expy docs +[https://neurotechx.github.io/eeg-expy/getting_started/installation.html](https://neurotechx.github.io/eeg-expy/getting_started/installation.html) ``` conda create -n "ntcs" python=3.7 git pip wxpython conda activate ntcs -git clone https://github.com/NeuroTechX/eeg-notebooks +git clone https://github.com/NeuroTechX/eeg-expy -cd eeg-notebooks +cd eeg-expy pip install -e . ``` @@ -145,13 +145,13 @@ pip install -e . First, some general notes: -- We have some [general device and streaming notes](https://github.com/NeuroTechX/eeg-notebooks/blob/2ee42af999ed2d15626ea5865a2147791e1fbde7/doc/getting_started/streaming.md) -- Muse users should also check out the additional *muse device usage information* [here](https://github.com/NeuroTechX/eeg-notebooks/blob/master/doc/misc/muse_info.md). +- We have some [general device and streaming notes](https://github.com/NeuroTechX/eeg-expy/blob/2ee42af999ed2d15626ea5865a2147791e1fbde7/doc/getting_started/streaming.md) +- Muse users should also check out the additional *muse device usage information* [here](https://github.com/NeuroTechX/eeg-noteexpy/blob/master/doc/misc/muse_info.md). #### 5.1 Windows+Muse device users -EEG-Notebooks supports two general options for streaming data from muse devices in windows: `Brainflow` and `Bluemuse`. +EEG-ExPy supports two general options for streaming data from muse devices in windows: `Brainflow` and `Bluemuse`. Whilst `BlueMuse` is an excellent tool, the preferred option is `Brainflow`, as this is run directly within Python without having to manage an additional streaming tool. @@ -161,7 +161,7 @@ So you may need to take a trial-and-error approach here. Ideally the default option, Brainflow (with native bluetooth), will work well for you immediately, and there will be no need to read further on this topic. -The `eeg-notebooks` codes for the 3 currently available muse models are `muse2016`, `muse2`, and `museS`. +The `eeg-expy` codes for the 3 currently available muse models are `muse2016`, `muse2`, and `museS`. For each of these, there is the option to strean on either `muselsl` (via `BlueMuse`), `Brainflow` with *native* bluetooth, or `Brainflow` with *BLED dongle* bluetooth. For a muse 2 device, the codes for these three streaming options would be `muse2_bfn`, `muse2_bfb`, `muse2`. @@ -215,7 +215,7 @@ Turn on your EEG device, and put it on your head. Before starting data collection, you need to first verify that your readings have acceptable signal quality. -`eeg-notebooks` has a simple command-line program for this purpose. Launch it with +`eeg-expy` has a simple command-line program for this purpose. Launch it with `eegnb checksigqual -ed mydevice` @@ -273,7 +273,7 @@ The signal quality checker utility will cease when there are two successful 'goo #### 7.1 Take a look at what's there -When you have completed your recording session (or at any other time), you can check what data files you have recorded with eeg-notebooks using the following convenient command line utility: +When you have completed your recording session (or at any other time), you can check what data files you have recorded with eeg-expy using the following convenient command line utility: `eegnb checkdirs` @@ -296,7 +296,7 @@ Final step - go back to the e-mail you received after completing the consent for Congratulations~ You have completed Neurotech Challenge Phase 1. -As a bonus, you now have a working knowledge of how to run cognitive neuroscience experiments on your personal computer with your mobile EEG system. There are many other interesting experiments in `eeg-notebooks` that you might be interested to try out, and they're extremely easy to customize, modify, and extend. Follow your nose and have fun! +As a bonus, you now have a working knowledge of how to run cognitive neuroscience experiments on your personal computer with your mobile EEG system. There are many other interesting experiments in `eeg-expy` that you might be interested to try out, and they're extremely easy to customize, modify, and extend. Follow your nose and have fun! Also, drop us a line at `team@neurotech-challenge.com`, tell us how you found NTCS Phase 1. We'd love to hear from you~ @@ -317,5 +317,5 @@ This is a major gotcha. So much so we're listing it twice. If you are using Open ### Python is not 3.7 -- Python 3.8+ is not currently supported by `eeg-notebooks`. If you type `Python` and the prompt tells you it is not `Python 3.7`, and this was not something you indended, then something has gone wrong with your installation or environment setup. Go back and repeat the environment setup steps; if the issue persists, repeat the `miniconda` install steps. +- Python 3.8+ is not currently supported by `eeg-expy`. If you type `Python` and the prompt tells you it is not `Python 3.7`, and this was not something you indended, then something has gone wrong with your installation or environment setup. Go back and repeat the environment setup steps; if the issue persists, repeat the `miniconda` install steps.