Skip to content

Commit

Permalink
Some more editorial updates (#91)
Browse files Browse the repository at this point in the history
  • Loading branch information
fmaussion committed Jun 1, 2020
1 parent 5966eab commit 87175b5
Show file tree
Hide file tree
Showing 8 changed files with 30 additions and 40 deletions.
5 changes: 3 additions & 2 deletions docs/classes_howto.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ OGGM-Edu in classes and workshops

OGGM-Edu can readily be used in your classes and workshops - we encourage you to
try it out! Depending on your own knowledge about glaciers, this can require
little or some preparation.
some preparation. Check out :ref:`other_resources` if you are interested in
the fundamentals and online textbook materials.

Currently, we are working on making OGGM-Edu suitable for classes at the
highschool level (using the web applications) and at the university level
Expand All @@ -18,7 +19,7 @@ Using the OGGM-Edu web apps at the highschool level

OGGM-Edu can be used to organize a 2 to 4 hours class, possibly even
longer. Note that it will require teachers to gain some knowledge about glaciers
first, either from these :ref:`other_resources` or from us.
first, either from :ref:`other_resources` or from us.

A 2 to 4 hours class could be organized as such:

Expand Down
2 changes: 1 addition & 1 deletion docs/explorer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Authors
`HoloViz <http://holoviz.org//>`_ and Anaconda Inc., based on an original
Dash application by `Fabien Maussion <https://fabienmaussion.info/>`_.
`Zora Schirmeister <https://github.com/zschirmeister>`_ improved the app
significantly with new data, plots, and an improved layout.
with new data, plots, and an improved layout.

Data sources
------------
Expand Down
8 changes: 4 additions & 4 deletions docs/glacier_basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ A collection of free glacier graphics that can be used for education and
outreach.


**License**: `Creative Commons Attribution-NonCommercial 4.0 International License <http://creativecommons.org/licenses/by-nc/4.0/>`_
**License**: `Creative Commons Attribution-ShareAlike 4.0 International License <https://creativecommons.org/licenses/by-sa/4.0/>`_

.. figure:: https://i.creativecommons.org/l/by-nc/4.0/88x31.png
:target: http://creativecommons.org/licenses/by-nc/4.0/
.. figure:: https://licensebuttons.net/l/by-sa/4.0/88x31.png
:target: https://creativecommons.org/licenses/by-sa/4.0/


Feel free to use / adapt the graphics, but always refer to the original author
and do not sell them.
and share them with a compatible license.

**Author**: Anne Maussion, `Atelier les Gros yeux <http://atelierlesgrosyeux.com>`_

Expand Down
12 changes: 6 additions & 6 deletions docs/glacier_lowpass.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,20 @@ A collection of free glacier graphics that can be used for education and
outreach.


**License**: `Creative Commons Attribution-NonCommercial 4.0 International License <http://creativecommons.org/licenses/by-nc/4.0/>`_
**License**: `Creative Commons Attribution-ShareAlike 4.0 International License <https://creativecommons.org/licenses/by-sa/4.0/>`_

.. figure:: https://i.creativecommons.org/l/by-nc/4.0/88x31.png
:target: http://creativecommons.org/licenses/by-nc/4.0/
.. figure:: https://licensebuttons.net/l/by-sa/4.0/88x31.png
:target: https://creativecommons.org/licenses/by-sa/4.0/


Feel free to use / adapt the graphics, but always refer to the original author
and do not sell them.
and share them with a compatible license.

**Author**: Fabien Maussion with the `OGGM <http://oggm.org>`_ model.

**Code**: *has been moved, should be re-uploaded soon*
**Code**: `on GitHub <https://github.com/OGGM/oggm-edu-notebooks/blob/master/graphics/ela_changes_response_time.ipynb>`_

**Interactive notebook**: *has been moved, should be re-uploaded soon*
**Interactive notebook**: `MyBinder link <https://mybinder.org/v2/gh/OGGM/binder/master?urlpath=git-pull?repo=https://github.com/OGGM/oggm-edu-notebooks%26amp%3Bbranch=master%26amp%3Burlpath=lab/tree/oggm-edu-notebooks/graphics/ela_changes_response_time.ipynb%3Fautodecode>`_

**Image download**: `zip file <https://github.com/OGGM/glacier-graphics/blob/master/glacier_response/glacier_response.zip>`_

Expand Down
7 changes: 6 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,11 @@ on glaciology and glacial water resources for Peruvian students.
Model. These notebooks are targetting graduate students or scientists aiming
to learn how the model works.

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

.. _title_apps:

Interactive apps
Expand Down Expand Up @@ -111,7 +116,7 @@ possible. Read our :ref:`notebooks_howto` first if you are new to these things.
OGGM tutorials
^^^^^^^^^^^^^^

These are more advanced notebooks, for potential and current users of the
These are more advanced notebooks, for current and future users of the
OGGM model.

* :doc:`oggm_tuto`
Expand Down
5 changes: 3 additions & 2 deletions docs/other_resources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@
Other educational resources
===========================

There is plenty of great educational material online! OGGM-Edu tries to find
OGGM-Edu tries to find
its "niche" by providing interactive content focusing on numerical glacier
models. However, OGGM-Edu does not provide much theoretical background or
lecture materials. For more of this, check out these great resources:
lecture materials. For more information about fundamentals,
check out these great online resources:

- `Antarctic Glaciers <http://www.antarcticglaciers.org/>`_: excellent resource
to learn about glaciers (and not only those in Antarctica)
Expand Down
29 changes: 6 additions & 23 deletions docs/roadmap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ Roadmap
:Authors: Fabien Maussion
:Status: Draft
:Created: 04.10.2019
:Updated: 06.12.2019
:Updated: 01.06.2020

The OGGM-Edu platform is about one year old (first commit on Sep 21, 2018!).
The OGGM-Edu platform will soon be 2 years old (first commit on Sep 21, 2018!).
We have made tremendous progress in one year: we created this website,
added new content, enabled interactivity via MyBinder and hub.oggm.org,
supported the creation of a workshop for a class in Peru, secured
Expand All @@ -20,17 +20,18 @@ brainstorm about what we want to realize in the future.
Intro
-----

As of December 2019, we have on the platform:
As of June 2020, we have on the platform:

- an interactive app (World Glacier Explorer)
- 4 interactive web apps
- 8 jupyter notebooks templates in various complexity levels
- a series of glacier graphics
- bits of documentation for teachers about how to use the notebooks and MyBinder

So far, our biggest achievements are (subjective opinion):

- our notebooks were used for a class in Peru (`blog post <https://oggm.org/2019/12/06/OGGM-Edu-AGU/>`_)
- we use MyBinder and hub.oggm.org as viable platforms to run
- the uprecedented web applications
- the use of MyBinder and hub.oggm.org as viable platforms to run
workshops and tutorials
- securing of funding for the platform, indicating that other people
see potential in the project as well.
Expand Down Expand Up @@ -71,24 +72,6 @@ to learn about the flowline models and what they can do with them. The models
will be more expressive, use rich output in the notebooks, with the goal to
make using the models more fun, intuitive and quantitative.


More docs and clearer goal for "the platform"
---------------------------------------------

What is OGGM-Edu? We should answer this first, then write it down.


Hosting of the Bokeh Apps (accomplished)
----------------------------------------

It's nice to write apps, but we need a way to serve them. Our current
solution is slow an not very sustainable, we need more options.

1. have a bokeh server running multiple apps in human-readable URLs (e.g. edu.oggm.org/apps/explorer)
2. provide a container where the app can run so that people just have to download docker and "that's it"
3. document how to run and develop the app locally


Website design
--------------

Expand Down
2 changes: 1 addition & 1 deletion docs/user_content.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Use your own content in OGGM-Edu
================================

Ideally, we would like all the educational content to be bundled here, on this
Ideally, we would like all OGGM-Edu related content to be bundled here, on this
open platform. However, you might be interested in running your own notebooks
in an OGGM-Edu environment, for example during the development phase, or
for a very specific class.
Expand Down

0 comments on commit 87175b5

Please sign in to comment.