Skip to content
Snippets Groups Projects
Commit 978b8691 authored by Martin Lange's avatar Martin Lange
Browse files

Merge branch 'grid-docs' into 'main'

Clarify grid dimensions in constructors

See merge request !279
parents a67c7237 af5d5420
No related branches found
No related tags found
1 merge request!279Clarify grid dimensions in constructors
Pipeline #207913 passed with stages
in 7 minutes and 5 seconds
......@@ -58,7 +58,7 @@ class RectilinearGrid(StructuredGrid):
Parameters
----------
axes : list of np.ndarray
Axes defining the coordinates in each direction (xyz order).
Axes defining the point coordinates in each direction (xyz order).
data_location : Location, str, int, optional
Data location in the grid, by default Location.CELLS
order : str, optional
......@@ -196,6 +196,7 @@ class UniformGrid(RectilinearGrid):
dims : iterable
Dimensions of the uniform grid for each direction.
Spatial dimension will be determined by ``len(dims)``.
Dimensions refer to the number of points, independent of ``data_location``.
spacing : iterable, optional
Spacing of the uniform in each dimension. Defaults to
``(1.0, 1.0, 1.0)``. Must be positive.
......@@ -303,9 +304,9 @@ class EsriGrid(UniformGrid):
Parameters
----------
ncols : int
Number of columns.
Number of grid columns, in cells.
nrows : int
Number of rows.
Number of grid rows, in cells.
cellsize : float, optional
Cell size, by default 1.0
xllcorner : float, optional
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment