Add zoom_adjust parameter to pygmt.datasets.load_tile_map and Figure.tilemap #2934

weiji14 · 2023-12-30T07:52:59Z

Description of proposed changes

The zoom_adjust parameter is used to adjust the automatic zoom level by integer increments.

Preview at https://pygmt-dev--2934.org.readthedocs.build/en/2934/api/generated/pygmt.datasets.load_tile_map.html

Note: This requires contextily>=1.5.0, see geopandas/contextily#228.

Example usage:

import contextily
import pygmt

region = [-157.84, -157.8, 21.255, 21.285]  # West, East, South, North
fig = pygmt.Figure()
with fig.subplot(ncols=2, figsize=("15c", "6c"), sharey=True):
    # Regular zoom level
    fig.tilemap(
        zoom="auto",
        region=region,
        source=contextily.providers.CartoDB.Positron,
        panel=0,
        frame="+tAuto Zoom",
    )
    # Zoom level -1 (more zoomed out)
    fig.tilemap(
        zoom="auto",
        region=region,
        source=contextily.providers.CartoDB.Positron,
        zoom_adjust=-1,
        panel=1,
        frame="+tAuto Zoom -1",
    )
fig.savefig("zoom_adjust.png")
fig.show(width=1000)

produces

Fixes #

Reminders

Run make format and make check to make sure the code follows the style guide.
Add tests for new features or tests that would have caught the bug that you're fixing.
Add new public functions/methods/classes to doc/api/index.rst.
Write detailed docstrings for all functions/methods.
If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
If adding new functionality, add an example to docstrings or tutorials.
Use underscores (not hyphens) in names of Python files and directories.

Slash Commands

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

/format: automatically format and lint the code
/test-gmt-dev: run full tests on the latest GMT development version

The zoom_adjust parameter is used to adjust the automatic zoom level by integer increments. This was added in contextily=1.5.0, see geopandas/contextily#228.

weiji14 · 2023-12-30T07:54:13Z

pygmt/datasets/tile_map.py

