Skip to content

Add blockmedian and surface gallery example - #4771

Open
Aayush7788 wants to merge 8 commits into
GenericMappingTools:mainfrom
Aayush7788:docs-blockmedian-surface
Open

Add blockmedian and surface gallery example#4771
Aayush7788 wants to merge 8 commits into
GenericMappingTools:mainfrom
Aayush7788:docs-blockmedian-surface

Conversation

@Aayush7788

@Aayush7788 Aayush7788 commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Description of proposed changes

Adds a gallery example showing how to reduce irregular bathymetry observations
with pygmt.blockmedian before interpolating them with pygmt.surface.

The example uses the built-in bathymetry sample dataset and compares the reduced
observations with the resulting grid.

Fixes #1352

Preview: https://pygmt-dev--4771.org.readthedocs.build/en/4771/gallery/images/gridding_with_surface.html

Guidelines

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash command is:

  • /format: automatically format and lint the code

@seisman seisman added documentation Improvements or additions to documentation needs review This PR has higher priority and needs review. labels Jul 28, 2026
@seisman seisman added this to the 0.20.0 milestone Jul 28, 2026
Comment thread examples/gallery/images/gridding_with_surface.py Outdated
Comment thread examples/gallery/images/gridding_with_surface.py Outdated
Comment thread examples/gallery/images/gridding_with_surface.py Outdated
data=data,
region=region,
spacing=spacing,
C=True,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems the -C option is not aliased in PyGMT yet. Would you like to add it in a separate PR?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for pointing this out; I’ll keep this PR focused on the gallery example and leave the alias for a separate contribution.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This example already looks good, but we need to implement the -C alias before merging this PR.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Understood. I’ll implement the -C alias in a separate PR first. Before I start, could you please confirm that the public parameter should be named center and that it should be added consistently to blockmean, blockmedian, and blockmode, since GMT supports -C in all three modules? After that PR is merged, I’ll update this example to use center=True.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. If you look at the source code, you’ll notice that there are currently two ways to add the -C alias because we are transitioning from the old alias system to the new one: (1) using the use_alias decorator and (2) using the AliasSystem class. The use_alias decorator belongs to the old system and is no longer recommended, so please add the alias using AliasSystem instead.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I opened #4780 to add the center parameter to blockmean, blockmedian, and blockmode using AliasSystem.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please merge the main branch into this branch, and then update C=True to center=True.

Comment thread examples/gallery/images/gridding_with_surface.py
Comment thread examples/gallery/images/gridding_with_surface.py Outdated
Comment thread examples/gallery/images/gridding_with_surface.py Outdated
Comment thread examples/gallery/images/gridding_with_surface.py Outdated
Comment thread examples/gallery/images/gridding_with_surface.py
Comment thread examples/gallery/images/gridding_with_surface.py Outdated
Aayush7788 and others added 4 commits July 29, 2026 14:17
updated

Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
updated

Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
updated

Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
@Aayush7788

Copy link
Copy Markdown
Contributor Author

@seisman , any update

@Aayush7788

Copy link
Copy Markdown
Contributor Author

@seisman, any update on this branch?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation needs review This PR has higher priority and needs review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Gallery example to showcase blockmean/blockmedian and surface

3 participants