f1-race-replay README

The project's README from github.com/IAmTomShaw/f1-race-replay. As one markdown file: README.md.

F1 Race Replay ๐ŸŽ๏ธ ๐Ÿ

A Python application for visualizing Formula 1 race telemetry and replaying race events with interactive controls and a graphical interface.

Race Replay Preview

HUGE NEWS: The telemetry stream feature is now in a usable state. See the telemetry demo documentation for access instructions, data format details, and usage ideas.

Features

Controls

Safety Car

The replay includes a simulated Safety Car that appears on track whenever the F1 data indicates a Safety Car deployment (track status code 4). Since the F1 API does not provide GPS telemetry for the actual Safety Car, its position is simulated based on the race leader's position.

How it works

Technical details

The SC position computation happens in _compute_safety_car_positions() in src/f1_data.py. Each frame gets a safety_car field:

{
  "safety_car": {
    "x": 1234.56,
    "y": 7890.12,
    "phase": "on_track",
    "alpha": 1.0
  }
}
Field Description
x, y World coordinates of the SC
phase "deploying", "on_track", or "returning"
alpha Opacity value from 0.0 (invisible) to 1.0 (fully visible), used for fade in/out animation

Note: If you have existing cached .pkl files from previous runs, you must re-run with --refresh-data to generate SC position data. Older cached files will simply show no Safety Car.

Qualifying Session Support (in development)

Recently added support for Qualifying session replays with telemetry visualization including speed, gear, throttle, and brake over the lap distance. This feature is still being refined.

Requirements

Install dependencies:

pip install -r requirements.txt

FastF1 cache folder will be created automatically on first run. If it is not created, you can manually create a folder named .fastf1-cache in the project root

First Run Notice: Loading a session for the first time may take noticeably longer because telemetry data must be downloaded, processed, and cached locally. Subsequent launches of the same session are significantly faster..

Environment Setup

To get started with this project locally, you can follow these steps:

  1. Clone the Repository:

    git clone https://github.com/IAmTomShaw/f1-race-replay
     cd f1-race-replay
    
  2. Create a Virtual Environment: This process differs based on your operating system.

    • On macOS/Linux:
      python3 -m venv venv
      source venv/bin/activate
      
    • On Windows:
      python -m venv venv
      .\venv\Scripts\activate
      
  3. Install Dependencies:

    pip install -r requirements.txt
    
  4. Run the Application: You can now run the application using the instructions in the Usage section below.

Troubleshooting

If the pull data proccess fails, run:

pip install --upgrade fastf1

Usage

DEFAULT GUI MENU: To use the new GUI menu system, you can simply run:

python main.py

GUI Menu Preview

This will open a graphical interface where you can select the year and round of the race weekend you want to replay. This is still a new feature, so please report any issues you encounter.

OPTIONAL CLI MENU: To use the CLI menu system, you can simply run:

python main.py --cli

CLI Menu Preview

This will prompt you with series of questions and a list of options to make your choice from using the arrow keys and enter key.

If you would already know the year and round number of the session you would like to watch, you run the commands directly as follows:

Run the main script and specify the year and round:

python main.py --viewer --year 2025 --round 12

To run without HUD:

python main.py --viewer --year 2025 --round 12 --no-hud

To run a Sprint session (if the event has one), add --sprint:

python main.py --viewer --year 2025 --round 12 --sprint

The application will load a pre-computed telemetry dataset if you have run it before for the same event. To force re-computation of telemetry data, use the --refresh-data flag:

python main.py --viewer --year 2025 --round 12 --refresh-data

Qualifying Session Replay

To run a Qualifying session replay, use the --qualifying flag:

python main.py --viewer --year 2025 --round 12 --qualifying

To run a Sprint Qualifying session (if the event has one), add --sprint:

python main.py --viewer --year 2025 --round 12 --qualifying --sprint

File Structure

