From 3610f3015215aaf119f47199df2a9918a338d263 Mon Sep 17 00:00:00 2001 From: theOehrly Date: Sat, 13 Mar 2021 12:05:46 +0100 Subject: [PATCH] doc updates for v2.1.1 --- README.rst | 25 +++++++++---------------- docs/changelog.rst | 16 ++++++++++++++++ fastf1/__init__.py | 2 +- fastf1/legacy.py | 2 +- fastf1/livetiming/__init__.py | 2 +- 5 files changed, 28 insertions(+), 19 deletions(-) diff --git a/README.rst b/README.rst index f81636239..d3de5572c 100644 --- a/README.rst +++ b/README.rst @@ -12,21 +12,21 @@ IMPORTANT NOTE: Status of the project (Update 2: 10th March 2021) The old way of installing via pip + git directly from the master branch is no longer recommended.** -Currently this module is not fully usable which is the result of server issues -with the F1 API. +It is no longer possible to download telemetry and car position data after a +session! See `this `_ Twitter post for some information. -For the 2019 and 2020 seasons this means: +This means: - It is still **possible** to load timing data, tire data, track status data and session status data. - It is **not possible** to load car telemetry data - (includes position data). + (includes position data). You need to record live timing data during + a session for this! -What this means for the 2021 season cannot yet be said. Live timing data ---------------- @@ -36,19 +36,12 @@ used to save the live timing telemetry data stream that is available during sessions. This can potentially be used to work around the problem of missing data on the server.** - - The live timing client does not and will never parse data in real time! - Data can only be parsed and used after a session has completed. This is a - limitation of FastF1's api parser. For various reasons there is no - intention of changing this. - - - While live timing data can already be saved during a session it is not - yet possible to actually use this data. Some changes to FastF1's core - and api module are still required. These are not yet completed due to a - lack of testing possibilities so far. There will hopefully be an update - to fix this within the next few days. +The live timing client does not and will never parse data in real time! +Data can only be parsed and used after a session has completed. This is a +limitation of FastF1's api parser. For various reasons there is no +intention of changing this. Consider all live timing related functionality as beta-grade at best. -(Again, no testing opportunities) For usage see the documentation. diff --git a/docs/changelog.rst b/docs/changelog.rst index 75f0c8c70..bb36ffd09 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -3,6 +3,22 @@ Changelog ========= +v2.1.1 Add support for recording and using live timing data +=========================================================== + +- Possibly breaking changes: + + - :meth:`fastf1.Session.load_laps`: Data will now be loaded without + telemetry by default, i.e. only timing data is loaded. + Telemetry data is usually not available anyways, therefore this prevents + a confusing error. + +- Changes: + + - Possibility to record live timing data + - Possibility to use recorded live timing data as a data source + + v2.1: Refactoring, accuracy improvements and a more accessible interface ========================================================================== diff --git a/fastf1/__init__.py b/fastf1/__init__.py index dbafe3b10..390b38c30 100644 --- a/fastf1/__init__.py +++ b/fastf1/__init__.py @@ -44,7 +44,7 @@ from matplotlib import pyplot as plt from fastf1 import plotting - laps = monza_quali.load_laps() + laps = monza_quali.load_laps(with_telemetry=True) fast_leclerc = laps.pick_driver('LEC').pick_fastest() t = fast_leclerc.telemetry['Time'] vCar = fast_leclerc.telemetry['Speed'] diff --git a/fastf1/legacy.py b/fastf1/legacy.py index c5c949167..277bdd5f8 100644 --- a/fastf1/legacy.py +++ b/fastf1/legacy.py @@ -25,7 +25,7 @@ fastf1.Cache.enable_cache("test_cache/") session = fastf1.get_session(2020, 'Italy', 'R') - laps = session.load_laps() + laps = session.load_laps(with_telemetry=True) DRIVER = 'VER' # which driver; need to specify number and abbreviation DRIVER_NUMBER = '33' diff --git a/fastf1/livetiming/__init__.py b/fastf1/livetiming/__init__.py index e3123b59b..444da2347 100644 --- a/fastf1/livetiming/__init__.py +++ b/fastf1/livetiming/__init__.py @@ -42,7 +42,7 @@ livedata = LiveTimingData('saved_data.txt') session = fastf1.get_session(2021, 'testing', 1) - session.load_laps(livedata=livedata) + session.load_laps(with_telemetry=True, livedata=livedata) optionally you can load live timing data from two or more files