Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
name: ci
on:
push:
branches: [ main ]
pull_request:

jobs:
Expand Down
25 changes: 25 additions & 0 deletions docs/design/read-planning.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Read Planning

This document outlines the strategy for planning and executing reads from Tdms files, focusing on efficient operation.

## Hierarchy of Plans

The planning generates three levels of plans:

* File Plans
* Data Block Plans
* Record Plans

## File Plans

The goal of the file plan is to determine which blocks need to be read and in what way. We may have alternative read methods based on the type of read we want to complete.

The main case for that right now is if we want to skip some samples.

## Data Block Plans

A plan for a data block states which samples from which channels in the block need to be read.

## Record Plans

The record plan describes the size of the records in the block to allow for skipping records and unread data.
Loading
Loading