Skip to content

Commit 41ff984

Browse files
seismanseisman
committed
Rename ncols to mincols
1 parent c5eb0e9 commit 41ff984

File tree

12 files changed

+29
-26
lines changed

12 files changed

+29
-26
lines changed

‎pygmt/clib/session.py‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1757,7 +1757,7 @@ def virtualfile_in( # noqa: PLR0912
17571757
x=None,
17581758
y=None,
17591759
z=None,
1760-
ncols=2,
1760+
mincols=2,
17611761
required_data=True,
17621762
required_z=False,
17631763
extra_arrays=None,
@@ -1780,7 +1780,7 @@ def virtualfile_in( # noqa: PLR0912
17801780
data input.
17811781
x/y/z : 1-D arrays or None
17821782
x, y, and z columns as numpy arrays.
1783-
ncols
1783+
mincols
17841784
Number of minimum required columns. Default is 2 (i.e. require x and y
17851785
columns).
17861786
required_data : bool
@@ -1791,7 +1791,8 @@ def virtualfile_in( # noqa: PLR0912
17911791
17921792
.. deprecated:: v0.16.0
17931793
The parameter 'required_z' will be removed in v0.20.0. Use parameter
1794-
'ncols' instead. E.g., ``required_z=True`` is equivalent to ``ncols=3``.
1794+
'mincols' instead. E.g., ``required_z=True`` is equivalent to
1795+
``mincols=3``.
17951796
extra_arrays : list of 1-D arrays
17961797
A list of numpy arrays in addition to x, y, and z. All of these arrays must
17971798
be of the same size as the x/y/z arrays.
@@ -1830,20 +1831,20 @@ def virtualfile_in( # noqa: PLR0912
18301831
if required_z is True:
18311832
warnings.warn(
18321833
"The parameter 'required_z' is deprecated in v0.16.0 and will be "
1833-
"removed in v0.20.0. Use parameter 'ncols' instead. E.g., "
1834-
"``required_z=True`` is equivalent to ``ncols=3``.",
1834+
"removed in v0.20.0. Use parameter 'mincols' instead. E.g., "
1835+
"``required_z=True`` is equivalent to ``mincols=3``.",
18351836
category=FutureWarning,
18361837
stacklevel=1,
18371838
)
1838-
ncols = 3
1839+
mincols = 3
18391840

18401841
kind = data_kind(data, required=required_data)
18411842
_validate_data_input(
18421843
data=data,
18431844
x=x,
18441845
y=y,
18451846
z=z,
1846-
ncols=ncols,
1847+
mincols=mincols,
18471848
required_data=required_data,
18481849
kind=kind,
18491850
)

‎pygmt/helpers/utils.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343

4444

4545
def _validate_data_input( # noqa: PLR0912
46-
data=None, x=None, y=None, z=None, ncols=2, required_data=True, kind=None
46+
data=None, x=None, y=None, z=None, mincols=2, required_data=True, kind=None
4747
) -> None:
4848
"""
4949
Check if the combination of data/x/y/z is valid.
@@ -66,29 +66,29 @@ def _validate_data_input( # noqa: PLR0912
6666
Traceback (most recent call last):
6767
...
6868
pygmt.exceptions.GMTInvalidInput: Must provide both x and y.
69-
>>> _validate_data_input(x=[1, 2, 3], y=[4, 5, 6], ncols=3)
69+
>>> _validate_data_input(x=[1, 2, 3], y=[4, 5, 6], mincols=3)
7070
Traceback (most recent call last):
7171
...
7272
pygmt.exceptions.GMTInvalidInput: Must provide x, y, and z.
7373
>>> import numpy as np
7474
>>> import pandas as pd
7575
>>> import xarray as xr
7676
>>> data = np.arange(8).reshape((4, 2))
77-
>>> _validate_data_input(data=data, ncols=3, kind="matrix")
77+
>>> _validate_data_input(data=data, mincols=3, kind="matrix")
7878
Traceback (most recent call last):
7979
...
8080
pygmt.exceptions.GMTInvalidInput: data must provide x, y, and z columns.
8181
>>> _validate_data_input(
8282
... data=pd.DataFrame(data, columns=["x", "y"]),
83-
... ncols=3,
83+
... mincols=3,
8484
... kind="vectors",
8585
... )
8686
Traceback (most recent call last):
8787
...
8888
pygmt.exceptions.GMTInvalidInput: data must provide x, y, and z columns.
8989
>>> _validate_data_input(
9090
... data=xr.Dataset(pd.DataFrame(data, columns=["x", "y"])),
91-
... ncols=3,
91+
... mincols=3,
9292
... kind="vectors",
9393
... )
9494
Traceback (most recent call last):
@@ -116,7 +116,7 @@ def _validate_data_input( # noqa: PLR0912
116116
GMTInvalidInput
117117
If the data input is not valid.
118118
"""
119-
required_z = ncols >= 3
119+
required_z = mincols >= 3
120120
if data is None: # data is None
121121
if x is None and y is None: # both x and y are None
122122
if required_data: # data is not optional

‎pygmt/src/blockm.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ def _blockm(
5656
with Session() as lib:
5757
with (
5858
lib.virtualfile_in(
59-
check_kind="vector", data=data, x=x, y=y, z=z, ncols=3
59+
check_kind="vector", data=data, x=x, y=y, z=z, mincols=3
6060
) as vintbl,
6161
lib.virtualfile_out(kind="dataset", fname=outfile) as vouttbl,
6262
):

‎pygmt/src/contour.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ def contour(
148148

149149
with Session() as lib:
150150
with lib.virtualfile_in(
151-
check_kind="vector", data=data, x=x, y=y, z=z, ncols=3
151+
check_kind="vector", data=data, x=x, y=y, z=z, mincols=3
152152
) as vintbl:
153153
lib.call_module(
154154
module="contour", args=build_arg_list(kwargs, infile=vintbl)

‎pygmt/src/nearneighbor.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ def nearneighbor(
147147
with Session() as lib:
148148
with (
149149
lib.virtualfile_in(
150-
check_kind="vector", data=data, x=x, y=y, z=z, ncols=3
150+
check_kind="vector", data=data, x=x, y=y, z=z, mincols=3
151151
) as vintbl,
152152
lib.virtualfile_out(kind="grid", fname=outgrid) as voutgrd,
153153
):

‎pygmt/src/plot3d.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -259,5 +259,5 @@ def plot3d( # noqa: PLR0912
259259
kwargs["S"] = "u0.2c"
260260

261261
with Session() as lib:
262-
with lib.virtualfile_in(check_kind="vector", data=data, ncols=3) as vintbl:
262+
with lib.virtualfile_in(check_kind="vector", data=data, mincols=3) as vintbl:
263263
lib.call_module(module="plot3d", args=build_arg_list(kwargs, infile=vintbl))

‎pygmt/src/project.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ def project(
246246
x=x,
247247
y=y,
248248
z=z,
249-
ncols=2,
249+
mincols=2,
250250
required_data=False,
251251
) as vintbl,
252252
lib.virtualfile_out(kind="dataset", fname=outfile) as vouttbl,

‎pygmt/src/surface.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ def surface(
161161
with Session() as lib:
162162
with (
163163
lib.virtualfile_in(
164-
check_kind="vector", data=data, x=x, y=y, z=z, ncols=3
164+
check_kind="vector", data=data, x=x, y=y, z=z, mincols=3
165165
) as vintbl,
166166
lib.virtualfile_out(kind="grid", fname=outgrid) as voutgrd,
167167
):

‎pygmt/src/triangulate.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ def regular_grid(
144144
with Session() as lib:
145145
with (
146146
lib.virtualfile_in(
147-
check_kind="vector", data=data, x=x, y=y, z=z, ncols=2
147+
check_kind="vector", data=data, x=x, y=y, z=z, mincols=2
148148
) as vintbl,
149149
lib.virtualfile_out(kind="grid", fname=outgrid) as voutgrd,
150150
):
@@ -244,7 +244,7 @@ def delaunay_triples(
244244
with Session() as lib:
245245
with (
246246
lib.virtualfile_in(
247-
check_kind="vector", data=data, x=x, y=y, z=z, ncols=2
247+
check_kind="vector", data=data, x=x, y=y, z=z, mincols=2
248248
) as vintbl,
249249
lib.virtualfile_out(kind="dataset", fname=outfile) as vouttbl,
250250
):

‎pygmt/src/wiggle.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,6 @@ def wiggle(
109109

110110
with Session() as lib:
111111
with lib.virtualfile_in(
112-
check_kind="vector", data=data, x=x, y=y, z=z, ncols=3
112+
check_kind="vector", data=data, x=x, y=y, z=z, mincols=3
113113
) as vintbl:
114114
lib.call_module(module="wiggle", args=build_arg_list(kwargs, infile=vintbl))

0 commit comments

Comments
 (0)