Merge branch 'main' into refactor/legend

Author: seisman

examples/gallery/images/grdlandmask.py

@@ -3,7 +3,7 @@
 ==========================
 
 The :func:`pygmt.grdlandmask` function allows setting all nodes on land
-or water to a specified value using the ``maskvalues`` parameter.
+or water to a specified value using the ``mask_values`` parameter.
 """
 
 # %%
@@ -18,7 +18,9 @@
 # masses.
 # Use shoreline data with (l)ow resolution and set the grid spacing to
 # 5 arc-minutes in x- and y-directions.
-grid = pygmt.grdlandmask(region=region, spacing="5m", maskvalues=[0, 1], resolution="l")
+grid = pygmt.grdlandmask(
+    region=region, spacing="5m", mask_values=[0, 1], resolution="l"
+)
 
 # Plot clipped grid
 fig.basemap(region=region, projection="M12c", frame=True)

examples/gallery/lines/wiggle.py

@@ -6,7 +6,7 @@
 tracks. ``x``, ``y``, ``z`` can be specified as 1-D arrays or within a
 specified file. The ``scale`` parameter can be used to set the scale of the
 anomaly in data/distance units. The positive and/or negative areas can be
-filled with color by setting the ``fillpositive`` and/or ``fillnegative``
+filled with color by setting the ``positive_fill`` and/or ``negative_fill``
 parameters.
 """
 
@@ -28,9 +28,9 @@
     # Set anomaly scale to 20 centimeters
     scale="20c",
     # Fill positive areas red
-    fillpositive="red",
+    positive_fill="red",
     # Fill negative areas gray
-    fillnegative="gray",
+    negative_fill="gray",
     # Set the outline width to 1.0 point
     pen="1.0p",
     # Draw a blue track with a width of 0.5 points

examples/gallery/seismology/meca.py

@@ -2,14 +2,13 @@
 Focal mechanisms
 ================
 
