MintPy
MintPy copied to clipboard
add support for InSAR Explorer
Description of proposed changes
save_explorer.py implemented to convert time series and velocity to GRD files compatible with QGIS InSAR Explorer plugin (https://insar-explorer.readthedocs.io/). The documentation is updated accordingly.
Reminders
- [x] Pass Pre-commit check (green)
- [x] Make sure that your code follows our style. Use the other functions/files as a basis.
- [x] If adding new functionality, add a detailed description to the documentation and/or an example.
Summary by Sourcery
New Features:
- Adds a new command-line tool
save_explorer.pyto convert time series and velocity data to GRD files for use with the QGIS InSAR Explorer plugin.
š Thanks for opening this pull request! Please check out our contributing guidelines. š Keep in mind that all new features should be documented. It helps to write the comments next to the code or below your functions describing all arguments, and return types before writing the code. This will help you think about your code design and usually results in better code.
Reviewer's Guide by Sourcery
This pull request introduces a new tool, save_explorer.py, to convert MintPy time series and velocity data into GRD files compatible with the QGIS InSAR Explorer plugin. It also includes comprehensive documentation on how to use the new tool and integrate MintPy with the QGIS InSAR Explorer plugin for enhanced visualization of displacement time series.
Sequence diagram for save_explorer.py execution
sequenceDiagram
participant User
participant save_explorer.py
participant readfile.py
participant save_gmt.py
User->>save_explorer.py: Executes save_explorer.py with input files and options
save_explorer.py->>readfile.py: Reads mask file (optional)
alt velocity file provided
save_explorer.py->>readfile.py: Reads velocity file
save_explorer.py->>save_explorer.py: Converts velocity data to mm
save_explorer.py->>save_gmt.py: Writes velocity data to GRD file
end
loop for each timeseries slice
save_explorer.py->>readfile.py: Reads timeseries data for slice
save_explorer.py->>save_explorer.py: Converts timeseries data to mm
save_explorer.py->>save_gmt.py: Writes timeseries data to GRD file
end
save_explorer.py-->>User: Completion message
File-Level Changes
| Change | Details | Files |
|---|---|---|
Implemented a new command-line tool save_explorer.py to convert time series and velocity data into GRD files, which are compatible with the QGIS InSAR Explorer plugin. |
|
src/mintpy/__main__.pysrc/mintpy/cli/save_explorer.pysrc/mintpy/save_explorer.pypyproject.toml |
Updated the documentation to include instructions on how to use the new save_explorer.py tool and integrate MintPy with the QGIS InSAR Explorer plugin. |
|
docs/QGIS.mdmkdocs.ymldocs/insar_explorer.md |
Tips and commands
Interacting with Sourcery
- Trigger a new review: Comment
@sourcery-ai reviewon the pull request. - Continue discussions: Reply directly to Sourcery's review comments.
- Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with
@sourcery-ai issueto create an issue from it. - Generate a pull request title: Write
@sourcery-aianywhere in the pull request title to generate a title at any time. You can also comment@sourcery-ai titleon the pull request to (re-)generate the title at any time. - Generate a pull request summary: Write
@sourcery-ai summaryanywhere in the pull request body to generate a PR summary at any time exactly where you want it. You can also comment@sourcery-ai summaryon the pull request to (re-)generate the summary at any time. - Generate reviewer's guide: Comment
@sourcery-ai guideon the pull request to (re-)generate the reviewer's guide at any time. - Resolve all Sourcery comments: Comment
@sourcery-ai resolveon the pull request to resolve all Sourcery comments. Useful if you've already addressed all the comments and don't want to see them anymore. - Dismiss all Sourcery reviews: Comment
@sourcery-ai dismisson the pull request to dismiss all existing Sourcery reviews. Especially useful if you want to start fresh with a new review - don't forget to comment@sourcery-ai reviewto trigger a new review! - Generate a plan of action for an issue: Comment
@sourcery-ai planon an issue to generate a plan of action for it.
Customizing Your Experience
Access your dashboard to:
- Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others.
- Change the review language.
- Add, remove or edit custom review instructions.
- Adjust other review settings.
Getting Help
- Contact our support team for questions or feedback.
- Visit our documentation for detailed guides and information.
- Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.
š š š Congrats on merging your first pull request! We here at behaviorbot are proud of you! š š š
Thank you @yunjunz for reviewing and approving the PR. Iām glad to hear that you found InSAR Explorer easy to use.