Skip to content

Latest commit

 

History

History
128 lines (102 loc) · 10.7 KB

COOKBOOK.md

File metadata and controls

128 lines (102 loc) · 10.7 KB

Cookbook

A task-based index: find the example you need by what you want to accomplish.

Getting Started

How do I... C# Python MATLAB
Load a session from a .ssn2 file? 01-load-session-from-file.cs 01_load_session.py load_session.m
Load a session from a database? 02-load-session-from-database.cs 01_load_session.py load_session_from_database.m
Read parameter samples? 03-read-parameter-samples.cs 02_read_parameters.py read_parameters.m
Create a session and write data? 04-create-session-write-data.cs — create_session_write_data.m
Find sessions by metadata? 05-query-sessions-by-metadata.cs 03_query_sessions.py query_sessions.m
Verify MATLAB + SQL Race setup? — — diagnose_setup.m
List all parameters in a session? — — list_parameters.m

Data Access

How do I... C# Python MATLAB
Read samples in a time range? read-samples-between.cs read_samples_to_list.py read_samples_between.m
Downsample / subsample data? read-subsampled-data.cs — subsampled_read.m
Read data backwards (reverse iteration)? reverse-iteration.cs — reverse_iteration.m
Align parameters at different rates? multi-rate-alignment.cs — —
Read many parameters efficiently? bulk-parameter-read.cs multi_parameter_extract.py multi_channel_read.m
Handle missing or invalid data? data-status-filtering.cs — data_status_filtering.m
Build timestamp arrays for GetData? timestamp-array-construction.cs — —
Export data to pandas? — export_to_pandas.py —
Export data to MATLAB timetable? — — extract_to_timetable.m
Get per-segment statistics? — — segment_statistics.m
Plot a set of parameters? — — plot_parameters.m

Session Management

How do I... C# Python MATLAB
Find sessions in a date range? query-with-composite-filter.cs 03_query_sessions.py query_sessions.m
Read and write session metadata? session-metadata-crud.cs — session_metadata.m
Add annotations to a session? marker-management.cs — marker_management.m
Work with laps and segments? lap-and-segment-management.cs — lap_segment_management.m
Define and read events? event-definitions-and-data.cs 04_extract_events.py event_extraction.m
Associate sessions together? session-association.cs — —
Resolve parameter units? parameter-unit-resolution.cs — parameter_unit_resolution.m

Live Data

How do I... C# MATLAB
React to new laps? subscribe-to-lap-events.cs —
React to new data arriving? subscribe-to-data-events.cs server_listener.m
Poll for the latest samples? poll-live-samples.cs poll_live_samples.m
Detect when new parameters appear? rda-parameter-change-detection.cs —

Functions (Calculated Channels)

How do I... C# MATLAB
Create a calculated channel with FDL? fdl-function-basic.cs —
Create a calculated channel with .NET? dotnet-function-basic.cs —
Use a PDA inside a .NET function? dotnet-function-with-pda.cs —
Read calculated-channel (function) output? — read_function_output.m

Composite Sessions

How do I... C#
Append multiple sessions? append-multiple-sessions.cs
Compare whole sessions? whole-session-compare.cs
Use composites with associates? composite-with-associates.cs

Configuration

How do I... C# MATLAB
Set up parameter configuration manually? create-parameter-config.cs create_session_write_data.m
Create in-memory-only parameters? create-transient-parameter.cs —
Inspect a session's configuration? introspect-session-config.cs introspect_session_config.m
Use different conversion types? conversion-types.cs —

Projects (Tier 2)

For complete, buildable applications, see projects/.

How do I... Project
Record live data to SQLite? ServerListenerRecorder
Connect to an ATLAS Data Server? StandaloneRecorder
Export sessions to CSV? BatchExporter
Monitor a live session in real time? LiveDashboard
Create custom .NET functions? FunctionLibrary
Browse and export sessions from Python? session_explorer
Analyse sessions in MATLAB? session_analysis

All C# projects

Project Description
SqlRace.Examples.Core Shared library: bootstrapping, connection strings, fluent builders
GettingStarted Console app demonstrating the Core library API
ServerListenerRecorder Records multi-rate telemetry to SQLite
StandaloneRecorder ADS connection with read-transform-write loop
BatchExporter Queries sessions and exports to CSV
LiveDashboard Text-based real-time parameter monitor
FunctionLibrary Three .NET function patterns (converter, rolling avg, cross-param)

Notebooks (Tier 3)

Interactive Jupyter notebooks for exploring SQL Race data. See notebooks/.

Core Notebooks

How do I... Notebook
Get started with SQL Race from Python? 01-getting-started.ipynb
Explore session structure and metadata? 02-session-exploration.ipynb
Analyse multiple parameters together? 03-multi-parameter-analysis.ipynb
Compare data across sessions? 04-session-comparison.ipynb
Export data to CSV, Parquet, HDF5? 05-export-pipeline.ipynb
Monitor a live session? 06-live-data-monitoring.ipynb

Industry Scenarios

How do I... Notebook
Analyse lap-by-lap telemetry? motorsport-lap-analysis.ipynb
Extract flight test manoeuvre windows? flight-test-manoeuvre-extraction.ipynb
Trend turbine performance over time? turbine-performance-trending.ipynb
Compare durability test cycles? durability-cycle-comparison.ipynb