Machathon4.0-Judge

The Machathon4.0 Judge repository provides all the required tools and utilities for the Machathon4.0 Competition - self driving cars edition. It features convenient wrapper functions for controlling the movement of the car and capturing images from the camera within the CoppeliaSim simulator. It also includes the judge code that evaluates the competitor's solution and updates the leader-board.

🏆 Official Compeititon Leaderboard

📜 For more information about the competition regulations, please refer to the Official Competition Rules Book.

Installation

You can install the machathon judge library using pip through the following command:

pip install machathon-judge

Or you can install it manually using the following steps:

1. Clone the repositry
   git clone https://github.com/NouranHany/Machathon4.0-Judge.git

2. Navigate to the repository directory
   cd Machathon4.0-Judge

3. Install all dependencies needed
   pip install -r requirements.txt

Preparation for running the code

Before running your code, it's important to make sure you have opened the filteration_scene.ttt in CoppeliaSim. Here are the steps to follow:

1. Open CoppeliaSim.
2. Load the filteration_scene.ttt file by going to File > Open Scene > Browse, then navigating to the location where the scene file is stored.

How to Use the Judge?

1. Create an instance of the Judge class and provide your team information, including the team code(consists of 9 digits), and the path to a zip containing your code.
   

judge = Judge(team_code="your_new_team_code", zip_file_path="your_solution.zip")

2. Pass the function where you have written your main solution to the judge. For example, if your solution is in a function named run_car, use the following code:
   

judge.set_run_hook(run_car)

3. Call the judge to run your code. The judge will call your code twice and calculate the lap time for each run. If you choose to publish the lap time to the leaderboard, set the send_score parameter to True.
   

judge.run(send_score=True)

The provided test.py file demonstrates how to use the Judge class. Note: don't submit your solution using this script as it uses the keyboard to manually control the car which is against the rules.

Note for Ubuntu users

The test.py script uses the keyboard library which requires running "sudo", so replace "pip3" with "sudo pip3" and "python3" with "sudo python3". This is only needed for the test.py

Project Hierarchy

└── Machathon4.0-Judge/
    ├── machathon_judge/
    │   ├── data.py  # contains important variables that are used throughout the project
    │   ├── judge.py # Module containing the Judge class to run the competition's tracks and publish the scores to the leaderboard
    |   ├── collision_manager.py # Module containing the CollisionManager class to manage the collision events
    │   └── simulator.py  # Wrapper for the API that connects CoppeliaSim and Python
    ├── filteration_scene.ttt  # The competition environment in CoppeliaSim, which includes the track and the vehicle   
    ├── test.py  # Demonstrates how to utilize the competition judge and simulator classes
    └── requirements.txt

Attribution

This code was developed and maintained by Step Towards Progress STP, a non-profit organization focuses on developing youth in various fields personally and technically through academic programs, projects, and events. You can find more information about STP at https://stp-org.com/

If you have any questions or would like to get in touch with our team, please email us at stp23.official@gmail.com or find us on Facebook.