Migrate frame settings to the Frame/Axis class [frame="a"] (#4529)

Author: seisman

examples/gallery/seismology/meca.py

@@ -13,6 +13,7 @@
 
 # %%
 import pygmt
+from pygmt.params import Axis
 
 fig = pygmt.Figure()
 
@@ -23,7 +24,7 @@
     land="grey",
     water="lightblue",
     shorelines=True,
-    frame="a",
+    frame=Axis(annot=True),
 )
 
 # Store focal mechanism parameters in a dictionary based on the Aki & Richards

examples/intro/02_contour_map.py

@@ -10,6 +10,7 @@
 
 # %%
 import pygmt
+from pygmt.params import Axis
 
 # %%
 # Loading the Earth relief dataset
@@ -43,7 +44,7 @@
 # "oleron" is used; a full list of CPTs can be found at :gmt-docs:`reference/cpts.html`.
 
 fig = pygmt.Figure()
-fig.grdimage(grid=grid, frame="a", projection="M10c", cmap="SCM/oleron")
+fig.grdimage(grid=grid, frame=Axis(annot=True), projection="M10c", cmap="SCM/oleron")
 fig.show()
 
 
@@ -63,7 +64,7 @@
 # :meth:`pygmt.Figure.grdimage`.
 
 fig = pygmt.Figure()
-fig.grdimage(grid=grid, frame="a", projection="M10c", cmap="SCM/oleron")
+fig.grdimage(grid=grid, frame=Axis(annot=True), projection="M10c", cmap="SCM/oleron")
 fig.colorbar(annot=1000, label="Elevation", unit="m")
 fig.show()
 
@@ -84,7 +85,7 @@
 # lines can be adjusted (separately) by specifying the desired ``pen``.
 
 fig = pygmt.Figure()
-fig.grdimage(grid=grid, frame="a", projection="M10c", cmap="SCM/oleron")
+fig.grdimage(grid=grid, frame=Axis(annot=True), projection="M10c", cmap="SCM/oleron")
 fig.grdcontour(grid=grid, levels=500, annotation=1000)
 fig.colorbar(annot=1000, label="Elevation", unit="m")
 fig.show()
@@ -99,7 +100,7 @@
 # the ``shorelines`` parameter draws a border around the islands.
 
 fig = pygmt.Figure()
-fig.grdimage(grid=grid, frame="a", projection="M10c", cmap="SCM/oleron")
+fig.grdimage(grid=grid, frame=Axis(annot=True), projection="M10c", cmap="SCM/oleron")
 fig.grdcontour(grid=grid, levels=500, annotation=1000)
 fig.coast(shorelines="2p", land="lightgray")
 fig.colorbar(annot=1000, label="Elevation", unit="m")

examples/tutorials/advanced/earth_relief.py

@@ -9,6 +9,7 @@
 
 # %%
 import pygmt
+from pygmt.params import Axis
 
 # %%
 # Load sample Earth relief data for the entire globe at a resolution of 1 arc-degree.
@@ -90,11 +91,11 @@
 #
 # The example below uses data with a 10 arc-minutes resolution, and plots it on a
 # 15-centimeters-wide figure with a Mercator projection and a CPT set to *geo*.
-# ``frame="a"`` is used to add a frame with annotations to the figure.
+# ``frame=Axis(annot=True)`` is used to add a frame with annotations to the figure.
 
 grid = pygmt.datasets.load_earth_relief(resolution="10m", region=[-14, 30, 35, 60])
 fig = pygmt.Figure()
-fig.grdimage(grid=grid, projection="M15c", frame="a", cmap="gmt/geo")
+fig.grdimage(grid=grid, projection="M15c", frame=Axis(annot=True), cmap="gmt/geo")
 fig.colorbar(annot=1000, label="Elevation", unit="m")
 fig.show()
 

examples/tutorials/advanced/insets.py

@@ -10,7 +10,7 @@
 
 # %%
 import pygmt
-from pygmt.params import Box, Position
+from pygmt.params import Axis, Box, Position
 
 # %%
 # Prior to creating an inset figure, a larger figure must first be plotted. In the
@@ -25,7 +25,7 @@
     projection="M15c",  # Set Mercator projection and size of 15 centimeter
     land="lightyellow",  # Color land areas light yellow
     water="lightblue",  # Color water areas light blue
-    frame="a",  # Set frame with annotation and major tick spacing
+    frame=Axis(annot=True),  # Set frame with annotations
 )
 fig.show()
 
@@ -43,7 +43,7 @@
     projection="M15c",
     land="lightyellow",
     water="lightblue",
-    frame="a",
+    frame=Axis(annot=True),
 )
 with fig.inset(position=Position("BL"), width=3, box=Box(pen="black", fill="lightred")):
     # pass is used to exit the with statement as no plotting methods are called
@@ -65,7 +65,7 @@
     projection="M15c",
     land="lightyellow",
     water="lightblue",
-    frame="a",
+    frame=Axis(annot=True),
 )
 with fig.inset(
     position=Position("BL", offset=(0.5, 0.2)),
@@ -89,7 +89,7 @@
     projection="M15c",
     land="lightyellow",
     water="lightblue",
-    frame="a",
+    frame=Axis(annot=True),
 )
 # This does not include an inset fill as it is covered by the inset figure. Inset
 # width/height are determined by the ``region`` and ``projection`` parameters.

