From 749d6ea4539c511d53443883308d7aa7ff146d95 Mon Sep 17 00:00:00 2001 From: Julien Seguinot Date: Sun, 16 Oct 2022 16:59:56 +0200 Subject: [PATCH] Doc geopandas dependency in whatsnew, close #24. --- doc/conf.py | 2 ++ doc/whatsnew.rst | 32 +++++++++++++++++++++----------- 2 files changed, 23 insertions(+), 11 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 35d632a..f1de120 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -55,6 +55,7 @@ # configure sphinx.ext.intersphinx intersphinx_mapping = { + 'geopandas': ('https://geopandas.org/en/stable/', None), 'matplotlib': ('https://matplotlib.org/stable/', None), 'python': ('https://docs.python.org/3.7/', None), 'xarray': ('http://xarray.pydata.org/en/stable/', None) @@ -76,6 +77,7 @@ 'AxesImage': '~matplotlib.image.AxesImage', 'CRS': '~cartopy.crs.CRS', 'GeoAxes': '~cartopy.mpl.geoaxes.GeoAxes', + 'GeoDataFrame': '~geopandas.GeoDataFrame', 'QuadContourSet': '~matplotlib.contour.QuadContourSet', 'StreamplotSet': '~matplotlib.streamplot.StreamplotSet', 'DataArray': '~xarray.DataArray', diff --git a/doc/whatsnew.rst b/doc/whatsnew.rst index 3977f86..faadac6 100644 --- a/doc/whatsnew.rst +++ b/doc/whatsnew.rst @@ -18,9 +18,24 @@ What's new v0.2 (unreleased) ----------------- +Breaking changes +~~~~~~~~~~~~~~~~ + +- Add new required dependencies on cartopy_ and geopandas_. Cartopy is only + used to download `Natural Earth`_ data, and may no longer be required in + future versions (:issue:`25`). + +.. _cartopy: https://scitools.org.uk/cartopy/ +.. _geopandas: https://geopandas.org +.. _Natural Earth: https://www.naturalearthdata.com/ + New features ~~~~~~~~~~~~ +.. FIXME: following geopandas move things will change: + - Move hyoga.plot.COLORMAPS to hyoga.COLORMAPS? + - Privatise hyoga.plot.hillshade + - Add three altitude (``Topographic``, ``Bathymetric``, ``Elevational``) and two relief-shading (``Glossy``, ``Matte``) colormaps, and correponding color lists, accessible through the matplotlib colormap register, and listed in @@ -32,17 +47,12 @@ New features - Add plot method :meth:`xarray.Dataset.hyoga.plot.bedrock_altitude_contours` for bedrock altitude filled contours, best used in combination with new altitude colormaps. -- Add plot functions :func:`hyoga.plot.feature`, :func:`hyoga.plot.cities`, - :func:`hyoga.plot.countries`, :func:`hyoga.plot.country_borders`, - :func:`hyoga.plot.states`, :func:`hyoga.plot.state_borders`, - :func:`hyoga.plot.coastline`, :func:`hyoga.plot.glaciers`, - :func:`hyoga.plot.graticules`, :func:`hyoga.plot.lakes`, - :func:`hyoga.plot.ocean`, and :func:`hyoga.plot.rivers` for `Natural Earth`_ - data through cartopy_. - - -.. _cartopy: https://scitools.org.uk/cartopy/ -.. _Natural Earth: https://www.naturalearthdata.com/ +- Add plot method :meth:`xarray.Dataset.hyoga.plot.naturalearth` to add global + `Natural Earth`_ data through geopandas_ (:issue:`17`). +- Add functions :func:`hyoga.open.naturalearth` and + :func:`hyoga.open.paleoglaciers` to open global `Natural Earth`_ data and + Last Glacial Maximum paleoglacier extents as :class:`geopandas.GeoDataFrame` + (:issue:`24`). Documentation ~~~~~~~~~~~~~