f1-race-replay/
โ”œโ”€โ”€ main.py                    # Entry point, handles session loading and starts the replay
โ”œโ”€โ”€ requirements.txt           # Python dependencies
โ”œโ”€โ”€ README.md                  # Project documentation
โ”œโ”€โ”€ roadmap.md                 # Planned features and project vision
โ”œโ”€โ”€ resources/
โ”‚   โ””โ”€โ”€ preview.png           # Race replay preview image
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ f1_data.py            # Telemetry loading, processing, frame generation & SC position simulation
โ”‚   โ”œโ”€โ”€ arcade_replay.py      # Visualization and UI logic
โ”‚   โ””โ”€โ”€ ui_components.py      # UI components like buttons and leaderboard
โ”‚   โ”œโ”€โ”€ interfaces/
โ”‚   โ”‚   โ””โ”€โ”€ qualifying.py     # Qualifying session interface and telemetry visualization
โ”‚   โ”‚   โ””โ”€โ”€ race_replay.py    # Race replay interface, SC rendering & telemetry visualization
โ”‚   โ””โ”€โ”€ lib/
โ”‚       โ””โ”€โ”€ tyres.py          # Type definitions for telemetry data structures
โ”‚       โ””โ”€โ”€ time.py           # Time formatting utilities
โ””โ”€โ”€ .fastf1-cache/            # FastF1 cache folder (created automatically upon first run)
โ””โ”€โ”€ computed_data/            # Computed telemetry data (created automatically upon first run)

Building Custom Telemetry Windows

When you start a race replay, an Insights Menu automatically appears, providing quick access to various telemetry analysis tools. You can easily create custom insight windows that receive live telemetry data using the PitWallWindow base class:

from src.gui.pit_wall_window import PitWallWindow

class MyInsightWindow(PitWallWindow):
    def setup_ui(self):
        # Create your custom UI
        pass
    
    def on_telemetry_data(self, data):
        # Process telemetry data
        pass

The PitWallWindow base class handles all telemetry stream connection logic automatically, allowing you to focus solely on your window's functionality.

Key Features:

Documentation & Examples:

Customization

Contributing

There have been several contributions from the community that have helped enhance this project. I have added a contributors.md file to acknowledge those who have contributed features and improvements.

If you would like to contribute, feel free to:

Please see roadmap.md for planned features and project vision.

Known Issues

arcade.application.NoOpenGLException: Unable to create an OpenGL 3.3+ context. Check to make sure your system supports OpenGL 3.3 or higher

You can easily fix this by running this command:

$ conda install -c conda-forge libstdcxx-ng

Thanks to @el-mandaloriano for showing how to resolve this issue: #12

๐Ÿ“ License

This project is licensed under the MIT License.

โš ๏ธ Disclaimer

No copyright infringement intended. Formula 1 and related trademarks are the property of their respective owners. All data used is sourced from publicly available APIs and is used for educational and non-commercial purposes only.


Built with โค๏ธ by Tom Shaw

f1-race-replay (IAmTomShaw/f1-race-replay)

visualization
Searching Databaseโ€ฆ

6.8K ยทGitHub
What is this?F1 Race Replay is a Python desktop app that visualizes real Formula 1 race telemetry and lets you replay race events with an interactive, animated track view.
Is this a GUI app or just a CLI script?It is a desktop GUI application built with the Arcade game library, though it also offers an optional text-based CLI menu for picking the session to replay.
How do I get it running?Clone the repo, create a virtual environment (steps differ slightly between macOS/Linux and Windows), install dependencies, then run the GUI menu or pass --year and --round directly to the main script.
What do I need installed first?You need Python 3.11+ plus the FastF1, Arcade, and numpy libraries; FastF1 also creates a local cache folder on first run to store downloaded telemetry.
Is the leaderboard always accurate?No โ€” the leaderboard can be off for the first few corners, during pit stops, and at the finish because of inaccuracies in how driver positions are computed from telemetry; the team is still working on fixing this.
Does it need Apple Silicon or anything special?No, it works cross-platform on macOS, Linux, and Windows; the only hardware-dependent step is the first run of any race, which is slower because telemetry has to be downloaded and cached.
How does the Safety Car show up in replays if F1 doesn't give it GPS data?Its position is simulated roughly 500 meters ahead of the race leader on the track polyline, with animated deploy/on-track/return phases and a pulsing orange glow, driven by real Safety Car timing from FastF1's track status data.
Can I watch Qualifying sessions too, not just races?Yes, there is in-development support for Qualifying (and Sprint Qualifying) replays with speed, gear, throttle, and brake telemetry over lap distance, enabled via the --qualifying flag.
Can I build my own telemetry widgets?Yes, you can subclass the PitWallWindow base class, which handles the live telemetry connection and cleanup automatically so you only need to implement setupui() and ontelemetrydata().
What keyboard shortcuts control playback?SPACE pauses/resumes, arrow keys rewind/fast-forward and change speed, number keys 1-4 jump to preset speeds, R restarts, and D/B/L toggle the DRS zone, progress bar, and driver names.
Creator
IAmTomShaw
Size
14 MB
Stars
6.8K
Updated
CommitOct 09
Age
10mo
Commits ยท 90 Days