pygmt/src/coast.py

@@ -211,6 +211,7 @@ def coast(  # noqa: PLR0913
     Example
     -------
     >>> import pygmt
+    >>> from pygmt.params import Axis
     >>> # Create a new plot with pygmt.Figure()
     >>> fig = pygmt.Figure()
     >>> # Call the coast method for the plot
@@ -220,7 +221,7 @@ def coast(  # noqa: PLR0913
     ...     # Set the region of the plot
     ...     region=[-10, 30, 30, 60],
     ...     # Set the frame of the plot, here annotations and major ticks
-    ...     frame="a",
+    ...     frame=Axis(annot=True),
     ...     # Set the color of the land to "darkgreen"
     ...     land="darkgreen",
     ...     # Set the color of the water to "lightblue"

pygmt/src/grdcontour.py

@@ -129,6 +129,7 @@ def grdcontour(
     Example
     -------
     >>> import pygmt
+    >>> from pygmt.params import Axis
     >>> # Load the 15 arc-minutes grid with "gridline" registration in the
     >>> # specified region
     >>> grid = pygmt.datasets.load_earth_relief(
@@ -147,7 +148,7 @@ def grdcontour(
     ...     # Set the interval for annotated contour lines at 1,000 meters
     ...     annotation=1000,
     ...     # Add a frame for the plot
-    ...     frame="a",
+    ...     frame=Axis(annot=True),
     ...     # Set the projection to Mercator for the 10 cm figure
     ...     projection="M10c",
     ... )

pygmt/tests/test_coast.py

@@ -5,6 +5,7 @@
 import pytest
 from pygmt import Figure
 from pygmt.exceptions import GMTParameterError
+from pygmt.params import Axis
 
 
 @pytest.mark.benchmark
@@ -52,7 +53,7 @@ def test_coast_dcw_single():
     fig = Figure()
     fig.coast(
         region=[-10, 15, 25, 44],
-        frame="a",
+        frame=Axis(annot=True),
         projection="M15c",
         land="brown",
         dcw="ES+gbisque+pblue",
@@ -68,7 +69,7 @@ def test_coast_dcw_list():
     fig = Figure()
     fig.coast(
         region=[-10, 15, 25, 44],
-        frame="a",
+        frame=Axis(annot=True),
         projection="M15c",
         land="brown",
         dcw=["ES+gbisque+pgreen", "IT+gcyan+pblue"],

pygmt/tests/test_colorbar.py

@@ -5,6 +5,7 @@
 import pytest
 from pygmt import Figure
 from pygmt.exceptions import GMTParameterError
+from pygmt.params import Axis
 from pygmt.params.position import Position
 
 
@@ -30,7 +31,7 @@ def test_colorbar_shading_list():
     Create colorbar and set shading by passing the high/low values as a list.
     """
     fig = Figure()
-    fig.basemap(region=[0, 10, 0, 2], projection="X10c/2c", frame="a")
+    fig.basemap(region=[0, 10, 0, 2], projection="X10c/2c", frame=Axis(annot=True))
     fig.colorbar(cmap="gmt/geo", shading=[-0.7, 0.2], frame=True)
     return fig
 

pygmt/tests/test_contour.py

@@ -10,6 +10,7 @@
 import pytest
 import xarray as xr
 from pygmt import Figure
+from pygmt.params import Axis
 
 POINTS_DATA = Path(__file__).parent / "data" / "points.txt"
 
@@ -44,7 +45,15 @@ def test_contour_vec(region):
     y = y.flatten()
     z = (x - 0.5 * (region[0] + region[1])) ** 2 + 4 * y**2
     z = np.exp(-z / 10**2 * np.log(2))
-    fig.contour(x=x, y=y, z=z, projection="X10c", region=region, frame="a", pen=True)
+    fig.contour(
+        x=x,
+        y=y,
+        z=z,
+        projection="X10c",
+        region=region,
+        frame=Axis(annot=True),
+        pen=True,
+    )
     return fig
 
 
@@ -160,7 +169,7 @@ def test_contour_incols_transposed_data(region):
         data,
         projection="X10c",
         region=region,
-        frame="a",
+        frame=Axis(annot=True),
         pen=True,
         incols=[1, 0, 2],
     )

pygmt/tests/test_grd2cpt.py

@@ -9,6 +9,7 @@
 from pygmt.exceptions import GMTParameterError, GMTTypeError, GMTValueError
 from pygmt.helpers import GMTTempFile
 from pygmt.helpers.testing import load_static_earth_relief
+from pygmt.params import Axis
 
 
 @pytest.fixture(scope="module", name="grid")
@@ -27,9 +28,9 @@ def test_grd2cpt(grid):
     with a color bar.
     """
     fig = Figure()
-    fig.basemap(frame="a", projection="W0/15c", region="d")
+    fig.basemap(frame=Axis(annot=True), projection="W0/15c", region="d")
     grd2cpt(grid=grid)
-    fig.colorbar(frame="a")
+    fig.colorbar(frame=Axis(annot=True))
     return fig