Getting started with Homer3

Installing and running Homer3 from source in MATLAB

Homer3 is open source MATLAB software and can easily be run from source with an installation of the MATLAB interpreter. The recommended MATLAB version is R2020b (9.9).

Download the latest Homer3 release from GitHub

The source code is available as a zip file. You must download the file titled homer3_install_<version number>_src.zip. DO NOT use the archive titled simply "Source code" as it will not contain the required submodules.

Open MATLAB and in the command window, change the current folder to the Homer3 root folder that you downloaded. In the MATLAB command window, run

setpaths

This will add the Homer3 functions to the PATH of your MATLAB instance. This needs to be repeated each time you start MATLAB.

To launch the Homer3 GUI, run

Homer3;

Next, navigate to a subject folder and select to open it.

Homer3 will ask you to choose a processing options config file. If you do not have one to select, click the CANCEL button and a default config file will be generated for you.

Installing and running Homer3 if you do NOT have MATLAB

Homer3 can be used via the MATLAB Runtime Environment if you do not own a MATLAB license.

Windows:

• Download and install the 64-bit MATLAB Runtime R2020b (9.9) for Windows from the MathWorks website. Other versions of the MATLAB Runtime will not work!
• Download the latest Homer3 release from GitHub. Be sure to download the .zip file that matches your platform! It will be titled homer3_install_<version>_win_R2020b.zip.
• Navigate to the homer3_install folder you have just downloaded and unzipped.
• Double click on the file setup.bat. This should start the installation process. When it finishes you should see a Homer3 icon on your Desktop.
• You can now execute Homer3 by double clicking the Homer3 icon on the desktop.

Mac:

Modern MacOS security features may prevent you from running the Homer3 installation executable. To circumvent them:

• Open Terminal and execute the following command:

sudo spctl --master-disable

• Open System Preferences and navigate to System & Privacy / General
• Click the lock symbol at the bottom of the dialog and then select "Anywhere."

You will need administrator privileges on the Mac you are using to do this. If you cannot get them, you will need to run Homer3 from source in MATLAB or install it via a Windows virtual machine.

To install and run Homer3:

• Download and install the 64-bit MATLAB Runtime R2020b (9.9) for Mac from the MathWorks website. Other versions of the MATLAB Runtime will not work!
• Download the latest Homer3 release from GitHub. Be sure to download the .zip file that matches your platform! It will be titled homer3_install_<version>_mac_R2020b.zip.
• In Finder, navigate to the homer3_install folder you have just downloaded and unzipped.
• Double click on the file setup.command. This should start the installation process. When it finishes you should see a Homer3 icon on your Desktop.
• You can now execute Homer3 by double clicking the Homer3 icon on the desktop.

You will be asked to choose a processing options config file. Select the only one available, test_process.cfg. Once selected, Homer3 should generate and open the test.snirf file in the installation repository.

To navigate to a new group folder, use the File menu.