simonsobs / simonsobs/sotodlib
Improve HDF5 writing of toast observations with arbitrary metadata
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 19
- Forks
- 23
- Avg merge
- 1d 5h
- Merged PRs (30d)
- 14
Description
The upstream toast HDF5 saving functions only attempt to write "simple" metadata (scalars, arrays, etc) or objects that define a save_hdf5() method. This means that generic, top-level AxisManager meta data which is not one of the standard types will not get written out.
We could add a trivial, toast-compatible save_hdf5() method to AxisManager that calls the existing save() method to write the object contents to an HDF5 group. If this is too intrusive in cases where toast is not being used, we could just append that extra class method in sotodlib.toast.__init__ so that it is only defined in cases where toast is imported.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the upstream observation_hdf_save.py save_hdf5() handling linked in the issue, then inspect AxisManager.save() and sotodlib.toast.init. Determine whether the method belongs on AxisManager or should be added only when toast is imported. Done means arbitrary top-level AxisManager metadata is written through toast-compatible HDF5 saving.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100