Skip to content

Commit acab8b2

Browse files
committed
Describe more on why one should choose the gmt engine
1 parent 143a375 commit acab8b2

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

pygmt/xarray/backend.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,11 @@ class GMTBackendEntrypoint(BackendEntrypoint):
1818
Xarray backend to read raster grid/image files using 'gmt' engine.
1919
2020
Internally, GMT uses the netCDF C library to read netCDF files, and GDAL for GeoTIFF
21-
and other raster formats. See also
22-
:gmt-docs:`reference/features.html#grid-file-format`.
21+
and other raster formats. See :gmt-docs:`reference/features.html#grid-file-format`
22+
for more details about supported formats. This GMT engine can also read
23+
:gmt-docs:`GMT remote datasets <datasets/remote-data.html>` (file names starting
24+
with an `@`) directly, and pre-loads :class:`pygmt.GMTDataArrayAccessor` properties
25+
(in the '.gmt' accessor) for easy access to GMT-specific metadata and features.
2326
2427
When using :py:func:`xarray.open_dataarray` or :py:func:`xarray.load_dataarray` with
2528
``engine="gmt"``, the ``raster_kind`` parameter is required and can be either:

0 commit comments

Comments
 (0)