simonsobs / simonsobs/sotodlib

Bad subscans should not be called "valid"

Open
#1,509 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Noticed this while trying to figure out why we were cutting detectors with the most "valid" subscans. Valid means good. "flag", "cut," or "bad" would mean bad.

If I'm somehow misunderstanding and these valid subscans are actually valid, then the docs need improvement.

https://github.com/simonsobs/sotodlib/blob/df8f1c493c94679eb8a3c0775c636d05541e04e4/sotodlib/preprocess/processes.py#L2623

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

Inspect sotodlib/preprocess/processes.py around line 2623 and determine whether the subscans described there are genuinely valid or are flagged/cut as bad. If they are bad, update the misleading terminology; if they are valid, improve the documentation so the meaning is clear. No specific test is named in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data-engineering
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.