Boba Manatee Log Analysis Tool(s)

Tools built for the Boba Manatee Simulation. Analysis tools for collecting data logs and building csv reports, as well as the server API script used on the deployed server. Developed by Seamus Jackson working under the direction of Tania Roy at New College of Florida.

Currently includes:

• Log collection script - /Tools/dataRetrieval.py
• Report generation tools - /Tools/program.py, utilities.py
• Server API script - /Tools/BobaServer/bobabackend.py

---

• The analysis script uses an environment variable to connect to the hosted endpoint for the flask API that bridges the simulation to the mongoDB.

• The server script is included. This is deployed at a fixed endpoint, running the server locally would require a modification to the API url in the simulation itself in the TelemetryManger object in the first scene.

---

Instructions for use

1.) Setting up

• Ensure Python 3.11+ is installed
• Clone this repository
  • with git installed do git clone https://github.com/Schweem/BobaManateeAnalysis.git
  • If you're using github desktop, paste the link in there
• Setup your .env file. These means defining "ENDPOINT_URL" in your .env (.env file goes in the 'Tools' directory along side the python script)

  • https://www.geeksforgeeks.org/how-to-create-and-use-env-files-in-python/

  • touch .env, micro .env, vi .env, nano .env, etc... This creates the file

  • Once created, open it and in the first line write ENDPOINT_URL = APIURLHERE

  • 

    • you dont need any quotes in here. If you want to put them around the API URL that is OK but not needed.
• Install requirements 'pip install -r requirements.txt' in the root directory (These are for both server and analysis)
  • pip is a python package manager that should be installed alongside python. Running this command will attempt to install of the packages listed inside of the requirements file.

---

2.) Collecting Data from the server

• Run 'dataRetrieval.py', to pull data and build csv reports.
• To do this ensure requirements are installed, do this by pip install -r requirements.txt.
  • Ensure .env file is prepared
  • This is accomplished by creating a file called .env in the tools directory
  • Inside of this file you will write the following:
    • ENDPOINT_URL = APIURLHERE, APIURLHERE refers to the cloud run deployment.
• once .env file and requirements are installed, you can type python dataRetrieval.py if that doesn't work you might be on a different OS than I am or not using a virutal environment, in which case try typing python3 dataRetrieval.py

---

3.) Generating reports from server data

• Run program.py to generate aggregate summaries and individual csv reports from the data produced by dataretrieval.py
  • This script functions by taking the data pulled from running dataRetrieval.py and uses it for individual and aggregate report generation. Please ensure that you have done one of the following before running this script
    • Setup a .env file as described above and run dataRetrieval.py to pull logs from the backend server.
    • Alternativley, if you have Collected data locally on the headset, please copy it from the headset into a directory called telemetry_reports into the tools directory with the rest of the python scripts and your .env file, you do this in place of the the retreival script creating that directory for you.
  • With a present telemtry reports directory the script will read in all of the data and produce individually formatted csv reports as well as an aggregate excel summary of the session.

---

Functionality

• Once run, the analysis script will connect to the API and get a list of session IDs. It will then extract all the logs for each unique session ID and generate a csv report of the log data. These CSV reports are then used by the report generation script (soon to come).
• The report generation tools are the final step of the pipeline. Once the data has been collected from the DB the python scripts are used to parse the data and produce reports.
• !! Future Boba developers, ISP 2024+ !! DOCKERFILE and API code is provided in the BobaServer directory. There is no assumption that you are familiar with these tools before using them. They are provided in the event that something happens to deployment or needs to change for deployment and I am not approached to fix it. The API is a lightweight flask script that interacts with MONGO and the DOCKERFILE is setup to build the API.