.. figure:: _static/oggm.gif
   :align: right
   :width: 80%

|

Welcome to OGGM-Edu!
====================

|

OGGM-Edu is an educational website about glaciers.

Our main goal is to **provide tools and materials for instructors** who
want to teach about glaciers at school, in workshops or at the university. We have been featured in
this
`EGU blog post <https://blogs.egu.eu/divisions/cr/2021/03/12/do-you-know-about-oggm-edu-an-open-source-educational-platform-about-glaciers-and-glacier-modelling/>`_!

**OGGM-Edu has four independent and complementary components**:

📱 :ref:`title_apps`
    | Illustrate glaciological processes with the help of interactive web applications.
    | 🌎 *Targeted audience*: Everyone! From school children to adults, with or without a scientific background.

📈 :ref:`title_graphics`
    | Access open images and graphics that can be used for lectures or presentations.
    | 🎓 *Targeted audience*: Educators, researchers, and presenters looking to use visual materials.

📓 :ref:`title_notebooks`
    | Guidance to run and develop from simple to complex glacier modelling experiments.
    | 💻 *Targeted audience*: Undergraduate or graduate students with some programming experience, or anyone working with an instructor for hands-on learning.

📖 :ref:`title_tuto`
    | For current and future users of the Open Global Glacier Model.
    | 🔬 *Targeted audience*: Graduate students or scientists seeking to understand and use the model effectively.


OGGM-Edu focuses on interactive content and numerical glacier experiments.
We do not provide textbook resources about fundamentals in glaciology, climate science,
or numerical methods: for textbook material, refer to
:ref:`other_resources`, which OGGM-Edu intends to complement.

.. _title_apps:

Interactive apps
^^^^^^^^^^^^^^^^

These interactive apps can be run on any computer with an internet connection.

* :doc:`gallery`
* :doc:`explorer`
* :doc:`simulator`
* :doc:`mb_simulator`
* :doc:`alps_future`
* :doc:`glacier_runoff`
* :doc:`provide_dashboard`

.. toctree::
    :maxdepth: 1
    :hidden:
    :caption: Interactive apps

    gallery.rst
    explorer.rst
    simulator.rst
    mb_simulator.rst
    alps_future.rst
    glacier_runoff.rst
    provide_dashboard.rst

.. _title_graphics:

Graphics
^^^^^^^^

Open access images and graphics that can be used for lectures or presentations.

* :doc:`glacier_basics`
* :doc:`glacier_debriscovered`
* :doc:`glacier_videos`
* :doc:`glacier_lowpass`

.. toctree::
    :maxdepth: 1
    :hidden:
    :caption: Graphics

    glacier_basics.rst
    glacier_debriscovered.rst
    glacier_videos.rst
    glacier_lowpass.rst


.. _title_notebooks:

Interactive Notebooks
^^^^^^^^^^^^^^^^^^^^^

Collection of notebooks with simple experiments explaining one or more
glaciological concepts. The :ref:`api` provides an intuitive and expressive
interface to the `OGGM model <https://docs.oggm.org>`_, highly simplifying
the development of glacier evolution experiments.
Read our :ref:`notebooks_howto` first if you are new to these things.

|badge_edu_notebooks|

.. admonition:: New! Run your class on classroom.oggm.org

    Since 2021, OGGM-Edu offers a new service for instructors:
    `classroom.oggm.org <https://classroom.oggm.org>`_ is a JupyterHub server
    where you and your students can use OGGM-Edu without the burden of installing
    anything. See `this blog post <https://oggm.org/2022/03/19/classroom/>`_
    for an introduction.

    |badge_classroom_tutos|


.. toctree::
    :maxdepth: 1
    :hidden:
    :caption: Interactive Notebooks

    notebooks_howto.rst
    api.rst
    OGGM-Edu notebooks <https://oggm.org/oggm-edu-notebooks>

.. _title_tuto:

OGGM tutorials
^^^^^^^^^^^^^^

These are more advanced notebooks, for those who want to use the OGGM model for research.

|badge_tutorial_notebooks|

