Migrate frame settings to the Frame/Axis class [frame='af' and frame='afg'] (#4531)

Author: seisman

examples/gallery/embellishments/timestamp.py

@@ -12,6 +12,7 @@
 import os
 
 import pygmt
+from pygmt.params import Axis
 
 fig = pygmt.Figure()
 fig.basemap(region=[20, 30, -10, 10], projection="X10c/5c", frame=True)
@@ -25,7 +26,13 @@
 os.environ["TZ"] = "Pacific/Honolulu"  # optionally set the time zone
 
 fig = pygmt.Figure()
-fig.coast(region="d", projection="H10c", land="black", water="cornsilk", frame="afg")
+fig.coast(
+    region="d",
+    projection="H10c",
+    land="black",
+    water="cornsilk",
+    frame=Axis(annot=True, tick=True, grid=True),
+)
 fig.timestamp(
     label="Powered by PyGMT",
     justify="TL",

examples/gallery/images/cross_section.py

@@ -14,7 +14,7 @@
 
 # %%
 import pygmt
-from pygmt.params import Box, Position
+from pygmt.params import Axis, Box, Position
 
 # Define region of study area
 # lon_min, lon_max, lat_min, lat_max in degrees East and North
@@ -30,7 +30,7 @@
 # Bottom: Map of elevation in study area
 
 # Set up basic map using a Mercator projection with a width of 12 centimeters
-fig.basemap(region=region_map, projection="M12c", frame="af")
+fig.basemap(region=region_map, projection="M12c", frame=Axis(annot=True, tick=True))
 
 # Download grid for Earth relief with a resolution of 10 arc-minutes and gridline
 # registration [Default]

examples/gallery/maps/borders.py

@@ -18,11 +18,16 @@
 
 # %%
 import pygmt
+from pygmt.params import Axis
 
 fig = pygmt.Figure()
 # Make a Sinusoidal projection map of the Americas with automatic annotations,
 # ticks and gridlines
-fig.basemap(region=[-150, -30, -60, 60], projection="I-90/15c", frame="afg")
+fig.basemap(
+    region=[-150, -30, -60, 60],
+    projection="I-90/15c",
+    frame=Axis(annot=True, tick=True, grid=True),
+)
 # Plot each level of the boundaries dataset with a different color.
 fig.coast(borders=["1/0.5p,black", "2/0.5p,red", "3/0.5p,blue"], land="gray")
 fig.show()

examples/gallery/maps/country_polygons.py

@@ -12,6 +12,7 @@
 
 # %%
 import pygmt
+from pygmt.params import Axis
 
 fig = pygmt.Figure()
 
@@ -21,7 +22,7 @@
     projection="A10/52/25/6c",
     land="gray",
     water="white",
-    frame="afg",
+    frame=Axis(annot=True, tick=True, grid=True),
     dcw=[
         # Great Britain (country code) with seagreen land
         "GB+gseagreen",
@@ -54,7 +55,7 @@
     projection="H10c",
     land="gray",
     water="white",
-    frame="afg",
+    frame=Axis(annot=True, tick=True, grid=True),
     dcw=[
         # Europe
         "=EU+gseagreen",

examples/gallery/maps/tilemaps.py

@@ -9,6 +9,7 @@
 # %%
 import contextily
 import pygmt
+from pygmt.params import Axis
 
 fig = pygmt.Figure()
 fig.tilemap(
@@ -22,7 +23,7 @@
     zoom=14,
     # Use tiles from OpenStreetMap tile server
     source="https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png",
-    frame="afg",
+    frame=Axis(annot=True, tick=True, grid=True),
 )
 
 fig.show()
@@ -39,7 +40,7 @@
     projection="M12c",
     # Use the CartoDB Positron option from contextily
     source=contextily.providers.CartoDB.Positron,
-    frame="afg",
+    frame=Axis(annot=True, tick=True, grid=True),
 )
 
 fig.show()

examples/projections/azim/azim_equidistant.py

@@ -20,9 +20,14 @@
 
 # %%
 import pygmt
+from pygmt.params import Axis
 
 fig = pygmt.Figure()
 fig.coast(
-    region="g", projection="E-100/40/15c", frame="afg", land="khaki", water="white"
+    region="g",
+    projection="E-100/40/15c",
+    frame=Axis(annot=True, tick=True, grid=True),
+    land="khaki",
+    water="white",
 )
 fig.show()

examples/projections/azim/azim_general_perspective.py

@@ -30,12 +30,13 @@
 
 # %%
 import pygmt
+from pygmt.params import Axis
 
 fig = pygmt.Figure()
 fig.coast(
     region="g",
     projection="G4/52/12c+a30+t45+v60/60+w0+z250",
-    frame="afg",
+    frame=Axis(annot=True, tick=True, grid=True),
     land="khaki",
     water="white",
 )

examples/projections/azim/azim_general_stereographic.py

@@ -20,12 +20,13 @@
 
 # %%
 import pygmt
+from pygmt.params import Axis
 
 fig = pygmt.Figure()
 fig.coast(
     region=[4, 14, 52, 57],
     projection="S0/90/12c",
-    frame="afg",
+    frame=Axis(annot=True, tick=True, grid=True),
     land="khaki",
     water="white",
 )

examples/projections/azim/azim_gnomonic.py

@@ -21,12 +21,13 @@
 
 # %%
 import pygmt
+from pygmt.params import Axis
 
 fig = pygmt.Figure()
 fig.coast(
     region="g",
     projection="F-90/15/12c",
-    frame="afg",
+    frame=Axis(annot=True, tick=True, grid=True),
     land="khaki",
     water="white",
 )

examples/projections/azim/azim_lambert.py

@@ -18,12 +18,13 @@
 
 # %%
 import pygmt
+from pygmt.params import Axis
 
 fig = pygmt.Figure()
 fig.coast(
     region="g",
     projection="A30/-20/60/12c",
-    frame="afg",
+    frame=Axis(annot=True, tick=True, grid=True),
     land="khaki",
     water="white",
 )