Merge branch 'main' into remove-grdinfo/grdproject

Author: Meghan Jones

CODE_OF_CONDUCT.md

@@ -6,8 +6,8 @@ We as members, contributors, and leaders pledge to make participation in our
 community a harassment-free experience for everyone, regardless of age, body
 size, visible or invisible disability, ethnicity, sex characteristics, gender
 identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, religion, or sexual identity
-and orientation.
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
 
 We pledge to act and interact in ways that contribute to an open, welcoming,
 diverse, inclusive, and healthy community.
@@ -22,17 +22,17 @@ community include:
 * Giving and gracefully accepting constructive feedback
 * Accepting responsibility and apologizing to those affected by our mistakes,
   and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
-  overall community
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
 * Trolling, insulting or derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
 * Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
@@ -61,7 +61,7 @@ representative at an online or offline event.
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement
 by contacting [Leonardo Uieda](http://www.leouieda.com) (preferred) or
-[Paul Wessel](http://www.soest.hawaii.edu/wessel).
+[Meghan Jones](https://www.soest.hawaii.edu/soestwp/about/directory/meghan-jones/).
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the
@@ -83,15 +83,15 @@ behavior was inappropriate. A public apology may be requested.
 
 ### 2. Warning
 
-**Community Impact**: A violation through a single incident or series
-of actions.
+**Community Impact**: A violation through a single incident or series of
+actions.
 
 **Consequence**: A warning with consequences for continued behavior. No
 interaction with the people involved, including unsolicited interaction with
 those enforcing the Code of Conduct, for a specified period of time. This
 includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or
-permanent ban.
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
 
 ### 3. Temporary Ban
 
@@ -107,23 +107,28 @@ Violating these terms may lead to a permanent ban.
 ### 4. Permanent Ban
 
 **Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
+standards, including sustained inappropriate behavior, harassment of an
 individual, or aggression toward or disparagement of classes of individuals.
 
-**Consequence**: A permanent ban from any sort of public interaction within
-the community.
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
 
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
 
-Community Impact Guidelines were inspired by [Mozilla's code of conduct
-enforcement ladder](https://github.com/mozilla/diversity).
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
 
 [homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
 
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.

README.rst

@@ -31,7 +31,7 @@ PyGMT
 .. image:: https://zenodo.org/badge/DOI/10.5281/3781524.svg
     :alt: Digital Object Identifier for the Zenodo archive
     :target: https://doi.org/10.5281/zenodo.3781524
-.. image:: https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg
+.. image:: https://img.shields.io/badge/Contributor%20Covenant-v2.1%20adopted-ff69b4.svg
     :alt: Contributor Code of Conduct
     :target: CODE_OF_CONDUCT.md
 
@@ -73,8 +73,9 @@ Project goals
 * Interface with the GMT C API directly using ctypes (no system calls).
 * Support for rich display in the Jupyter notebook.
 * Integration with the `PyData <https://pydata.org/>`__ ecosystem:
-  ``numpy.ndarray`` or ``pandas.DataFrame`` for data tables and
-  ``xarray.DataArray`` for grids.
+  ``numpy.ndarray`` or ``pandas.DataFrame`` for data tables,
+  ``xarray.DataArray`` for grids and ``geopandas.GeoDataFrame``
+  for geographical data.
 
 
 Quickstart

examples/gallery/histograms/blockm.py

@@ -10,7 +10,7 @@
 import pygmt
 
 # Load sample data
-data = pygmt.datasets.load_japan_quakes()
+data = pygmt.datasets.load_sample_data(name="japan_quakes")
 # Select only needed columns
 data = data[["longitude", "latitude", "depth_km"]]
 

examples/gallery/histograms/rose.py

@@ -10,7 +10,7 @@
 
 # Load sample compilation of fracture lengths and azimuth as
 # hypothetically digitized from geological maps
-data = pygmt.datasets.load_fractures_compilation()
+data = pygmt.datasets.load_sample_data(name="fractures")
 
 fig = pygmt.Figure()
 

examples/gallery/images/track_sampling.py

@@ -18,7 +18,7 @@
 
 # Load sample grid and point datasets
 grid = pygmt.datasets.load_earth_relief()
-points = pygmt.datasets.load_ocean_ridge_points()
+points = pygmt.datasets.load_sample_data(name="ocean_ridge_points")
 # Sample the bathymetry along the world's ocean ridges at specified track
 # points
 track = pygmt.grdtrack(points=points, grid=grid, newcolname="bathymetry")

examples/tutorials/basics/plot.py

@@ -14,10 +14,10 @@
 
 ###############################################################################
 # For example, let's load the sample dataset of tsunami generating earthquakes
-# around Japan (:func:`pygmt.datasets.load_japan_quakes`). The data is loaded
-# as a :class:`pandas.DataFrame`.
+# around Japan (:func:`pygmt.datasets.load_sample_data(name="japan_quakes")`).
+# The data is loaded as a :class:`pandas.DataFrame`.
 
-data = pygmt.datasets.load_japan_quakes()
+data = pygmt.datasets.load_sample_data(name="japan_quakes")
 
 # Set the region for the plot to be slightly larger than the data bounds.
 region = [

pygmt/src/blockm.py

@@ -147,6 +147,18 @@ def blockmean(data=None, x=None, y=None, z=None, outfile=None, **kwargs):
           is not set.
         - None if ``outfile`` is set (filtered output will be stored in file
           set by ``outfile``).
+
+    Example
+    -------
+    >>> import pygmt  # doctest: +SKIP
+    >>> # Load a table of ship observations of bathymetry off Baja California
+    >>> data = pygmt.datasets.load_sample_data(
+    ...     name="bathymetry"
+    ... )  # doctest: +SKIP
+    >>> # Calculate block mean values within 5 by 5 minute bins
+    >>> data_bmean = pygmt.blockmean(
+    ...     data=data, region=[245, 255, 20, 30], spacing="5m"
+    ... )  # doctest: +SKIP
     """
     return _blockm(
         block_method="blockmean", data=data, x=x, y=y, z=z, outfile=outfile, **kwargs
@@ -225,6 +237,18 @@ def blockmedian(data=None, x=None, y=None, z=None, outfile=None, **kwargs):
           is not set.
         - None if ``outfile`` is set (filtered output will be stored in file
           set by ``outfile``).
+
+    Example
+    -------
+    >>> import pygmt  # doctest: +SKIP
+    >>> # Load a table of ship observations of bathymetry off Baja California
+    >>> data = pygmt.datasets.load_sample_data(
+    ...     name="bathymetry"
+    ... )  # doctest: +SKIP
+    >>> # Calculate block median values within 5 by 5 minute bins
+    >>> data_bmedian = pygmt.blockmedian(
+    ...     data=data, region=[245, 255, 20, 30], spacing="5m"
+    ... )  # doctest: +SKIP
     """
     return _blockm(
         block_method="blockmedian", data=data, x=x, y=y, z=z, outfile=outfile, **kwargs
@@ -303,6 +327,18 @@ def blockmode(data=None, x=None, y=None, z=None, outfile=None, **kwargs):
           is not set.
         - None if ``outfile`` is set (filtered output will be stored in file
           set by ``outfile``).
+
+    Example
+    -------
+    >>> import pygmt  # doctest: +SKIP
+    >>> # Load a table of ship observations of bathymetry off Baja California
+    >>> data = pygmt.datasets.load_sample_data(
+    ...     name="bathymetry"
+    ... )  # doctest: +SKIP
+    >>> # Calculate block mode values within 5 by 5 minute bins
+    >>> data_bmode = pygmt.blockmode(
+    ...     data=data, region=[245, 255, 20, 30], spacing="5m"
+    ... )  # doctest: +SKIP
     """
     return _blockm(
         block_method="blockmode", data=data, x=x, y=y, z=z, outfile=outfile, **kwargs

pygmt/src/grdgradient.py

@@ -148,6 +148,21 @@ def grdgradient(grid, **kwargs):
         - :class:`xarray.DataArray` if ``outgrid`` is not set
         - None if ``outgrid`` is set (grid output will be stored in file set by
           ``outgrid``)
+
+
+    Example
+    -------
+    >>> import pygmt  # doctest: +SKIP
+    >>> # Load a grid of @earth_relief_30m data, with an x-range of 10 to 30,
+    >>> # and a y-range of 15 to 25
+    >>> grid = pygmt.datasets.load_earth_relief(
+    ...     resolution="30m", region=[10, 30, 15, 25]
+    ... )  # doctest: +SKIP
+    >>> # Create a new grid from an input grid, set the azimuth to 10 degrees,
+    >>> # and the direction to "c" for Cartesian coordinates
+    >>> new_grid = pygmt.grdgradient(
+    ...     grid=grid, azimuth=10, direction="c"
+    ... )  # doctest: +SKIP
     """
     with GMTTempFile(suffix=".nc") as tmpfile:
         if "Q" in kwargs and "N" not in kwargs:

pygmt/src/grdlandmask.py

@@ -92,6 +92,15 @@ def grdlandmask(**kwargs):
         - :class:`xarray.DataArray` if ``outgrid`` is not set
         - None if ``outgrid`` is set (grid output will be stored in file set by
           ``outgrid``)
+
+    Example
+    -------
+    >>> import pygmt  # doctest: +SKIP
+    >>> # Create a landmask grid with an x-range of 125 to 130,
+    >>> # and a y-range of 30 to 35
+    >>> landmask = pygmt.grdlandmask(
+    ...     spacing=1, region=[125, 130, 30, 35]
+    ... )  # doctest: +SKIP
     """
     if "I" not in kwargs or "R" not in kwargs:
         raise GMTInvalidInput("Both 'region' and 'spacing' must be specified.")

pygmt/src/grdproject.py

@@ -95,6 +95,21 @@ def grdproject(grid, **kwargs):
         - :class:`xarray.DataArray` if ``outgrid`` is not set
         - None if ``outgrid`` is set (grid output will be stored in file set by
           ``outgrid``)
+
+    Example
+    -------
+    >>> import pygmt  # doctest: +SKIP
+    >>> # Load a grid of @earth_relief_30m data, with an x-range of 10 to 30,
+    >>> # and a y-range of 15 to 25
+    >>> grid = pygmt.datasets.load_earth_relief(
+    ...     resolution="30m", region=[10, 30, 15, 25]
+    ... )  # doctest: +SKIP
+    >>> # Create a new grid from the input grid, set the projection to
+    >>> # Mercator, and set inverse to "True" to change from "geographic"
+    >>> # to "rectangular"
+    >>> new_grid = pygmt.grdproject(
+    ...     grid=grid, projection="M10c", inverse=True
+    ... )  # doctest: +SKIP
     """
     if "J" not in kwargs:
         raise GMTInvalidInput("The projection must be specified.")