.. toctree::
    :maxdepth: 1
    :hidden:
    :caption: OGGM tutorials

    OGGM tutorials <https://oggm.org/tutorials/stable>


For instructors and teachers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Thanks for considering OGGM-Edu for your classes! We've gathered some
recommendations and guidelines here.

.. admonition:: New! Teaching materials for glaciology labs now available.

    If you are an instructor, visit our new resources especially for teachers
    on the :ref:`classes_howto` page.

* :doc:`why_oggmedu`
* :doc:`classes_howto`
* :doc:`user_content`
* :doc:`other_resources`
* :doc:`charter`
* :doc:`roadmap`

.. toctree::
    :maxdepth: 1
    :hidden:
    :caption: For instructors and teachers

    why_oggmedu.rst
    classes_howto.rst
    user_content.rst
    other_resources.rst
    charter.rst
    roadmap.rst

.. toctree::
    :maxdepth: 1
    :hidden:
    :caption: Package documentation

    api_detailed.rst

.. _title_contact:

Get in touch
^^^^^^^^^^^^

Interested in OGGM-Edu? We would love to hear from you!

- All of this website and notebooks are located `on GitHub`_.
- Report bugs or share your ideas on the `issue tracker`_.
- Improve the website by submitting a `pull request`_.
- Or you can always send us an `e-mail`_ the good old way.

.. _e-mail: info@oggm.org
.. _on GitHub: https://github.com/OGGM/oggm-edu
.. _issue tracker: https://github.com/OGGM/oggm-edu/issues
.. _pull request: https://github.com/OGGM/oggm-edu/pulls

Acknowledgements
^^^^^^^^^^^^^^^^

OGGM-Edu is an affiliated project of the larger OGGM consortium
(`oggm.org <https://oggm.org>`_). It is mainly the work of volunteers, but we
also had support from various sources:

- the University of Innsbruck, Förderkreis **1669** – **Wissen** schafft
  Gesell **schaft** (2019-2020).
- the German BMBF (project FKZ 01LS1602A, 2017-2019).
- `Google Cloud | Data Solutions for Change`_ who provided cloud computing
  and hosting credits (2019-2020).
- the University of Innsbruck, department of
  `Digital Sciences <https://www.uibk.ac.at/zid/abteilungen/lt/>`_
  (Neue Medien Projekte, 2018).
- the OGGM e.V. organisation, who supported the creation of the OGGM-Edu logo
  and of the glacier graphics.

.. raw:: html

    <a href="https://www.uibk.ac.at/foerderkreis1669/" >
    <img src="_static/logo_1669_uibk.jpg" alt="Image missing" width="40%" />
    </a>
    <a href="https://www.bmbf.de/en/index.html" >
    <img src="_static/logo_bmbf.jpg" alt="Image missing" width="40%" />
    </a>
    <a href="https://cloud.google.com/data-solutions-for-change" >
    <img src="_static/feature-google-for-nonprofits-logo.svg" alt="Image missing" width="40%" />
    </a>
    <a href="http://holoviz.org/" >
    <img src="https://discourse.holoviz.org/uploads/default/original/1X/59aba5e11167d6b8742e01fc9d6bb60ddd4df55e.png" alt="Image missing" width="40%" />
    </a>
    <a href="https://jupyter.org" >
    <img src="https://jupyter.org/assets/share.png" alt="Jupyter logo" width="40%" />
    </a>
    <a href="https://mybinder.org" >
    <img src="https://mybinder.org/static/logo.svg" alt="MyBinder logo" width="40%" />
    </a>
    <br>

|

We rely on awesome open source tools to run OGGM-Edu! Most notably:

- `Jupyter <https://jupyter.org>`_
- `MyBinder <https://mybinder.org>`_
- `HoloViz <http://holoviz.org/>`_
- `ReadTheDocs <https://readthedocs.org>`_
- and many (many) other packages of the scientific python ecosytem

Last but not least: thanks to all OGGM-Edu friends and contributors!
For a full list, see our
`github repository <https://github.com/OGGM/oggm-edu/graphs/contributors>`_.

.. _Google Cloud | Data Solutions for Change: https://cloud.google.com/data-solutions-for-change