simonsobs / simonsobs/sotodlib

analyze-bright-ptsrc: next steps

Open
#736 2 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

PR #574 has dealt with most of #479. Here are some requests (residual and emergent), prioritized:

  1. Make not crash on site environment. The current script likely doesn't work on data at site, if for no other reason than that the sso_name is taken from an obsdb column that does not exist at site. A solution more compatible with SO obsdb would be to try to find a planet name in the obsdb "tags"; but is must always be possible to override from cmdline / config file.
  2. Revise the output file format. Is time constant not in there? xi0 and eta0 should be called xi and eta. Do an iteration with consumers on what makes most sense here.
  3. Document. it is especially important to capture what the config file should look like! This is hard to put together, just scanning the code. Documenting the output file is pretty important too -- these fit results are important intermediate data products that will get used a lot.
  4. Some way to get priors in; especially priors on position. A common use case will be: we know where the detectors are, but we want to run time-domain fitting to refine the time constants.
  5. Account for boresight/corotator value. This will require some thought; but we'd be wise to at least record in the output data (a) what the boresight value for the observation was and (b) whether that was included in the model during fitting or not.
  6. Transfer supporting functions to library level. I have heard that much time domain fitting is being done in Jupyter notebooks, presumably using functions extracted and evolved, from this script. Let's start making some of those things available at library level.

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

The issue names the analyze-bright-ptsrc script, PR #574, and related issue #479; start by reviewing those changes and the current script. Scope the six prioritized requests separately, with completion covering site-compatible inputs, revised output and documentation, configurable priors, boresight metadata, and reusable library functions.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook, python
Domain
data, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.