Merge branch 'main' into refactor/colorbar

Author: seisman

doc/api/index.rst

@@ -214,6 +214,7 @@ Class-style Parameters
 
     Box
     Pattern
+    Position
 
 Enums
 -----

examples/gallery/embellishments/solar.py

@@ -32,7 +32,7 @@
         terminator_datetime=reference_time,
         # Set the fill for the night area to navy blue with 85 % transparency
         fill="navyblue@85",
-        pen="0.5p",  # Set the outline to be 0.5 points thick
+        pen="0.5p",  # Set the outline to be 0.5-point thick
     )
 
 fig.show()

examples/gallery/images/cross_section.py

@@ -46,7 +46,7 @@
     # 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, filled in white and a 30 % transparency, with a
-    # 0.8-points thick, black, outline.
+    # 0.8-point thick, black, outline.
     box=Box(pen="0.8p,black", fill="white@30"),
     # Add x- and y-labels ("+l")
     frame=["x+lElevation", "y+lm"],
@@ -103,7 +103,7 @@
     x=[0, 15],
     y=[0, 0],
     fill="lightblue",  # Fill the polygon in "lightblue"
-    pen="0.25p,black,solid",  # Draw a 0.25-points thick, black, solid outline
+    pen="0.25p,black,solid",  # Draw a 0.25-point thick, black, solid outline
     close="+y-8000",  # Force closed polygon
 )
 

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/maps/shorelines.py

@@ -11,6 +11,6 @@
 fig = pygmt.Figure()
 # Make a global Mollweide map with automatic ticks
 fig.basemap(region="g", projection="W15c", frame=True)
-# Display the shorelines as black lines with 0.5 point thickness
+# Display the shorelines as black lines with 0.5-point thickness
 fig.coast(shorelines="0.5p,black")
 fig.show()

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,11 +40,11 @@
     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",
-    # Draw a 0.5 points thick dark gray ("gray30") solid outline via
+    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/3d_perspective_image.py

@@ -55,8 +55,8 @@
 fig.show()
 
 # %%
-# The ``plane`` parameter sets the elevation and color of a plane that provides
-# a fill below the surface relief.
+# The ``plane`` parameter sets the elevation and color of a plane that provides a fill
+# below the surface relief.
 
 fig = pygmt.Figure()
 fig.grdview(
@@ -67,8 +67,8 @@
     zsize="1.5c",
     surftype="s",
     cmap="geo",
-    # Set the plane elevation to 1,000 meters and make the fill "gray"
-    plane="1000+ggray",
+    plane=1000,  # Set the plane elevation to 1,000 meters
+    facade_fill="gray",  # Color the facade in "gray"
 )
 fig.show()
 
@@ -90,8 +90,9 @@
     zsize="1.5c",
     surftype="s",
     cmap="geo",
-    plane="1000+ggrey",
-    # Set the contour pen thickness to "0.1p"
+    plane=1000,
+    facade_fill="gray",
+    # Set the contour pen thickness to 0.1 points
     contour_pen="0.1p",
 )
 fig.colorbar(perspective=True, frame=["a500", "x+lElevation", "y+lm"])