RadioAstronomySoftwareGroup / RadioAstronomySoftwareGroup/pyuvdata
Estimate memory footprint for UVBased objects
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 102
- Forks
- 35
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 14
Description
It would be nice to have a property (probably on UVBase) that would iterate through all the parameters on an object to estimate its memory footprint. This should be trivial for anything that is a numpy array (or subclass) or scalar. Other python built-ins like list and dict get a bit more complicated. We could follow something like is in this stackoverflow post if we wanted to include those too .
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 locating UVBase and the parameters used by UVBased objects. Review how numpy arrays, numpy scalars, lists, and dictionaries are represented in those parameters, and use the linked Stack Overflow approach as context for nested built-ins. Done means a property can estimate the object's memory footprint, with the supported parameter types and expected behavior made explicit.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- numpy, python
- Domain
- data
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100