tyler/flares
2
0
Fork 0
Code Issues 16 Pull Requests Actions Packages Projects Releases 22 Wiki Activity

Update Home

tyler
2026-07-13 13:17:34 -07:00
parent 006b1f3e01
commit 2cda42f018
1 changed files with 21 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Home.md
+21 -8
@@ -8,24 +8,26 @@ In order to use FLARES, you will need a device with the following hardware speci
- Memory: 16 GB RAM or more
- Storage: 4 GB available space
Download the appropriate version from the [Releases](https://git.research.dezeeuw.ca/tyler/flares/releases) tab and extract the zip file once it has completed downloading. Once the folder has been extractes, run the "flares" executable. The first launch of FLARES will take some time, so please be patient. FLARES will automatically check and download available updates every time the application starts. If you do not want FLARES to perform this action, you can block the app in your devices firewall or set your internet options to be a metered connection.
Download the appropriate version from the [Releases](https://git.research.dezeeuw.ca/tyler/flares/releases) tab and extract the zip file once it has completed downloading. Once the folder has been extracted, run the "flares" executable. The first launch of FLARES will take some time, so please be patient. FLARES will automatically check and download available updates every time the application starts. If you do not want FLARES to perform this action, you can block the app in your devices firewall or set your internet options to be a metered connection. FLARES does not currently run on ARM powered Windows devices.
# Getting used to FLARES #
Once FLARES opens, you will be greeted with many options on the screen. To remain simple this guide will break down what is visible on the screen into four sections:
Once FLARES opens, you will be greeted with many options on the screen. To remain simple this guide will break down what is visible on the screen into four distinct sections:
- Navigation Bar (Top of screen)
- File Information (Top left area)
- Loaded files (Bottom left area)
- Loaded Files (Bottom left area)
- Parameters (Right area)
These names will be reused throughout the Wiki to refer to content in these physical locations.
## Navigation Bar ##
The navigation bar stores most of the actions that you will want to use. There are 5 buttons availabe 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 6 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 file into the application
- Open Folder... - Opens all files in a singular folder into the application
- Open File... - Opens a singular .snirf file into the application
- Open Folder... - Opens all .snirf files from a singular folder into the application
- Recent Files - Contains a list of the 10 most recent files opened by the application
- Load Project... - Loads an existing saved project created by FLARES
- Recent Projects - Contains a list of the 10 most recent projects opened by the application
- Save Project... - Saves all loaded files, parameters, and results into a single file that can be opened at a later time by FLARES
- Save Project As... - Same as above, but asks for the destination to save the project every time
- Exit - Exits the application
@@ -35,13 +37,24 @@ The navigation bar stores most of the actions that you will want to use. There a
- Paste - Pastes text from the clipboard
- View
- Toggle Status Bar - Turns on or off visibility of text notifications at the bottom of the application
- Reset Window Layout - Resets the dimensions of the File Information, Loaded Files, & Parameters to their default layout
- Options
- User Guide - Opens a pop-up window containing some information about processing stages
- 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)
- Update events in snirf file (BLAZES)... - See Updating Events in SNIRF File (BLAZES)
- Update optodes in snirf file... - See Updating Optodes in SNIRF File
- Update events in snirf file... - See Updating Events in SNIRF File
- 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
- 2D Data Bypass
- Incompatible Save Bypass
- Missing Events Bypass
- Analysis Clearing Bypass
- Folding Bypass
- Terminal
- New Terminal... - Opens a text based 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. Once a file has been opened and selected from the Loaded files area, generic information will be visible. This includes: