.. Copyright (c) 2021-2024, Julien Seguinot (juseg.dev)
.. GNU General Public License v3.0+ (https://www.gnu.org/licenses/gpl-3.0.txt)

Hyoga
=====

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).

.. _GeoPandas: https://geopandas.org
.. _CF: https://cfconventions.org
.. _PISM: https://pism.io
.. _Python: https://python.org
.. _xarray: https://xarray.pydata.org/en/stable/

.. raw:: html

   <figure>
     <div style="padding:56.25% 0 0 0;position:relative;">
       <iframe src="https://player.vimeo.com/video/321913054?h=c841d020b5&title=0&byline=0&portrait=0" style="position:absolute;top:0;left:0;width:100%;height:100%;" frameborder="0" allow="autoplay; fullscreen; picture-in-picture" allowfullscreen></iframe>
     </div>
     <script src="https://player.vimeo.com/api/player.js"></script>
     <figcaption>
       <p>Example paleoglacier visualization made with hyoga.</p>
     </figcaption>
   </figure>

.. toctree::
   :caption: User guide
   :hidden:
   :maxdepth: 2

   foreword/startup
   datasets/index
   examples/index

.. toctree::
   :caption: Reference
   :hidden:
   :maxdepth: 2

   api/index
   roadmap
   whatsnew

.. Hint::

   Development is currently funded by Research Foundation -- Flanders (FWO_)
   Odysseus Type II project GlaciersMD_ within the bglacier_ group at Vrije
   Universiteit Brussel (VUB_).

.. _FWO: https://www.fwo.be
.. _GlaciersMD: https://hydr.vub.be/projects/GlaciersMD
.. _bglacier: https://hydr.vub.be/research-groups/bglacier
.. _vub: https://vub.be

.. admonition:: Citing

   Every hyoga release is long-term archived in Zenodo_ and attributed a DOI.
   If you use hyoga in a publication, please refer to the corresponding Zenodo
   version DOI, as well as the following article based on an early version of
   hyoga, e.g. for ``v0.3.0``:

   - Julien Seguinot. (2023). Hyoga: paleoglacier modelling framework (v0.3.0).
     *Zenodo*. https://doi.org/10.5281/zenodo.7541127

   - J. Seguinot and I. Delaney. Last-glacial-cycle glacier erosion potential
     in the Alps. *Earth Surf. Dynam.*, 9:923–935,
     https://doi.org/10.5194/esurf-9-923-2021, 2021.

   This badge always indicates the latest record: |doi|.

.. |doi| image:: https://zenodo.org/badge/227465038.svg
   :target: https://zenodo.org/badge/latestdoi/227465038

.. this link always points to the latest record, too
.. _Zenodo: https://zenodo.org/record/4570420