Skip to content

Commit

Permalink
Doc geopandas dependency in whatsnew, close #24.
Browse files Browse the repository at this point in the history
  • Loading branch information
juseg committed Oct 16, 2022
1 parent a3a189d commit 749d6ea
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 11 deletions.
2 changes: 2 additions & 0 deletions doc/conf.py
Expand Up @@ -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)
Expand All @@ -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',
Expand Down
32 changes: 21 additions & 11 deletions doc/whatsnew.rst
Expand Up @@ -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
Expand All @@ -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
~~~~~~~~~~~~~
Expand Down

0 comments on commit 749d6ea

Please sign in to comment.