RadioAstronomySoftwareGroup / RadioAstronomySoftwareGroup/pyuvdata

Feature Request/Idea: Meta-MetaData File

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

Nobody has claimed this yet.

enhancement major needs research
Dominant language
Python
Stars
102
Forks
35
Avg merge
1d 20h
Merged PRs (30d)
14

Description

Every UVData file contains metadata, but often in real applications you have MANY such files. For example HERA has many files per night, each with two integrations (and otherwise, all the same metadata). OTOH, our large-scale simulations tend to output many files with one frequency per file.

Sometimes, finding the file you really need is quite tricky (sometimes not, of course). For instance, when LST-binning, you need to know the LSTs of within the file, but this can be difficult to put into the filename, for example. But reading every file within a folder to find the right file can take a LONG time, because just creating file handles for so many files takes a long time, not to mention actually reading any of the data.

I propose that we create a meta-metadata file format that smoothly handles these situations. I see the benefits as being:

  1. Easier selection of data from a group of files (as mentioned above)
  2. Easier planning for optimal concat operations, potentially including concatenation over multiple axes simultaneously.
  3. Potentially also ability to do quick "checks" of the integrity of a database of files.

One way to do all this (and probably the most efficient for any given application) would be to create a bonafide database. But this might be overkill in many cases, and scientists often prefer to just deal with files. So I propose we simply create a new HDF5-formatted bespoke format.

Contributor guide

Open the contributing guide

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 by reviewing how UVData files and their metadata are represented, then examine the existing UVH5/HDF5 handling in the project. Define the proposed meta-metadata format, file-selection information, concat-planning data, and integrity checks before implementation; done means the format and its scope are agreed.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
databases
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.