-The :meth:`pygmt.Figure.meca` method can plot focal mechanisms or beachballs.
-We can specify the focal mechanism nodal planes or moment tensor components
-as a dictionary using the ``spec`` parameter (or they can be specified as a
-1-D or 2-D array, or within a file). The size of the beachballs can be set
-using the ``scale`` parameter. The compressive and extensive quadrants can
-be filled either with a color or a pattern via the ``compressionfill`` and
-``extensionfill`` parameters, respectively. Use the ``pen`` parameter to
-adjust the outline of the beachballs.
+The :meth:`pygmt.Figure.meca` method can plot focal mechanisms or beachballs. We can
+specify the focal mechanism nodal planes or moment tensor components as a dictionary
+using the ``spec`` parameter (or they can be specified as a 1-D or 2-D array, or within
+a file). The size of the beachballs can be set using the ``scale`` parameter. The
+compressive and extensive quadrants can be filled either with a color or a pattern via
+the ``compression_fill`` and ``extension_fill`` parameters, respectively. Use the
+``pen`` parameter to adjust the outline of the beachballs.
 """
 
 # %%
@@ -41,10 +40,10 @@
     depth=12.0,
     # Fill compressive quadrants with color "red"
     # [Default is "black"]
-    compressionfill="red",
+    compression_fill="red",
     # Fill extensive quadrants with color "cornsilk"
     # [Default is "white"]
-    extensionfill="cornsilk",
+    extension_fill="cornsilk",
     # Draw a 0.5-point thick dark gray ("gray30") solid outline via
     # the pen parameter [Default is "0.25p,black,solid"]
     pen="0.5p,gray30,solid",

examples/gallery/seismology/velo_arrow_ellipse.py

@@ -33,7 +33,7 @@
     projection="x0.8c",
     frame=["WSne", "2g2f"],
     spec="e0.2/0.39+f18",
-    uncertaintyfill="lightblue1",
+    uncertainty_fill="lightblue1",
     pen="0.6p,red",
     line=True,
     vector="0.3c+p1p+e+gred",

examples/gallery/symbols/patterns.py

@@ -9,15 +9,15 @@
 
 - :meth:`pygmt.Figure.coast`: Land and water masses via ``land`` and ``water``
 - :meth:`pygmt.Figure.histogram`: Histogram bars via ``fill``
-- :meth:`pygmt.Figure.meca`: Focal mechanisms via ``compressionfill`` and
-  ``extensionfill``
+- :meth:`pygmt.Figure.meca`: Focal mechanisms via ``compression_fill`` and
+  ``extension_fill``
 - :meth:`pygmt.Figure.plot`: Symbols and polygons via ``fill``
 - :meth:`pygmt.Figure.rose`: Histogram sectors via ``fill``
 - :meth:`pygmt.Figure.solar`: Day-light terminators via ``fill``
 - :meth:`pygmt.Figure.ternary`: Symbols via ``fill``
 - :meth:`pygmt.Figure.velo`: Uncertainty wedges and velocity error ellipses via
-  ``uncertaintyfill``
-- :meth:`pygmt.Figure.wiggle`: Anomalies via ``fillpositive`` and ``fillnegative``
+  ``uncertainty_fill``
+- :meth:`pygmt.Figure.wiggle`: Anomalies via ``positive_fill`` and ``negative_fill``
 
 GMT provides 90 predefined 1-bit patterns, which are numbered from 1 to 90. In addition,
 custom 1-, 8-, or 24-bit image raster files can also be used as patterns.

examples/tutorials/advanced/draping_on_3d_surface.py

@@ -3,7 +3,7 @@
 ==================================================
 
 It can be visually appealing to "drape" a dataset over a topographic surface. This can
-be accomplished using the ``drapegrid`` parameter of :meth:`pygmt.Figure.grdview`.
+be accomplished using the ``drape_grid`` parameter of :meth:`pygmt.Figure.grdview`.
 
 This tutorial consists of two examples:
 
@@ -41,9 +41,9 @@
 # The topographic surface is created based on the grid passed to the ``grid`` parameter
 # of :meth:`pygmt.Figure.grdview`; here we use a grid of the Earth relief. To add a
 # color-coding based on *another* grid we have to pass a second grid to the
-# ``drapegrid`` parameter; here we use a grid of the crustal age. In this case the
+# ``drape_grid`` parameter; here we use a grid of the crustal age. In this case the
 # colormap specified via the ``cmap`` parameter applies to the grid passed to
-# ``drapegrid``, not to ``grid``. The azimuth and elevation of the 3-D plot are set via
+# ``drape_grid``, not to ``grid``. The azimuth and elevation of the 3-D plot are set via
 # the ``perspective`` parameter.
 
 fig = pygmt.Figure()
@@ -56,7 +56,7 @@
     projection="M12c",  # Mercator projection with a width of 12 centimeters
     region=region_3d,
     grid=grd_relief,  # Use elevation grid for z values
-    drapegrid=grd_age,  # Use crustal age grid for color-coding
+    drape_grid=grd_age,  # Use crustal age grid for color-coding
     cmap=True,  # Use colormap created for the crustal age
     surftype="i",  # Create an image plot
     # Use an illumination from the azimuthal directions 0° (north) and 270°
@@ -101,12 +101,12 @@
 url_to_image = "https://upload.wikimedia.org/wikipedia/commons/thumb/b/b7/Flag_of_Europe.svg/1000px-Flag_of_Europe.svg.png"
 with rasterio.open(url_to_image) as dataset:
     data = dataset.read()
-    drapegrid = xr.DataArray(data, dims=("band", "y", "x"))
+    drape_grid = xr.DataArray(data, dims=("band", "y", "x"))
 
 # %%
 # Again we create a 3-D plot with :meth:`pygmt.Figure.grdview` and pass an Earth relief
 # grid to the ``grid`` parameter to create the topographic surface. But now we pass the
-# PNG image which was loaded into an :class:`xarray.DataArray` to the ``drapgrid``
+# PNG image which was loaded into an :class:`xarray.DataArray` to the ``drape_grid``
 # parameter.
 
 fig = pygmt.Figure()
@@ -120,7 +120,7 @@
     projection="M12c",  # Mercator projection with a width of 12 centimeters
     region=region_3d,
     grid=grd_relief,  # Use elevation grid for z values
-    drapegrid=drapegrid,  # Drap image grid for the EU flag on top
+    drape_grid=drape_grid,  # Drape image grid for the EU flag on top
     cmap=True,  # Use colormap defined for the EU flag
     surftype="i",  # Create an image plot
     # Use an illumination from the azimuthal directions 0° (north) and 270° (west) with

examples/tutorials/advanced/focal_mechanisms.py

@@ -99,7 +99,7 @@
 # Filling the quadrants
 # ---------------------
 #
-# Use the parameters ``compressionfill`` and ``extensionfill`` to fill the quadrants
+# Use the parameters ``compression_fill`` and ``extension_fill`` to fill the quadrants
 # with different colors or :class:`patterns <pygmt.params.Pattern>`.
 fig = pygmt.Figure()
 fig.basemap(region=region, projection=projection, frame=frame)
@@ -110,8 +110,8 @@
     longitude=-2,
     latitude=0,
     depth=0,
-    compressionfill="darkorange",
-    extensionfill="cornsilk",
+    compression_fill="darkorange",
+    extension_fill="cornsilk",
 )
 
 fig.meca(
@@ -120,8 +120,8 @@
     longitude=2,
     latitude=0,
     depth=0,
-    compressionfill=Pattern(8),
-    extensionfill=Pattern(31),
+    compression_fill=Pattern(8),
+    extension_fill=Pattern(31),
     outline=True,
 )
 
@@ -168,8 +168,8 @@
 # both, ``"1"`` to the first, and ``"2"`` to the second nodal plane(s). Only the
 # circumference and the specified nodal plane(s) are plotted, i.e. the quadrants
 # remain unfilled (transparent). We can make use of the stacking concept of (Py)GMT,
-# and use ``nodal`` in combination with the ``outline``, ``compressionfill`` /
-# ``extensionfill`` and ``pen`` parameters.
+# and use ``nodal`` in combination with the ``outline``, ``compression_fill`` /
+# ``extension_fill`` and ``pen`` parameters.
 
 fig = pygmt.Figure()
 fig.basemap(region=region, projection=projection, frame=frame)
@@ -188,9 +188,9 @@
 # (ii) Plot the first nodal plane and the circumference in darkorange
 # (iii) Plot the circumference in black on top; use "-" to not fill the quadrants
 for kwargs in [
-    {"compressionfill": "lightorange"},
+    {"compression_fill": "lightorange"},
     {"nodal": "1/1p,darkorange"},
-    {"compressionfill": "-", "extensionfill": "-", "pen": "1p,gray30"},
+    {"compression_fill": "-", "extension_fill": "-", "pen": "1p,gray30"},
 ]:
     fig.meca(
         spec=aki_single,
@@ -238,7 +238,7 @@
     plot_longitude=1,
     plot_latitude=2,
     offset="+p1p,darkorange+s0.25c",
-    compressionfill="lightorange",
+    compression_fill="lightorange",
 )
 
 fig.show()
@@ -284,13 +284,13 @@
 # parameter. Additionally, the location of the label relative to the beachball [Default
 # is ``"TC"``, i.e., Top Center] can be changed by appending **+j** and an offset can
 # be applied by appending **+o** with values for *dx*\ /*dy*. Add a colored [Default is
-# white] box behind the label via the label ``labelbox``. Force a fixed size of the
+# white] box behind the label via the parameter ``label_box``. Force a fixed size of the
 # beachball by appending **+m** to the argument passed to the ``scale`` parameter.
 
 fig = pygmt.Figure()
 fig.coast(region="d", projection="N10c", land="lightgray", frame=True)
 
-fig.meca(spec=aki_multiple, scale="0.4c+m+f5p", labelbox="white@30", offset="+s0.1c")
+fig.meca(spec=aki_multiple, scale="0.4c+m+f5p", label_box="white@30", offset="+s0.1c")
 
 fig.show()
 
@@ -315,7 +315,7 @@
     spec=aki_multiple,
     scale="0.4c+f5p",
     offset="0.2p,gray30+s0.1c",
-    labelbox="white@30",
+    label_box="white@30",
     cmap=True,
     outline="0.2p,gray30",
 )