diff --git a/Home.md b/Home.md index ad10508..2764877 100644 --- a/Home.md +++ b/Home.md @@ -3,7 +3,7 @@ Welcome to the Wiki for FLARES (fNIRS Lightweight, Analysis, Research, & Evaluat # Getting Started # In order to use FLARES, you will need a device with the following hardware specifications: -- OS: Windows 10/11 (64-Bit), Ubuntu 22.04/24.04 (64-Bit), MacOS Ventura/Sonoma/Sequoia/Tahoe (x64/ARM64) or newer +- OS: Windows 10/11 (64-Bit), Ubuntu 22.04/24.04/26.04 (64-Bit), MacOS Ventura/Sonoma/Sequoia/Tahoe (x64/ARM64) or newer - Processor: Intel Core i7 Skylake, Ryzen 7 2nd Gen, Apple M1 or newer - Memory: 16 GB RAM or more - Storage: 4 GB of available space, SSD recommended @@ -23,7 +23,7 @@ Once FLARES opens, you will be greeted with a welcome popup that will contain al These names will be reused throughout the Wiki to refer to content present in these physical locations. ## Navigation Bar ## -The navigation bar stores most of the actions that you will want to use. There are 6 buttons available and all of them have submenus. Here is a high level overview of the buttons and what they do: +The navigation bar stores most of the actions that you will want to use. There are 7 buttons available and all of them have submenus. Here is a high level overview of the buttons and what they do: - File - Open File... - Opens a singular .snirf file into the application and loads adjacent metadata (if applicable) - Open Folder... - Opens all .snirf files from a singular folder into the application and loads adjacent metadata (if applicable). This supports the BIDS structure for storing .snirf files. @@ -42,7 +42,7 @@ The navigation bar stores most of the actions that you will want to use. There a - Reset Window Layout - Resets the dimensions of the File Information, Loaded Files, and Parameters areas to their default layout - Options - User Guide - Opens a pop-up window containing some information about processing stages - - Regroup Files from Metadata - Opens a pop-up window that allow for abatch assignment of groups based on other metadata such as age or sex + - Regroup Files from Metadata - Opens a pop-up window that allow for batch assignment of groups based on other metadata such as age or sex - Check for updates... - Checks the Git repository for any available updates. If an update is found, it is downloaded and extracted automatically - Show Update Changelog - Pops out the update changelog in a new window - Update events in snirf file (BORIS)... - See Updating Events in SNIRF File (BORIS) @@ -51,16 +51,20 @@ The navigation bar stores most of the actions that you will want to use. There a - Reset to Default Configuration - Resets all saved Preferences, Window Layout, and Recent Files / Projects back to their original values - About - Pops out information about the application in a new window - Preferences + - Theme - Contains three options for setting the theme of the application: Auto, Light, and Dark. Auto will use your current OS theme - 2D Data Bypass - TBD - Incompatible Save Bypass - TBD - Missing Events Bypass - TBD - Analysis Clearing Bypass - TBD - Folding Bypass - TBD + - Show Advanced Parameters - Enables visibility of advanced parameters in the Parameters area +- Plugins + - Manage Plugins... - Opens the plugin manager window to allow for downloading plugins - Terminal - New Terminal... - Opens a text based terminal to interact with the software using commands ## File Information ## -This area is designated to providing information about a singular file. For information to be visible here, a file has to be loaded using File > Open File or File > Open Folder. Once a file has been opened and finishes initial processing, it will be visible in the Loaded files area. Selecting this file with a left click will cause generic information to be visible in the File Information area. This includes: +This area is designated to providing information about a singular file. For information to be visible here, a file has to be loaded using File > Open File, File > Open Folder, or via dragging and dropping a file/folder onto this area. Once a file has been opened and finishes initial processing, it will be visible in the Loaded files area. Selecting this file with a left click will cause generic information to be visible in the File Information area. This includes: - File name - Name of the loaded file - File size - Size of the file in bytes @@ -77,7 +81,7 @@ On top of this generic information, there is also some data that is unique to SN If the data loaded was in the BIDS structure and does contain metadata about the .snirf files such as age, sex, or handiness, this will also be present to view under BIDS - (value). This information panel is purely for validation purposes and it is not possible to change any of the values from this area since this is data from inside the file that was made when the file was created, or parsed from the adjacent metadata. -There are four parameters that are added to the right of the File information area once a file has been selected that can be changed. None of these additional parameters are required to be set for the analysis to function. These parameters will be automatically populated from the adjacent metadata, but can be modified here unlike in the view-only File Information panel. These parameters are: +There are four parameters that are added to the right of the File information area that can be changed once a file has been selected. None of these additional parameters are required to be set for the analysis to function. These parameters will be automatically populated from the adjacent metadata, but can be modified here unlike in the view-only File Information panel. These parameters are: - Age - Used to calculate the DPF of the participant. If Age is not specified, the value will be set to `25` automatically to create a generic DPF value - Sex - Used to assist in the generation of groups based on the participants sex - Hand - Used to assist in the generation of groups based on the participants dominant hand