diff --git a/.zenodo.json b/.zenodo.json index 31ee705..3746d93 100644 --- a/.zenodo.json +++ b/.zenodo.json @@ -1,5 +1,5 @@ { - "title": "Hyoga: a Python library to visualize ice-sheet model datasets", + "title": "Hyoga: paleoglacier modelling framework", "license": "GPL-3.0", "creators": [ { diff --git a/README.rst b/README.rst index 582e451..fb07362 100644 --- a/README.rst +++ b/README.rst @@ -1,4 +1,4 @@ -.. Copyright (c) 2019-2022, Julien Seguinot (juseg.github.io) +.. Copyright (c) 2019-2023, Julien Seguinot (juseg.github.io) .. GNU General Public License v3.0+ (https://www.gnu.org/licenses/gpl-3.0.txt) Hyoga @@ -15,7 +15,7 @@ Hyoga .. image:: https://zenodo.org/badge/227465038.svg :target: https://zenodo.org/badge/latestdoi/227465038 -Hyoga_ is a small Python_ library to visualize ice-sheet model datasets. +Hyoga_ is a Python_ library to prepare and visualize ice-sheet model datasets. It acts as a thin wrapper around GeoPandas_ and xarray_ for CF_-compliant datasets on regular grids used for instance in PISM_. Hyoga (氷河) is the Japanese word for glacier (lit. ice river). See the documentation_ for more. diff --git a/doc/conf.py b/doc/conf.py index e7ef0d9..94feb99 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -1,4 +1,4 @@ -# Copyright (c) 2021, Julien Seguinot (juseg.github.io) +# Copyright (c) 2021-2023, Julien Seguinot (juseg.github.io) # GNU General Public License v3.0+ (https://www.gnu.org/licenses/gpl-3.0.txt) """Sphinx configuration file for hyoga documentation.""" @@ -11,10 +11,10 @@ # -- Project information ----------------------------------------------------- project = 'hyoga' -copyright = '2021-2022' +copyright = '2021-2023' author = 'Julien Seguinot' -version = '0.2 Bale' -release = '0.2.2' +version = '0.3 Cocuy' +release = '0.3.0' # -- General configuration --------------------------------------------------- diff --git a/doc/index.rst b/doc/index.rst index 2e61fb4..2bf8476 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,10 +1,10 @@ -.. Copyright (c) 2021-2022, Julien Seguinot (juseg.github.io) +.. Copyright (c) 2021-2023, Julien Seguinot (juseg.github.io) .. GNU General Public License v3.0+ (https://www.gnu.org/licenses/gpl-3.0.txt) Hyoga ===== -Hyoga is a small Python_ library to visualize ice-sheet model datasets. +Hyoga is a Python_ library to prepare and visualize ice-sheet model datasets. It acts as a thin wrapper around GeoPandas_ and xarray_ for CF_-compliant datasets on regular grids used for instance in PISM_. Hyoga (氷河) is the Japanese word for glacier (lit. ice river). diff --git a/doc/whatsnew.rst b/doc/whatsnew.rst index cafb463..d702564 100644 --- a/doc/whatsnew.rst +++ b/doc/whatsnew.rst @@ -1,4 +1,4 @@ -.. Copyright (c) 2021-2022, Julien Seguinot (juseg.github.io) +.. Copyright (c) 2021-2023, Julien Seguinot (juseg.github.io) .. GNU General Public License v3.0+ (https://www.gnu.org/licenses/gpl-3.0.txt) .. currentmodule:: hyoga @@ -23,8 +23,19 @@ What's new .. _v0.3.0: -v0.3.0 (unreleased) -------------------- +v0.3.0 Cocuy (16 Jan. 2023) +--------------------------- + +.. plot:: ../examples/whatsnew/plot_v003_cocuy.py + :include-source: false + +This release turns hyoga into more than just a visualization tool. Two +functions were added to :doc:`open ` online elevation data +(GEBCO_) and monthly climatologies (CHELSA_) in custom projections that can be +used as PISM_ input files for paleoglacier modelling about anywhere on Earth. +Minor bugs were fixed. Code coverage decreased to 67 percent. + +.. _PISM: https://pism.io Breaking changes ~~~~~~~~~~~~~~~~ @@ -42,11 +53,14 @@ New features ~~~~~~~~~~~~ - Add :func:`hyoga.open.bootstrap` to open global elevation data from either - GEBCO or CHELSA as bootstrapping data for PISM (:issue:`1`, :pull:`51`, - :issue:`54`, :pull:`55`, :issue:`57`, :pull:`60`, :pull:`62`, :pull:`64`). -- Add :func:`hyoga.open.atmosphere` to open monthly climatologies from CHELSA + GEBCO_ or CHELSA_ as bootstrapping data for PISM (:issue:`1`, :pull:`51`, + :issue:`54`, :pull:`55`, :issue:`57`, :pull:`60`, :pull:`62`). +- Add :func:`hyoga.open.atmosphere` to open monthly climatologies from CHELSA_ as atmospheric data for PISM (:issue:`3`, :pull:`56`). +.. _CHELSA: https://chelsa-climate.org +.. _GEBCO: https://www.gebco.net + Bug fixes ~~~~~~~~~ diff --git a/examples/whatsnew/plot_v002_bale.py b/examples/whatsnew/plot_v002_bale.py index c3a46ee..9684782 100755 --- a/examples/whatsnew/plot_v002_bale.py +++ b/examples/whatsnew/plot_v002_bale.py @@ -1,5 +1,5 @@ #!/usr/bin/env python -# Copyright (c) 2022, Julien Seguinot (juseg.github.io) +# Copyright (c) 2022-2023, Julien Seguinot (juseg.github.io) # GNU General Public License v3.0+ (https://www.gnu.org/licenses/gpl-3.0.txt) """ @@ -13,9 +13,9 @@ # plot paleoglaciers ax = hyoga.open.paleoglaciers().to_crs(epsg=3857).plot( - alpha=0.75, facecolor='w', edgecolor='r', linewidth=2) + alpha=0.75, facecolor='w', edgecolor='w', linewidth=2) -# zoom on Bale Mountains (120x60 km) +# zoom on Bale Mountains (80x60 km) ax.set_xlim(4390e3, 4470e3) ax.set_ylim(730e3, 790e3) diff --git a/examples/whatsnew/plot_v003_cocuy.py b/examples/whatsnew/plot_v003_cocuy.py new file mode 100755 index 0000000..d13a5a3 --- /dev/null +++ b/examples/whatsnew/plot_v003_cocuy.py @@ -0,0 +1,31 @@ +#!/usr/bin/env python +# Copyright (c) 2023, Julien Seguinot (juseg.github.io) +# GNU General Public License v3.0+ (https://www.gnu.org/licenses/gpl-3.0.txt) + +""" +v0.3.0 Cantal +============= +""" + +import matplotlib.pyplot as plt +import contextily as cx +import hyoga + +# plot paleoglaciers +ax = hyoga.open.paleoglaciers().to_crs(epsg=3857).plot( + alpha=0.75, facecolor='w', edgecolor='w', linewidth=2) + +# zoom on Cocuy (240x180 km) +ax.set_xlim(-8200e3, -7960e3) +ax.set_ylim(580e3, 760e3) + +# add stamen terrain +cx.add_basemap(ax, source=cx.providers.Stamen.TerrainBackground) + +# set axes properties +ax.set_title('Cocuy') +ax.xaxis.set_visible(False) +ax.yaxis.set_visible(False) + +# show +plt.show() diff --git a/setup.cfg b/setup.cfg index a83fb3e..c749e33 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,4 +1,4 @@ -# Copyright (c) 2019-2021, Julien Seguinot (juseg.github.io) +# Copyright (c) 2019-2023, Julien Seguinot (juseg.github.io) # GNU General Public License v3.0+ (https://www.gnu.org/licenses/gpl-3.0.txt) # Build config for hyoga @@ -6,14 +6,14 @@ [metadata] name = hyoga -version = 0.2.2 +version = 0.3.0 author = Julien Seguinot -description = A Python library to visualize ice-sheet model datasets +description = Paleoglacier modelling framework long_description = file: README.rst long_description_content_type = text/x-rst url = https://github.com/juseg/hyoga classifiers = - Development Status :: 2 - Pre-Alpha + Development Status :: 3 - Alpha Intended Audience :: Science/Research License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+) Programming Language :: Python :: 3