simonsobs / simonsobs/sotodlib

Add Seek capability to `io.load.unpack_frames`

Open
#123 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
19
Forks
23
Avg merge
1d 5h
Merged PRs (30d)
14

Description

unpack_frames currently just takes a .g3 file and runs through all the frames looking for Scans to unpack.

If we expand it to take some sort of optional list of frame offsets we can use the Seek option of G3IndexedReader to skip passed un-necessary frames and/or set starts and stops in the middle of a file. This would be useful for any plans to add contextual load options in the middle of file positions as well as for skipping all those Smurf Status frames.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at io.load.unpack_frames and inspect how it currently walks .g3 frames, then read the G3IndexedReader Seek capability. Define how optional frame offsets support skipping frames and starting or stopping in the middle of a file; done means those offset-driven ranges are accepted while existing full-file behavior remains available.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.