Skip to content

Commit

Permalink
More restructuring (#155)
Browse files Browse the repository at this point in the history
  • Loading branch information
fmaussion committed Jun 26, 2022
1 parent 49febb4 commit 8977699
Show file tree
Hide file tree
Showing 26 changed files with 1,143 additions and 692 deletions.
2 changes: 2 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _api:

#######################
oggm-edu python package
#######################
Expand Down
6 changes: 0 additions & 6 deletions docs/classes_howto.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,6 @@ See also the two OGGM-Edu lab activities hosted on SERC:
- `OGGM-Edu Glaciology Lab 1 - What Makes a Glacier?`_
- `OGGM-Edu Glaciology Lab 2 - Exploring glacier data`_

These activites have been tested in class and will be developed further.
If you want more ideas, here are suggested activities writen by Josie Iino, a
high school student who realized a short internship with us:

- :ref:`as_gallery`
- :ref:`as_simulator`

Using the OGGM-Edu notebooks at university
------------------------------------------
Expand Down
31 changes: 23 additions & 8 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ 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.

For a general introduction and an overview, visit this recent
For a general introduction and an overview, visit this recent
`EGU cryoblog 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**:
Expand All @@ -31,8 +31,8 @@ For a general introduction and an overview, visit this recent
to learn how the model works.

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

.. _title_apps:
Expand Down Expand Up @@ -86,12 +86,24 @@ Interactive Notebooks
^^^^^^^^^^^^^^^^^^^^^

Collection of notebooks with simple experiments explaining one or more
glaciological concepts. They are relatively easy to follow and adapt with some
background in programming, and we are working to make them as accessible as
possible. Read our :ref:`notebooks_howto` first if you are new to these things.
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:
Expand Down Expand Up @@ -124,10 +136,14 @@ 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:`technical_details`
* :doc:`other_resources`
* :doc:`charter`
* :doc:`roadmap`
Expand All @@ -140,7 +156,6 @@ recommendations and guidelines here.
why_oggmedu.rst
classes_howto.rst
user_content.rst
technical_details.rst
other_resources.rst
charter.rst
roadmap.rst
Expand Down
50 changes: 25 additions & 25 deletions docs/locale/de/LC_MESSAGES/classes_howto.po
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: OGGM-Edu 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2022-06-25 18:58+0200\n"
"POT-Creation-Date: 2022-06-26 17:05+0200\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
Expand Down Expand Up @@ -135,32 +135,17 @@ msgstr ""
msgid "See also the two OGGM-Edu lab activities hosted on SERC:"
msgstr ""

#: ../../classes_howto.rst:57
msgid ""
"These activites have been tested in class and will be developed further. "
"If you want more ideas, here are suggested activities writen by Josie "
"Iino, a high school student who realized a short internship with us:"
msgstr ""

#: ../../classes_howto.rst:61
msgid ":ref:`as_gallery`"
msgstr ""

#: ../../classes_howto.rst:62
msgid ":ref:`as_simulator`"
msgstr ""

#: ../../classes_howto.rst:65
#: ../../classes_howto.rst:59
msgid "Using the OGGM-Edu notebooks at university"
msgstr ""

#: ../../classes_howto.rst:67
#: ../../classes_howto.rst:61
msgid ""
"For students with programming knowledge (or willing to learn!), the OGGM-"
"Edu notebooks add a layer of depth and interactivity to the apps."
msgstr ""

#: ../../classes_howto.rst:70
#: ../../classes_howto.rst:64
msgid ""
"The use of notebooks in classes is expanding rapidly (see for example the"
" great resource `Teaching and Learning with Jupyter "
Expand All @@ -172,18 +157,18 @@ msgid ""
"learning."
msgstr ""

#: ../../classes_howto.rst:77
#: ../../classes_howto.rst:71
msgid ""
"Visit the `OGGM-Edu-Notebooks <https://oggm.org/oggm-edu-notebooks>`_ "
"webpage to see them in action! And our :ref:`nbs_in_class` will help you "
"to get started with your class."
msgstr ""

#: ../../classes_howto.rst:84
#: ../../classes_howto.rst:78
msgid "Existing classes based on OGGM-Edu"
msgstr ""

#: ../../classes_howto.rst:86
#: ../../classes_howto.rst:80
msgid ""
"Here are some known applications of OGGM-Edu in classes. You can use them"
" \"as is\", or as templates for your own classes. We would love to hear "
Expand All @@ -192,21 +177,21 @@ msgid ""
"them!"
msgstr ""

#: ../../classes_howto.rst:91
#: ../../classes_howto.rst:85
msgid ""
"`Middlebury College glaciology-labs notebooks <https://github.com/ehultee"
"/glaciology-labs>`_, adapted (and enhanced) OGGM-Edu notebooks. By `Lizz "
"Ultee <https://ehultee.github.io/>`_."
msgstr ""

#: ../../classes_howto.rst:93
#: ../../classes_howto.rst:87
msgid ""
"`University of Michigan CLaSP 474 Ice and Climate notebooks "
"<https://github.com/skachuck/clasp474_w2021>`_, adapted (and enhanced) "
"OGGM-Edu notebooks. By `Samuel Kachuck <http://georei.com/>`_."
msgstr ""

#: ../../classes_howto.rst:95
#: ../../classes_howto.rst:89
msgid ""
"`Three-day workshop <https://github.com/ehultee/CdeC-glaciologia>`_ for "
"university students without prior glacier experience (in spanish). By "
Expand Down Expand Up @@ -339,3 +324,18 @@ msgstr ""
#~ "the pages below:"
#~ msgstr ""

#~ msgid ""
#~ "These activites have been tested in "
#~ "class and will be developed further. "
#~ "If you want more ideas, here are"
#~ " suggested activities writen by Josie "
#~ "Iino, a high school student who "
#~ "realized a short internship with us:"
#~ msgstr ""

#~ msgid ":ref:`as_gallery`"
#~ msgstr ""

#~ msgid ":ref:`as_simulator`"
#~ msgstr ""

0 comments on commit 8977699

Please sign in to comment.