Documentation

Function description of pyF1. Here you should find inputs and outputs of each function.

THIS SECTION IS WIP

create_event

laps, event = create_event(year, gp, session)

Returns FastF1 Laps and Session for given input parameters (That specifies session you wish to use)

Parameters:

• year: Year that the session took place, eg. 2021
• session: Session type: ‘R’ - Race, ‘Q’ - Qualification, ‘FP1’ - Free Pracrice, etc. see FastF1 doc for details.
• gp: Name or weekend number (1: Australia, …,). If gp is a string, a fuzzy match will be performed on the season rounds and the most likely will be selected. Some examples that will be correctly interpreted: ‘bahrain’, ‘australia’, ‘abudabi’, ‘monza’.

Output:

• laps: fastf1.core.Laps
• event: fastf1.core.Session

ridgeline

ridgeline(drivers_list, laps, title, xliml, xlimr, best_lap_number)

Parameters:

• drivers_list:
• laps:
• title:
• xliml:
• xlimr:
• best_lap_number:

Output: None. Function provides plots and gives console printout:

overlay_drivers

fig, ax = overlay_drivers(driver_list, session)

Parameters:

• driver_list:
• session:

Output:

• fig: matplotlib.pyplot.figure
• ax: matplotlib.axes

overlay_highlight

ax = overlay_highlight(ax, axes_counter, xlim, xlim2):

Parameters:

• ax:
• axes_counter:
• xlim:
• xlim2:

Output:

• ax:

overlay_laps

overlay_laps(lap1, lap2, title, legl1, legl2, **kwargs)

Parameters:

• lap1:
• lap2:
• title:
• legl1:
• legl2:
• kwargs:

Output:

• fig:
• ax:

overlay_map_multi

overlay_map_multi(driver_list, session, **kwargs)

Parameters:

• driver_list:
• session:
• kwargs:

Output: None

plot_driver_tire_data

plot_driver_tire_data(driver_list, laps):

Parameters:

• driver_list:
• laps:

Output:

• 0

tire_by_lap

tire_by_lap(session, event)

Parameters:

• session:
• event:

Output:

• 0

plot_cumulative_time

fig, ax = plot_cumulative_time(laps, driver_list, ref_driver)

Parameters:

• laps:
• driver_list:
• ref_driver:

Output:

• fig:
• ax:

annotation

ax = annotation(ax, comment_list)

Parameters:

• ax:
• comment_list:

Output:

• ax:

track_status

ax = track_status(drv_lap, type, ax, text_posy, text_ang)

Parameters:

• drv_lap:
• type:
• ax:
• text_posy:
• text_ang:

Output:

• ax: