Use Box in examples and tests

Author: seisman

examples/gallery/images/cross_section.py

@@ -14,6 +14,7 @@
 
 # %%
 import pygmt
+from pygmt.params import Box
 
 # Define region of study area
 # lon_min, lon_max, lat_min, lat_max in degrees East and North
@@ -44,9 +45,9 @@
     # corner with an offset ("+o") of 0.7 centimeters and 0.3 centimeters in x- or y-
     # directions, respectively; move the x-label above the horizontal colorbar ("+ml")
     position="jBR+o0.7c/0.8c+h+w5c/0.3c+ml",
-    # Add a box around the colobar with a fill ("+g") in "white" color and a
-    # transparency ("@") of 30 % and with a 0.8-points thick, black, outline ("+p")
-    box="+gwhite@30+p0.8p,black",
+    # Add a box around the colobar, filled in "white" and a 30% transparency, with a
+    # 0.8-points thick, black, outline.
+    box=Box(pen="0.8p,black", fill="white@30"),
     # Add x- and y-labels ("+l")
     frame=["x+lElevation", "y+lm"],
 )

examples/gallery/lines/hlines_vlines.py

@@ -12,6 +12,7 @@
 # In Cartesian coordinate systems lines are plotted as straight lines.
 
 import pygmt
+from pygmt.params import Box
 
 fig = pygmt.Figure()
 
@@ -31,7 +32,7 @@
 fig.hlines(
     y=[2, 3], xmin=[0, 1], xmax=[7, 7.5], pen="1.5p,dodgerblue3", label="Lines 7 & 8"
 )
-fig.legend(position="JBR+jBR+o0.2c", box="+gwhite+p1p")
+fig.legend(position="JBR+jBR+o0.2c", box=Box(pen="1p", fill="white"))
 
 fig.shift_origin(xshift="w+2c")
 

examples/tutorials/advanced/insets.py

@@ -10,6 +10,7 @@
 
 # %%
 import pygmt
+from pygmt.params import Box
 
 # %%
 # Prior to creating an inset figure, a larger figure must first be plotted. In
@@ -48,7 +49,7 @@
     water="lightblue",
     frame="a",
 )
-with fig.inset(position="jBL+w3c", box="+pblack+glightred"):
+with fig.inset(position="jBL+w3c", box=Box(pen="black", fill="lightred")):
     # pass is used to exit the with statement as no plotting methods are
     # called
     pass
@@ -72,7 +73,7 @@
     water="lightblue",
     frame="a",
 )
-with fig.inset(position="jBL+w3c+o0.5c/0.2c", box="+pblack+glightred"):
+with fig.inset(position="jBL+w3c+o0.5c/0.2c", box=Box(pen="black", fill="lightred")):
     pass
 fig.show()
 
@@ -97,7 +98,7 @@
 # parameters.
 with fig.inset(
     position="jBL+o0.5c/0.2c",
-    box="+pblack",
+    box=Box(pen="black"),
     region=[-80, -65, 35, 50],
     projection="M3c",
 ):

pygmt/src/inset.py

@@ -113,13 +113,14 @@ def inset(self, **kwargs):
     Examples
     --------
     >>> import pygmt
+    >>> from pygmt.params import Box
     >>>
     >>> # Create the larger figure
     >>> fig = pygmt.Figure()
     >>> fig.coast(region="MG+r2", water="lightblue", shorelines="thin")
     >>> # Use a "with" statement to initialize the inset context manager
     >>> # Setting the position to top left and a width of 3.5 centimeters
-    >>> with fig.inset(position="jTL+w3.5c+o0.2c", margin=0, box="+pgreen"):
+    >>> with fig.inset(position="jTL+w3.5c+o0.2c", margin=0, box=Box(pen="green")):
     ...     # Map elements under the "with" statement are plotted in the inset
     ...     fig.coast(
     ...         region="g",

pygmt/tests/test_image.py

@@ -4,6 +4,7 @@
 
 import pytest
 from pygmt import Figure
+from pygmt.params import Box
 
 
 @pytest.mark.mpl_image_compare
@@ -12,5 +13,5 @@ def test_image():
     Place images on map.
     """
     fig = Figure()
-    fig.image(imagefile="@circuit.png", position="x0/0+w2c", box="+pthin,blue")
+    fig.image(imagefile="@circuit.png", position="x0/0+w2c", box=Box(pen="thin,blue"))
     return fig

pygmt/tests/test_inset.py

@@ -4,6 +4,7 @@
 
 import pytest
 from pygmt import Figure
+from pygmt.params import Box
 
 
 @pytest.mark.benchmark
@@ -14,7 +15,7 @@ def test_inset_aliases():
     """
     fig = Figure()
     fig.basemap(region="MG+r2", frame="afg")
-    with fig.inset(position="jTL+w3.5c+o0.2c", margin=0, box="+pgreen"):
+    with fig.inset(position="jTL+w3.5c+o0.2c", margin=0, box=Box(pen="green")):
         fig.basemap(region="g", projection="G47/-20/4c", frame="afg")
     return fig
 
@@ -27,7 +28,7 @@ def test_inset_context_manager():
     """
     fig = Figure()
     fig.basemap(region=[-74, -69.5, 41, 43], projection="M9c", frame=True)
-    with fig.inset(position="jBL+w3c+o0.2c", margin=0, box="+pblack"):
+    with fig.inset(position="jBL+w3c+o0.2c", margin=0, box=Box(pen="black")):
         fig.basemap(region=[-80, -65, 35, 50], projection="M3c", frame="afg")
     fig.basemap(rose="jTR+w3c")  # Pass rose argument with basemap after the inset
     return fig