From 2f6cda72ade6262d0c88040a6e4ffba020a57093 Mon Sep 17 00:00:00 2001 From: lambpasta Date: Sat, 30 Nov 2024 12:39:46 -0800 Subject: [PATCH 1/3] update docs --- docs/source/api.rst | 1 + docs/source/lap_tools/index.rst | 4 ++++ 2 files changed, 5 insertions(+) create mode 100644 docs/source/lap_tools/index.rst diff --git a/docs/source/api.rst b/docs/source/api.rst index 8a441bd..96252f8 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -9,3 +9,4 @@ API Reference Collections Querying Tools + Lap Tools diff --git a/docs/source/lap_tools/index.rst b/docs/source/lap_tools/index.rst new file mode 100644 index 0000000..fc389b2 --- /dev/null +++ b/docs/source/lap_tools/index.rst @@ -0,0 +1,4 @@ +.. automodule:: data_tools.lap_tools + :no-members: + :no-inherited-members: + :no-special-members: From dd1d1ef4c3b2beca7084f40fda2683606bed1d6d Mon Sep 17 00:00:00 2001 From: lambpasta Date: Sat, 30 Nov 2024 13:00:47 -0800 Subject: [PATCH 2/3] fix code example? --- data_tools/lap_tools/lap_query.py | 27 +++++++++++---------------- 1 file changed, 11 insertions(+), 16 deletions(-) diff --git a/data_tools/lap_tools/lap_query.py b/data_tools/lap_tools/lap_query.py index 27adf19..52a8691 100644 --- a/data_tools/lap_tools/lap_query.py +++ b/data_tools/lap_tools/lap_query.py @@ -12,22 +12,17 @@ def collect_lap_data(query_func: Callable, client: DBClient, include_day_2=False Example usage: - ```python - from data_tools.collections import collect_lap_data, TimeSeries - from data_tools.query import DBClient - import datetime - import numpy as np - - - def get_average_speed(start_time: datetime.datetime, end_time: datetime.datetime, data_client: DBClient): - lap_speed: TimeSeries = data_client.query_time_series(start_time, end_time, "VehicleVelocity") - return np.mean(lap_speed) - - - client = DBClient() - - average_speeds = collect_lap_data(get_average_speed, client) - ``` + :: + + from data_tools.collections import collect_lap_data, TimeSeries + from data_tools.query import DBClient + import datetime + import numpy as np + def get_average_speed(start_time: datetime.datetime, end_time: datetime.datetime, data_client: DBClient): + lap_speed: TimeSeries = data_client.query_time_series(start_time, end_time, "VehicleVelocity") + return np.mean(lap_speed) + client = DBClient() + average_speeds = collect_lap_data(get_average_speed, client) :param Callable query_func: must take in parameters (lap_start: datetime, lap_end:datetime, data_client:DBClient) :param DBClient client: client to use for querying From 45f5edc74623393748c121166220b83db9be1f57 Mon Sep 17 00:00:00 2001 From: lambpasta Date: Sat, 30 Nov 2024 13:11:38 -0800 Subject: [PATCH 3/3] fix code example? --- data_tools/lap_tools/lap_query.py | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/data_tools/lap_tools/lap_query.py b/data_tools/lap_tools/lap_query.py index 52a8691..b8a311c 100644 --- a/data_tools/lap_tools/lap_query.py +++ b/data_tools/lap_tools/lap_query.py @@ -6,9 +6,9 @@ def collect_lap_data(query_func: Callable, client: DBClient, include_day_2=False, verbose=False) -> np.ndarray: """ - Higher order function - computes `query_func` for each lap in FSGP 2024 and returns the resulting array. + Higher order function - computes ``query_func`` for each lap in FSGP 2024 and returns the resulting array. - Set `include_day_2` to True to include the day 2 laps, which were driven slowly & under heavy rain. + Set ``include_day_2`` to True to include the day 2 laps, which were driven slowly & under heavy rain. Example usage: @@ -24,11 +24,17 @@ def get_average_speed(start_time: datetime.datetime, end_time: datetime.datetime client = DBClient() average_speeds = collect_lap_data(get_average_speed, client) - :param Callable query_func: must take in parameters (lap_start: datetime, lap_end:datetime, data_client:DBClient) + :param Callable query_func: + must take in the following parameters: + :: + lap_start: datetime + lap_end: datetime + data_client: DBClient + ``query_func`` will be passed in the above parameters for each specified lap and may return an arbitrary output to be stored in the output array. :param DBClient client: client to use for querying :param include_day_2: flag to include the three day 2 laps, driven slowly & under heavy rain - :param verbose: if True, print out queried data during execution - :return: a NumPy ndarray of `query_func` results for all laps + :param verbose: if ``True``, print out queried data during execution + :return: a NumPy ndarray of ``query_func`` results for all laps """ if include_day_2: