Skip to content

User Guide

Mohammad edited this page Nov 5, 2024 · 8 revisions

This guide explains how to run the application once it is already set up. It covers starting the backend, frontend, and simulation components.

Step 1: Running the Unreal Engine Application

  1. Locate the Blocks.exe file that you downloaded and extracted earlier.
  2. Double-click Blocks.exe to run the simulation.
    • This does not require Unreal Engine to be installed and provides a ready-to-use simulation environment.

Step 2: Starting the Backend Server

  1. Navigate to the backend folder where the application files are stored.
  2. Activate the virtual environment:
source venv/Scripts/activate
  1. Start the backend server by running:
py ./PythonClient/server/simulation_server.py

Step 3: Starting the Frontend Server

  1. Navigate to the frontend folder of the project.
  2. Start the frontend server with the following command:
npm start
  1. Access the User Interface:
    • Open a web browser and navigate to http://localhost:3000 (or the URL displayed in your terminal).
    • This interface allows you to interact with the simulation, view data, and control the backend.

Step 4: Viewing the Reports

Once the simulation is complete, you can access the generated reports in multiple ways:

  • If using the local saving version:
    • Navigate to the AirSim/report directory on your local machine to access the saved reports.
    • This directory will contain all generated reports and data logs for review.
  • If using an online storage service:
    • Access the designated online storage location through your web browser or the service’s interface.
    • Reports and logs will be automatically uploaded to the configured online storage option.
  • You can also use the frontend React app to view reports:
    • Navigate to the Reports Dashboard to view and analyze the reports directly within the application.