Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ widely used across the Earth, Ocean, and Planetary sciences and beyond.
- Build a Pythonic API for GMT.
- Interface with the GMT C API directly using ctypes (no system calls).
- Support for rich display in the Jupyter notebook.
- Integration with the [PyData ecosystem](https://pydata.org/): `numpy.ndarray` or `pandas.DataFrame` for
data tables, `xarray.DataArray` for grids, and `geopandas.GeoDataFrame` for geographical data.
- Integration with the [scientific Python ecosystem](https://scientific-python.org/): `numpy.ndarray` or
`pandas.DataFrame` for data tables, `xarray.DataArray` for grids, and `geopandas.GeoDataFrame` for geographical data.

## Quickstart

Expand Down
8 changes: 4 additions & 4 deletions examples/tutorials/advanced/date_time_charts.py
Original file line number Diff line number Diff line change
Expand Up @@ -191,10 +191,10 @@
#
# In this example, instead of using a list of :class:`pandas.DatetimeIndex` objects,
# ``x`` is initialized as an :class:`xarray.DataArray` object. This object provides a
# wrapper around regular PyData formats. It also allows the data to have labeled
# dimensions while supporting operations that use various pieces of metadata. The
# following code uses :func:`pandas.date_range` to fill the DataArray with data, but
# this is not essential for the creation of a valid DataArray.
# wrapper around regular scientific Python formats. It also allows the data to have
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This object provides a wrapper around regular scientific Python formats.

I'm unsure what "scientific Python formats" means. The official documentation (https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html) says:

DataArray provides a wrapper around numpy ndarrays that uses labeled dimensions and coordinates to support metadata aware operations.

Copy link
Member Author

@yvonnefroehlich yvonnefroehlich Sep 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point! Actually I was already a bit confused by "regular PyData formats". So, I just replaced the term. Maybe we should rewrite this sentence to something similar as in the official xarray docs, please see commit 2773524.

# labeled dimensions while supporting operations that use various pieces of metadata.
# The following code uses :func:`pandas.date_range` to fill the DataArray with data,
# but this is not essential for the creation of a valid DataArray.

x = xr.DataArray(data=pd.date_range(start="2020-01-01", periods=4, freq="Q"))
y = [4, 7, 5, 6]
Expand Down
4 changes: 2 additions & 2 deletions pygmt/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
publication-quality maps and figures. It provides a Pythonic interface for the Generic
Mapping Tools (GMT), a command-line program widely used across the Earth, Ocean, and
Planetary sciences and beyond. Besides making GMT more accessible to new users, PyGMT
aims to provide integration with the PyData ecosystem as well as support for rich
display in Jupyter notebooks.
aims to provide integration with the scientific Python ecosystem as well as support for
rich display in Jupyter notebooks.

Main Features
-------------
Expand Down