Installation via PyCharm

The installation process is tested on three x86_64 platforms:

  • Linux (Ubuntu 18.04)

  • Mac OS (High Sierra 10.13.6)

  • Windows 10

Prerequisites

The following software should be installed:

Note

The minimum system requirements for OpenNFT are 8 GB RAM, i5 CPU with 2 or 4 free cores for two modes of the software using 3 or 4 Matlab processes, respectively, which needs to be compromised with the neurofeedback study design complexity, computational demands and the repetition time of the data acquisition. The recommended system configuration is 16 GB RAM and i7 CPU with 4 free cores. The maximum number of Matlab processes is defined by the end-user and is limited by the local workstation capabilities.

Install OpenNFT

Create Project by cloning from GitHub repository

_images/pycharminstall_1.png

Link to the main repository,

https://github.com/OpenNFT/OpenNFT.git

or, if you plan to contribute to the project, create the fork repository and use your own link:

https://github.com/your_github_name/OpenNFT.git
_images/pycharminstall_2.png

Create Virtual Environment

To create the virtual environment, go to File -> Settings -> Project Interpreter

_images/pycharminstall_3.png

Set the new virtual environment location and choose the interpreter:

_images/pycharminstall_4.png

Install from Project Directory

Default installation

MATLAB will be found automatically

pip install -U pip setuptools wheel
pip install -e .

Customized installation

If there are several MATLAB versions, you have to install requirements and specify the MATLAB root directory during OpenNFT installation.

pip install -U pip setuptools wheel
pip install -U -r requirements.txt
pip install --install-option "--matlab-root=<MATLABROOT>" -e .

Check Installation

Check the installation: Check Installation

Run Application from PyCharm

Create Run Configuration to run OpenNFT:

_images/pycharminstall_5.png _images/pycharminstall_6.png

Specify the Module name as “opennft” (NOT Script path) and Project interpreter according to the created Virtual Environment:

_images/pycharminstall_7.png

To create the configuration, the checkbox Store as project file may be required: Run configuration problem.

Press the Run button,

_images/pycharminstall_8.png

or run the command in the Terminal:

opennft