Rename alias to spec (S) and update baseline images for GMT 6.2.0rc1

Co-Authored-By: Meghan Jones <[email protected]>

Author: weiji14

examples/gallery/symbols/velo_arrow_ellipse.py

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

pygmt/src/velo.py

@@ -22,7 +22,7 @@
     L="line",
     N="no_clip",
     R="region",
-    S="scaling",
+    S="spec",
     U="timestamp",
     V="verbose",
     W="pen",
@@ -45,7 +45,7 @@ def velo(self, data=None, **kwargs):
     crosses. Symbol fills or their outlines may be colored based on constant
     parameters or via color lookup tables.
 
-    Must provide ``data`` and ``scaling``.
+    Must provide ``data`` and ``spec``.
 
     Full option list at :gmt-docs:`supplements/geodesy/velo.html`
 
@@ -58,7 +58,7 @@ def velo(self, data=None, **kwargs):
         :class:`pandas.DataFrame` with the tabular data. Note that text columns
         are only supported with file or pandas DataFrame inputs.
 
-    scaling: str
+    spec: str
         Selects the meaning of the columns in the data file and the figure
         to be plotted. In all cases, the scales are in data units per length
         unit and sizes are in length units (default length unit is controlled
@@ -160,13 +160,13 @@ def velo(self, data=None, **kwargs):
     {B}
     {CPT}
     rescale : str
-        can be used to rescale the uncertainties of velocities
-        (``scaling='e'`` and ``scaling='r'``) and rotations
-        (``scaling='w'``). Can be combined with the ``confidence`` variable.
+        can be used to rescale the uncertainties of velocities (``spec='e'``
+        and ``spec='r'``) and rotations (``spec='w'``). Can be combined with
+        the ``confidence`` variable.
     uncertainty_color : str
         Sets the color or shade used for filling uncertainty wedges
-        (``scaling='w'``) or velocity error ellipses (``scaling='e'`` or
-        ``scaling='r'``). If ``uncertainty_color`` is not specified, the
+        (``spec='w'``) or velocity error ellipses (``spec='e'`` or
+        ``spec='r'``). If ``uncertainty_color`` is not specified, the
         uncertainty regions will be transparent. **Note**: Using ``cmap`` and
         ``zvalue='+e'`` will update the uncertainty fill color based on the
         selected measure in ``zvalue`` [magnitude error]. More details at
@@ -182,7 +182,7 @@ def velo(self, data=None, **kwargs):
         Scale symbol sizes and pen widths on a per-record basis using the
         *scale* read from the data set, given as the first column after the
         (optional) *z* and *size* columns [Default is no scaling]. The symbol
-        size is either provided by ``scaling`` or via the input *size* column.
+        size is either provided by ``spec`` or via the input *size* column.
         Alternatively, append a constant *scale* that should be used instead of
         reading a scale column.
     shading : float or bool
@@ -191,7 +191,7 @@ def velo(self, data=None, **kwargs):
         modulate the symbol fill color by simulating illumination [Default is
         none]. If *intens* is not provided we will instead read the intensity
         from an extra data column after the required input columns determined
-        by ``scaling``.
+        by ``spec``.
     line: str
         [*pen*\ [**+c**\ [**f**\|\ **l**]]].
         Draw lines. Ellipses and rotational wedges will have their outlines
@@ -231,7 +231,7 @@ def velo(self, data=None, **kwargs):
     kwargs = self._preprocess(**kwargs)  # pylint: disable=protected-access
 
     if "S" not in kwargs or ("S" in kwargs and not isinstance(kwargs["S"], str)):
-        raise GMTInvalidInput("Scaling is a required argument and has to be a string.")
+        raise GMTInvalidInput("Spec is a required argument and has to be a string.")
 
     if isinstance(data, np.ndarray) and not pd.api.types.is_numeric_dtype(data):
         raise GMTInvalidInput(

pygmt/tests/baseline/test_velo_numpy_array_numeric_only.png.dvc

@@ -1,4 +1,4 @@
 outs:
-- md5: 0d50fb17d52af222b890d44fbd9050c4
-  size: 48104
+- md5: 64e45d586112fc131090cfac2c104b63
+  size: 45483
   path: test_velo_numpy_array_numeric_only.png

pygmt/tests/baseline/test_velo_pandas_dataframe.png.dvc

@@ -1,4 +1,4 @@
 outs:
-- md5: fc51d80c438a1961f700c68e207ecc3b
-  size: 44161
+- md5: 60dff1a72e6d984f095fb4973cecaec7
+  size: 42430
   path: test_velo_pandas_dataframe.png

pygmt/tests/test_velo.py

@@ -34,7 +34,7 @@ def test_velo_numpy_array_numeric_only(dataframe):
     fig = Figure()
     fig.velo(
         data=dataframe.iloc[:, :-1].to_numpy(),
-        scaling="e0.2/0.39/18",
+        spec="e0.2/0.39/18",
         vector="0.3c+p1p+e+gred",
         frame="1g1",
     )
@@ -49,14 +49,14 @@ def test_velo_numpy_array_text_column(dataframe):
     with pytest.raises(GMTInvalidInput):
         fig.velo(
             data=dataframe.to_numpy(),
-            scaling="e0.2/0.39/18",
+            spec="e0.2/0.39/18",
             vector="0.3c+p1p+e+gred",
         )
 
 
-def test_velo_without_scaling(dataframe):
+def test_velo_without_spec(dataframe):
     """
-    Check that velo fails when the scaling parameter is not given.
+    Check that velo fails when the spec parameter is not given.
     """
     fig = Figure()
     with pytest.raises(GMTInvalidInput):
@@ -71,7 +71,7 @@ def test_velo_pandas_dataframe(dataframe):
     fig = Figure()
     fig.velo(
         data=dataframe,
-        scaling="e0.2/0.39/18",
+        spec="e0.2/0.39/18",
         vector="0.3c+p1p+e+gred",
         frame=["WSne", "2g2f"],
         region=[-10, 8, -10, 6],