Apliro User
Guide

How to Run Tools from Downloaded Source Code

1. First, unzip the file that you have downloaded.

2. Now, follow the process detailed in the attached YouTube video above. After doing so, you should be able to run that specific tool on your local machine or Google Colab, as demonstrated in the video.

3. If you are unable to access the video, simply follow the instructions provided below. After that, you should be able to run the source code.

1. Installing Python:

For Windows:

1. Direct the client to Python's official download page.
2. Ask them to download the latest version of Python for Windows.

3. Instruct them to run the installer.

   Important: Make sure they tick the checkbox that says "Add Python X.X to PATH" during installation. This step is crucial for running Python from the command prompt.

For macOS:

1. Direct the client to Python's official download page for macOS.
2. Ask them to download the latest version and follow the installation steps.

For Linux:

Most Linux distributions come with Python pre-installed. However, they might need to install pip:

sudo apt-get update
sudo apt-get install python3-pip
            

2. Setting Up the Flask Application:

1. Once Python is installed, direct the client to the folder where your Flask application is located.
2. Provide them with a requirements.txt file that lists all the necessary packages for your application.

3. Installing Dependencies:

1. Ask the client to open a command prompt (Windows) or terminal (macOS/Linux).
2. Navigate to the Flask application directory. For example:

cd path_to_directory
                

3. Install the required packages using pip:

pip install -r requirements.txt
                

4. Running the Flask Application:

1. Once all dependencies are installed, instruct the client to run the Flask application. If your application's main file is app.py, they can run:

python app.py
                

2. The client should see a message indicating that the server is running. They can then access the application in their browser, usually at http://127.0.0.1:5000/ unless specified otherwise.

5. Troubleshooting:

Provide a short troubleshooting section covering common issues:

• Error related to missing dependencies: Ensure that all dependencies were installed correctly using the requirements.txt file.
• Port already in use: This indicates that something else is running on the default Flask port (5000). They can either close the conflicting application or you can provide instructions to run your Flask app on a different port.