Add utility test function for verifying reader data
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 335
- Avg merge
- 1d 18h
- Merged PRs (30d)
- 10
Description
It would be nice if we add a utility function to satpy.tests.utils that, given a DataArray, verified dimensions (y, x), coordinates, and attributes (area, platform_name, sensor, start_time, units, etc). It would then be expected that reader developers use this function in their unit tests. It could also be used as a sanity check when debugging problems.
The specifics of what this function needs to verify are described above and/or in the custom reader documentation. Once a pull request is made for the basics the @pytroll/core developers can verify that everything is checked that needs to be checked.
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 in satpy.tests.utils and read the custom reader documentation for the expected DataArray dimensions, coordinates, and attributes. Check existing reader unit tests to understand how reader data is represented. Done means a utility function verifies the requested fields and can be used by reader developers in their tests and during debugging.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- testing-qa
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100