Skip to content
Snippets Groups Projects
Victor Hexad's avatar
Victor Hexad authored
Adding Use Case 2 to opgui as a partial release

See merge request !1
92954c9a
History

opGUI Installation Guide

Prerequisites

Before installing opGUI, please ensure you have the following prerequisites correctly installed:

  1. Node.js (Version 18.13.2):

    • For Windows 11: Download from here.

    • For Debian: Run the following commands in your terminal:

      curl https://raw.githubusercontent.com/creationix/nvm/master/install.sh | bash
      source ~/.profile
      nvm install 18.13.0
  2. NPM (Version 8.5.0):

    • Included with Node.js when installing node.
  3. Yarn (Version 1.22.17):

    • For Windows 11: Download from here.

    • For Debian: Install using npm with the following command:

      npm install --global yarn

Installation Steps

  1. Clone this repository into your HOME folder. It is also mandatory to have opSimulation installed in your HOME directory.

Windows:

  1. Open a terminal and navigate to the project directory located in your home folder:

    cd %USERPROFILE%\opgui
  2. Install the required dependencies using yarn:

    yarn install
  3. Execute the Windows installation procedure:

    yarn win-install
  4. To run the application, simply execute the following command:

    yarn win-launch

Debian:

  1. Open a terminal and navigate to the project directory located in your home folder:

    cd $HOME/opgui
  2. Install the required dependencies using yarn:

    yarn install
  3. Execute the Debian installation procedure:

    yarn deb-install
  4. To run the application, simply execute the following command:

    yarn deb-launch

Please make sure to carefully follow the above steps to ensure a successful installation and execution of opGUI. If you encounter any issues or have any questions, do not hesitate to reach out to us for support. Happy coding!