Build

This guide will walk you through the steps needed to set up and run MAGI on your system. Whether you are looking to contribute or just want to run the software, this is the place to start.

Prerequisites

Before you begin, ensure you have the following prerequisites installed on your system:

• Python 3.8+: The software supports Python 3.8 and newer versions. However, we have tested it primarily with Python 3.10. Make sure Python and pip are correctly installed on your system by running python --version and pip --version in your terminal. If you're on a Unix-based OS (like Linux or macOS), you might need to use python3 and pip3 instead.

Setup

Using WSL (Windows Subsystem for Linux) for running MAGI? Do not place the application in the Windows directory and see here for why.

1. Cloning the Repository

   To get started, you'll first need to clone the MAGI repository to your local machine. Open your terminal, navigate to the directory where you want to clone the repository, and run the following command:

   git clone https://github.com/cics-syslab/MAGI.git

2. Navigate to the MAGI Directory

   cd MAGI

3. Install Dependencies

   Install all necessary dependencies by running:

   pip install -r requirements.txt

   This command reads the requirements.txt file and installs all the Python packages listed there. Ensure you are connected to the internet and have permission to install these packages on your system.

4. RUN Add-on Setup (Unix Only)

   Use the provided script to install the dependencies of the plugins if there is one. Note that since usually this step involves installing with apt, sudo is required.

   sudo ./setup.sh

5. Start the Program

   With the dependencies installed, you are now ready to start the program. Depending on your operating system, follow the instructions below:

   On Unix-based OS (Linux, macOS, etc.)

   1. Open Terminal: Open a Terminal window and navigate to the MAGI project directory if you are not already there.

   2. Make Script Executable (if necessary): Before running the script for the first time, you may need to make it executable. Run the following command:

      chmod +x run.sh

   3. Run the Program: Execute the script with the following command:

      ./run.sh

   On Windows

   1. Open Command Prompt: Open Command Prompt in the MAGI project directory. You can do this by typing cmd in the address bar of the File Explorer window where the MAGI project folder is open and pressing Enter.

   2. Run the Program: In the Command Prompt, execute the following command:

      run.cmd

Troubleshooting

• Python/Pip Version Issues: If you encounter any issues related to Python or pip versions, make sure you have the correct versions installed. The project supports Python 3.8 and newer, but Python 3.10 is recommended.

• Dependency Installation Issues: If you face problems installing dependencies, ensure your pip is up to date (pip install --upgrade pip). Also, check for any error messages in the terminal, as they may provide clues on what went wrong.

• Script Permissions: If you encounter a permission denied error when trying to run run.sh on Unix-based systems, ensure you have executed the chmod +x run.sh command to make the script executable.

• Script Not Running: Ensure that you are in the correct directory (MAGI project directory) and that the scripts (run.cmd for Windows, run.sh for Unix) are present. If you cloned the repository correctly, these files should be in your project directory.