isce-framework / isce-framework/isce3
API reference for Python product reader classes
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 239
- Forks
- 90
- Avg merge
- 13d 1h
- Merged PRs (30d)
- 5
Description
I'm coming up to speed on interacting with NISAR data products in Python using the ISCE3 product readers. I'm quite happy with the interface; see this gist for an example of how easy it is to access the data bands and geotransform of a mock GCOV product.
It's been a struggle to learn what attributes/functions are available for each product type. Is there an API reference available for the readers, or any examples? None of the Getting Started links in the README take me anywhere productive.
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 checking the README's Getting Started links and the linked gist's Python example for the ISCE3 product readers. Identify how API information or examples should cover the available attributes and functions for each product type. Done means newcomers can find a working API reference or examples for interacting with NISAR data products.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100