@@ -128,6 +141,7 @@ def load_tile_map(region, zoom="auto", source=None, lonlat=True, wait=0, max_ret
        ll=lonlat,
        wait=wait,
        max_retries=max_retries,
+        zoom_adjust=zoom_adjust,


Might need to make this backwards compatible with contextily<1.5.0.

Yes, need to check the contextily version and also better to mention that the zoom_adjust parameter requires contextily>=1.5.0.

Ok, documented at e48c08d, and added another commit at b428d12 to raise an error if zoom_adjust is used but contextily<1.5.0 is installed.

Also mention that the `zoom_adjust` parameter was added in PyGMT v0.11.0 using the versionadded sphinx directive (https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-versionadded).

seisman · 2024-01-04T08:47:45Z

pygmt/datasets/tile_map.py

+    lonlat=True,
+    wait=0,
+    max_retries=2,
+    zoom_adjust=None,


Add type hints to this newly added parameter?

Suggested change

zoom_adjust=None,

zoom_adjust: int | None,

Done at f0c95d8 for just the zoom_adjust parameter. Since all the lines are changing, should I just add type hints for all the other parameters too?

Perfer to focus on the zoom_adjust parameter only in this PR.

pygmt/datasets/tile_map.py

seisman · 2024-01-04T08:48:47Z

pygmt/datasets/tile_map.py

+        automatically. Values outside of -1 to 1 are not recommended as they
+        can lead to slow execution. [Default is ``None``].
+
+        .. versionadded:: 0.11.0


Maybe we should not add this until PyGMT reaches v1.0.0?

.. versionadded:: 0.11.0

Ok, changed to using the note directive instead at 0b01664. I've also used the note and important directive/admonition in other parts of the docstring at 32c04f8:

If it looks a bit messy, I can also revert the changes back to the plain text version.

pygmt/datasets/tile_map.py

Fixes `error: Argument 1 to "unsignedinteger" has incompatible type "list[int]"; expected "SupportsInt | str | bytes | SupportsIndex" [arg-type]`

pygmt/datasets/tile_map.py

Co-Authored-By: Dongdong Tian <[email protected]>

seisman · 2024-01-06T08:31:45Z

pygmt/datasets/tile_map.py

@@ -117,6 +135,15 @@ def load_tile_map(region, zoom="auto", source=None, lonlat=True, wait=0, max_ret
            "to install the package."
        )

+    contextily_kwargs = {}


Do you want to also include zoom, source, ll, wait and max_retries in contextily_kwargs?

Mm, not really necessary. I only made the contextily_kwargs dict to make things backwards compatible with contextily<1.5.0.

weiji14 · 2024-01-06T08:44:57Z

Gonna leave this open for another day or so in case someone wants to comment on anything.

pygmt/datasets/tile_map.py

Co-authored-by: Yvonne Fröhlich <[email protected]>

pygmt/src/tilemap.py

Co-authored-by: Dongdong Tian <[email protected]>

Add zoom_adjust param to pygmt.datasets.load_tile_map and Figure.tilemap

5ca369e

The zoom_adjust parameter is used to adjust the automatic zoom level by integer increments. This was added in contextily=1.5.0, see geopandas/contextily#228.

weiji14 added enhancement Improving an existing feature upstream Bug or missing feature of upstream core GMT labels Dec 30, 2023

weiji14 added this to the 0.11.0 milestone Dec 30, 2023

weiji14 self-assigned this Dec 30, 2023

weiji14 commented Dec 30, 2023

View reviewed changes

weiji14 added 4 commits January 4, 2024 19:22

Merge branch 'main' into tilemap_zoom_adjust

27669da

Document that zoom_adjust requires contextily>=1.5.0

e48c08d

Also mention that the `zoom_adjust` parameter was added in PyGMT v0.11.0 using the versionadded sphinx directive (https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-versionadded).

Raise error if zoom_adjust parameter is used with contextily<1.5.0

b428d12

Fix UnboundLocalError

ddb0351

seisman reviewed Jan 4, 2024

View reviewed changes

weiji14 added 6 commits January 6, 2024 19:03

Merge branch 'main' into tilemap_zoom_adjust

5cbbccb

Rewrap docstring to 88 characters

c36deff

Add type hint for zoom_adjust parameter

f0c95d8

Fix typecheck by using np.array constructor instead of np.uint8

70a4c83

Fixes `error: Argument 1 to "unsignedinteger" has incompatible type "list[int]"; expected "SupportsInt | str | bytes | SupportsIndex" [arg-type]`

Change directive for zoom_adjust from versionadded to note

0b01664

Use note and important admonitions in other parts of the docstring

32c04f8

seisman reviewed Jan 6, 2024

View reviewed changes

pygmt/datasets/tile_map.py Outdated Show resolved Hide resolved

weiji14 and others added 2 commits January 6, 2024 20:53

Rely on sphinx-autodoc-typehints

9170ea0

Co-Authored-By: Dongdong Tian <[email protected]>

Remove mention of Optional from zoom_adjust docstring

90a4d4f

seisman reviewed Jan 6, 2024

View reviewed changes

seisman approved these changes Jan 6, 2024

View reviewed changes

weiji14 marked this pull request as ready for review January 6, 2024 08:41

weiji14 added the final review call This PR requires final review and approval from a second reviewer label Jan 6, 2024

yvonnefroehlich reviewed Jan 6, 2024

View reviewed changes

pygmt/datasets/tile_map.py Outdated Show resolved Hide resolved

Use double backticks around zoom_adjust

c141db5

Co-authored-by: Yvonne Fröhlich <[email protected]>

seisman reviewed Jan 7, 2024

View reviewed changes

pygmt/src/tilemap.py Outdated Show resolved Hide resolved

Use double backticks around zoom_adjust again

dfd43b6

Co-authored-by: Dongdong Tian <[email protected]>

weiji14 merged commit c9c3a4a into main Jan 8, 2024
16 of 17 checks passed

weiji14 deleted the tilemap_zoom_adjust branch January 8, 2024 00:35

weiji14 removed the final review call This PR requires final review and approval from a second reviewer label Jan 8, 2024

yvonnefroehlich changed the title ~~Add zoom_adjust param to pygmt.datasets.load_tile_map and Figure.tilemap~~ Add zoom_adjust parameter to pygmt.datasets.load_tile_map and Figure.tilemap Jan 28, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add zoom_adjust parameter to pygmt.datasets.load_tile_map and Figure.tilemap #2934

Add zoom_adjust parameter to pygmt.datasets.load_tile_map and Figure.tilemap #2934

weiji14 commented Dec 30, 2023 •

edited

Loading

weiji14 Dec 30, 2023

seisman Jan 1, 2024

weiji14 Jan 4, 2024

seisman Jan 4, 2024

weiji14 Jan 6, 2024

seisman Jan 6, 2024

seisman Jan 4, 2024

weiji14 Jan 6, 2024

seisman Jan 6, 2024

weiji14 Jan 6, 2024

weiji14 commented Jan 6, 2024

Add zoom_adjust parameter to pygmt.datasets.load_tile_map and Figure.tilemap #2934

Add zoom_adjust parameter to pygmt.datasets.load_tile_map and Figure.tilemap #2934

Conversation

weiji14 commented Dec 30, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

weiji14 commented Jan 6, 2024

weiji14 commented Dec 30, 2023 •

edited

Loading