From 506eeb753dd8046ee8fa48ca426b283633e49e63 Mon Sep 17 00:00:00 2001 From: armitaf Date: Thu, 18 Jul 2024 09:01:35 +0000 Subject: [PATCH] Update README.md Installation improvement --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f250b6b..fb471f6 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,17 @@ # EStiMo + +## Overview EStiMo is a sophisticated software developed for the purpose of real-time monitoring during Transcranial Magnetic Stimulation (TMS) sessions. This is accomplished by conducting a real-time analysis of Electroencephalography (EEG) signals. Its operational mechanics are contingent on a suite of features that are computed online and visually represented on the display interface. The computation of these values takes place in between the trains of TMS. ## Installation -EStiMo is designed to be conveniently portable and as such, does not necessitate a typical installation procedure. However, the pre-requisite for running this software smoothly is a Python 3 environment, ideally version 3.8. Alongside Python, several other libraries are necessary for full functionality. To install all of them: +EStiMo is designed to be conveniently portable and as such, does not necessitate a typical installation procedure. However, the pre-requisite for running this software smoothly is a Python 3 environment, ideally version 3.8. Alongside Python, several other libraries are necessary for full functionality (requirements.txt). To install EStiMo, Clone the repository and install dependencies: ``` +git clone https://nugit.drcmr.dk/Tools/EStiMo.git +cd EStiMo pip install -r requirements.txt ``` +## Usage: The EStiMo package is comprised of 6 distinct Python script files namely: FirstWindow.py, Functions.py, NeurOne.py, RDA.py, and EStiMo_GUI.py. Additionally, there are certain auxiliary files that facilitate the running of the software. The 'TMS_protocol.txt' file includes the default settings for the application. The 'electrode_selection.txt' file contains the directories for files related to electrode placement. Lastly, the package also includes a csv file that possesses a square matrix, which is integral for defining the relationships between the various channels. ## Establishing Connection with NeurOne