Getting Started (Setup)
Table of contents
Run the application
Open the executable file provided by Fraunhofer. If Windows gives a security warning, click “Run”. Note: You can always close and re-run NeuroWRAP using the executable if needed.
Log in to your user account provided by Fraunhofer.
Click “Open Dashboard”. This will open NeuroWRAP in your browser (URL should be: http://localhost:5000/#/).
Configure your runtime environment
We will need to set up your runtime interpreters so NeuroWRAP knows how to run MATLAB and/or Python. To set up: Click on “Settings” from the menu pane on the left to open the “Settings” page Click “Add Runtime” and follow the directions below for each runtime you wish to add
Note that Matlab modules in NeuroWRAP requires at least Matlab 2018 or newer.
On Windows
MATLAB Path
Open start menu, type cmd and press enter to open the command prompt. Type where Matlab and press enter, this will give you a list of your Matlab paths. Use the path to your latest MATLAB version.
Python Path
Open start menu, type cmd and press enter to open the command prompt. Type where python and press enter, this will give you a list of your python paths. Use your desired python path.
Conda Path
Open an Anaconda Prompt and type where python. Use the path to the Anaconda python exe, except omit the “python.exe”.
**NOTE: NeuroWRAP now uses Mamba as package manager when using Conda. Because of that, NeuroWRAP requires Mamba to be installed in Conda. To install it, open the Conda CLI/Prompt and type conda install -c conda-forge mamba
An example of a fully configured environment:
Configure directory shortcuts
This step is optional, but recommended
Set up some shortcuts to Execution Directories and Data Directories on your computer. A “Results directory” is where NeuroWRAP will store the results of a workflow. “Data Directories” act as shortcuts when you are picking data and files while setting up a workflow.
You can toggle the default location for Executions and Data Directories by clicking the “star” icon on the left of the directory name.
Useful Tip On the initial setup, the NeuroWRAP file/folder selector can only navigate within the C Drive. However it is possible to add path to folders located in drive other than the C Drive (e.g., Network drive, External drive) by entering their direct address/location in the “Path field” (e.g., D:\NeuroWRAP\Data). Once the path to the non-C Drive location has been added, NeuroWRAP can navigate within these non-C Drives.
Configure virtual environments
This step is optional, and generally not recommended
If you want to run python modules in specific pre-configured venv or conda environments, you can specify them in settings (i.e. “Add venv environment” button). However, the NeuroWRAP will automatically set up module-specific environments, so manual setup should not be needed in most cases.
Currently, it is not possible to remove/delete the virtual environments from the Settings page. This is to prevent situation where no suitable virtual environments are set up to run the python modules within NeuroWRAP.