Skip to content

1. Installation and First‐Time Setup

Jump to bottom
Matthew Mueller edited this page Jul 3, 2024 · 14 revisions

1. Installation (Recommended)

  1. Download the latest installer or package release for your operating system from the releases page

  2. Note: In some cases, the installation may take a long time (10-15 minutes)

  3. Linux:

    1. Ubuntu 22.04:

      1. cd into the directory you downloaded PetaKit5D-GUI_ubuntu2204.deb to

      2. sudo dpkg -i PetaKit5D-GUI_ubuntu2204.deb

      3. Call PetaKit5D-GUI from a terminal

  4. Mac (MacOS 12 or newer):

    1. Double-click the PetaKit5D-GUI_mac.pkg file and you should see an error about an unidentified developer

    2. Currently, the Mac installer .pkg needs to be manually approved before it can be run (This may change in the future if there is more demand for the Mac version)

    3. Go into System Preferences > Security & Privacy > General (The tab at the top)

    4. At the bottom, you should see "PetaKit5D-GUI_mac.pkg" was blocked from use because it is not from an identified developer.

    5. Click Open Anyway

    6. Click Open

    7. You may be prompted for admin privileges at some point. Type in your password if prompted

    8. Follow the installer's instructions

    9. You may see a bouncing Matlab icon in your taskbar. Do not click this as it can cause the installation to fail

    10. When prompted to choose an installation location for the Matlab Runtime, Leave all values at their default

    11. Search for PetaKit5D-GUI and launch the program

  5. Windows (Windows 10 or newer):

    1. Double-click the PetaKit5D-GUI_windows_setup.exe file

    2. You may get a popup saying "Microsoft Defender SmartScreen prevented an unrecognized app from starting."

    3. If this happens, click More Info > Run anyway

    4. You may be prompted for admin privileges, click Yes

    5. Follow the installer's instructions

    6. Search for PetaKit5D-GUI and launch the program

2. Portable Version Installation (Advanced Users)

  1. Note: This installation method is not recommended if there is and installer or package available for your OS

  2. Installation (Portable Version)

    1. For some OS, PetaKit5D-GUI is also available as a portable version (I.E. PetaKit5D-GUI_scientificlinux.tar.gz)

    2. Download the latest installer or package release for your operating system from the releases page

    3. Unpack the LLSM_Processing_GUI folder and place it anywhere on your system.

    4. Once the software is in the desired location on your system, it should not be moved.

    5. You can now run the LLSM_Processing_GUI executable. For Mac, you may double-click the application.

  3. MCC Version (HIGHLY RECOMMENDED)

    1. The MCC version is a self-contained version of the GUI that does not require a MATLAB license. Even if you have a MATLAB license, this version is highly recommended as you may run into compatibility issues using the MATLAB version.

      1. First-time installation instructions

        Load Previous Settings

      2. Initially, you should see the menu above upon your first time opening the LLSM Processing GUI. Now check the Use MCC checkbox and click the Reset Path button

        Path Reset

      3. A popup window will appear. Click OK and then click the No button in the bottom left corner

        First-time Setup

      4. Another popup window will appear. Click OK to download and Install the MCC Runtime (This may take some time depending on your hardware). NOTE: You may be prompted to say yes to give administrator permissions to the MCC program after the MCC contents are unzipped.

      5. The GUI may force close itself when installing but you should now see a MATLAB_Runtime folder in the same folder as the LLSM_Processing_GUI executable (On Windows, it will be in C:\Program Files\MATLAB. On Mac, it will be in /Applications). This means that the MCC version is installing in the background and you can relaunch the GUI. Upon relaunch, Check the Use MCC box and click Reset Path then the MCC version should be ready to use.

  4. MATLAB Version (NOT RECOMMENDED)

    1. This version requires a valid MATLAB installation on your computer

      1. The Use MCC checkbox should be unchecked and your path should point to your MATLAB executable

3. Load previous settings (After completing one of the 2 above steps)

  1. For the first time through or if you want to reset the GUI values click No.
  2. Click Yes to load previous GUI values. (The GUI automatically saves values when closed or when submitting jobs)
Clone this wiki locally