RadioAstronomySoftwareGroup / RadioAstronomySoftwareGroup/pyuvdata
Provide functionality to print a summary of UVData object's UVParameters
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 102
- Forks
- 36
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 14
Description
Although UVParameter attributes can be individually accessed, providing a functionality of a convenience function that prints the summary of the parameters, somewhat along the lines of a FITS header or something equivalent in one go for a quick view will be useful. This applies to metadata, usually small arrays and scalars that can be printed nicely.
See the CASA page here for examples -- https://casa.nrao.edu/casadocs-devel/stable/imaging/image-analysis/dealing-with-image-headers
Even though that page deals with FITS images as examples, an equivalent functionality can be provided for the UVData object.
Contributor guide
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 by reading the UVData object and its UVParameter attributes to understand which metadata, arrays, and scalars should be included. Use the linked CASA examples as a reference, and consider the work complete when UVData provides a convenient one-call summary with readable parameter output.
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
- Needs clarification
- Newbie friendliness
- 35/100