Installation

There are two ways to install the application:

1. Downloading an installer for your operating system and following the instructions (recommended):

• Download for Windows

• Download for MacOS (Apple Silicon)

• Download for MacOS (Intel)

Note

The installers are not signed, so you may need to allow the installation in the system settings. On Windows, it may be flagged as a potential threat, but choose to keep it anyway.

2. Manually from the source code:

• Clone the repository and navigate to the project directory:

  git clone https://github.com/ParrishLab/ysa-gui.git
  cd ysa-gui
  

• Create a virtual environment:

  python -m venv ysa_env
  

• Activate the virtual environment:

  • Windows:

  ysa_env/Scripts/activate
  

  • MacOS:

  source ysa_env/bin/activate
  

• Install the dependencies:

  pip install -r src/helpers/update/requirements.txt
  

• Run the application:

  python src/main.py
  

Important

The instructions for building from the source code assume that you have Python 3.10.9 installed on your system. If you don’t have it, you can download it from the official website.

Note

Some algorithms have the option of using a MATLAB implementation. If you want to use them, you need to have MATLAB installed on your system, build from source, and use pip to install the matlab and matlabengine packages. Note that you’ll need to download the correct version of matlabengine to work with your MATLAB installation.