add support for InSAR Explorer by mahmud1 · Pull Request #1330 · insarlab/MintPy

mahmud1 · 2025-03-11T12:14:42Z

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

Pass Pre-commit check (green)
Make sure that your code follows our style. Use the other functions/files as a basis.
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.py to convert time series and velocity data to GRD files for use with the QGIS InSAR Explorer plugin.

welcome · 2025-03-11T12:14:45Z

💖 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.

sourcery-ai · 2025-03-11T12:14:47Z

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.	Added a new command-line tool `save_explorer.py` in the `mintpy.cli` module. Implemented the core logic for converting time series and velocity data to GRD format in the `mintpy.save_explorer` module. Added argument parsing and handling for input files (time series, velocity, mask) and output directory. Included a function to convert the unit of displacement from meter or centimeter to millimeter. Implemented masking functionality to handle masked data points. Integrated the new tool into the main `mintpy` command-line interface.	`src/mintpy/__main__.py` `src/mintpy/cli/save_explorer.py` `src/mintpy/save_explorer.py` `pyproject.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.	Added a new documentation page `insar_explorer.md` with detailed instructions on setting up QGIS and the InSAR Explorer plugin. Documented the usage of `save_explorer.py` for converting MintPy results to GRD files. Included instructions on how to load and visualize the exported data in QGIS using the InSAR Explorer plugin. Added a reference to the InSAR Explorer plugin in the `QGIS.md` documentation page. Updated the `mkdocs.yml` file to include the new `insar_explorer.md` page in the navigation menu.	`docs/QGIS.md` `mkdocs.yml` `docs/insar_explorer.md`

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on 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 issue to create an issue from it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai title on the pull request to (re-)generate the title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment @sourcery-ai summary on the pull request to
(re-)generate the summary at any time.
Generate reviewer's guide: Comment @sourcery-ai guide on the pull
request to (re-)generate the reviewer's guide at any time.
Resolve all Sourcery comments: Comment @sourcery-ai resolve on 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 dismiss on 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 review to trigger a new review!
Generate a plan of action for an issue: Comment @sourcery-ai plan on
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.

sourcery-ai

Hey @mahmud1 - I've reviewed your changes - here's some feedback:

Overall Comments:

Consider adding a test case to verify the functionality of the new save_explorer.py script.
It would be helpful to include a note about the expected data format (e.g., GeoTIFF, HDF5) for the mask file.

Here's what I looked at during the review

🟡 General issues: 4 issues found
🟢 Security: all looks good
🟢 Testing: all looks good
🟡 Complexity: 1 issue found
🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

src/mintpy/save_explorer.py

docs/QGIS.md

docs/insar_explorer.md

src/mintpy/save_explorer.py

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

+ use progressBar for a cleaner print out msg + auto grab the default velocity/mask files if available + more print out msg

yunjunz

Thank you @mahmud1 for the PR! I played with the InSAR Explorer a little bit today, and it's much easier to use (and more powerful as well) than the PS Time Series Viewer, so I merged your content in the insar-explorer page into the QGIS page and moved it to the front. Nice plugin!

welcome · 2025-07-06T14:49:33Z

🎉 🎉 🎉 Congrats on merging your first pull request! We here at behaviorbot are proud of you! 🎉 🎉 🎉

mahmud1 · 2025-07-06T15:21:04Z

Thank you @yunjunz for reviewing and approving the PR. I’m glad to hear that you found InSAR Explorer easy to use.

add save_explorer to support InSAR Explorer

545bd5b

sourcery-ai bot reviewed Mar 11, 2025

View reviewed changes

src/mintpy/save_explorer.py Outdated Show resolved Hide resolved

src/mintpy/save_explorer.py Outdated Show resolved Hide resolved

docs/QGIS.md Outdated Show resolved Hide resolved

docs/insar_explorer.md Outdated Show resolved Hide resolved

src/mintpy/save_explorer.py Show resolved Hide resolved

mahmud1 and others added 5 commits March 11, 2025 13:39

Update docs/insar_explorer.md

ea522cd

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

Update src/mintpy/save_explorer.py

ed7c9c5

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

Update src/mintpy/save_explorer.py

97a1077

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

fix typo

bc0eb01

remove unnecessary import in sarvey_export

ded9600

yunjunz self-requested a review April 1, 2025 09:37

mahmud1 and others added 5 commits June 4, 2025 10:25

Merge branch 'insarlab:main' into insar-explorer

92f052a

refactor save_explorer.py

292d0d6

+ use progressBar for a cleaner print out msg + auto grab the default velocity/mask files if available + more print out msg

merge InSAR Explorer content into QGIS with screenshot

e09daa4

remove the duplicated insar-explorer page

cd00ea9

pre-commit update

cf11366

yunjunz approved these changes Jul 6, 2025

View reviewed changes

yunjunz merged commit 57e5f02 into insarlab:main Jul 6, 2025
8 checks passed

mahmud1 deleted the insar-explorer branch July 12, 2025 23:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add support for InSAR Explorer#1330

add support for InSAR Explorer#1330
yunjunz merged 11 commits intoinsarlab:mainfrom
mahmud1:insar-explorer

mahmud1 commented Mar 11, 2025 •

edited

Loading

Uh oh!

welcome bot commented Mar 11, 2025

Uh oh!

sourcery-ai bot commented Mar 11, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yunjunz left a comment

Uh oh!

Uh oh!

welcome bot commented Jul 6, 2025

Uh oh!

mahmud1 commented Jul 6, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

mahmud1 commented Mar 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by Sourcery

Uh oh!

welcome bot commented Mar 11, 2025

Uh oh!

sourcery-ai bot commented Mar 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide by Sourcery

Sequence diagram for save_explorer.py execution

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yunjunz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

welcome bot commented Jul 6, 2025

Uh oh!

mahmud1 commented Jul 6, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mahmud1 commented Mar 11, 2025 •

edited

Loading

sourcery-ai bot commented Mar 11, 2025 •

edited

Loading