Add more doc pages (#13)

OGGM · Nov 17, 2018 · e20dc2c · e20dc2c
1 parent 23dfe53
commit e20dc2c
Show file tree

Hide file tree

Showing 15 changed files with 255 additions and 2,059 deletions.
diff --git a/data/glaciers-explorer.csv b/data/glaciers-explorer.csv
diff --git a/docs/_static/explorer.png b/docs/_static/explorer.png
diff --git a/docs/explorer.rst b/docs/explorer.rst
@@ -0,0 +1,52 @@
+.. _explorer:
+
+World Glaciers Explorer
+=======================
+
+.. figure:: _static/explorer.png
+    :width: 100%
+
+The world glacier explorer is an interactive application allowing to explore
+the location of the glaciers and their climate.
+
+
+You can open it by clicking on this link: |badgelink|_
+
+.. |badgelink| image::  https://img.shields.io/badge/launch-binder%20app-579ACA.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAFkAAABZCAMAAABi1XidAAAB8lBMVEX///9XmsrmZYH1olJXmsr1olJXmsrmZYH1olJXmsr1olJXmsrmZYH1olL1olJXmsr1olJXmsrmZYH1olL1olJXmsrmZYH1olJXmsr1olL1olJXmsrmZYH1olL1olJXmsrmZYH1olL1olL0nFf1olJXmsrmZYH1olJXmsq8dZb1olJXmsrmZYH1olJXmspXmspXmsr1olL1olJXmsrmZYH1olJXmsr1olL1olJXmsrmZYH1olL1olLeaIVXmsrmZYH1olL1olL1olJXmsrmZYH1olLna31Xmsr1olJXmsr1olJXmsrmZYH1olLqoVr1olJXmsr1olJXmsrmZYH1olL1olKkfaPobXvviGabgadXmsqThKuofKHmZ4Dobnr1olJXmsr1olJXmspXmsr1olJXmsrfZ4TuhWn1olL1olJXmsqBi7X1olJXmspZmslbmMhbmsdemsVfl8ZgmsNim8Jpk8F0m7R4m7F5nLB6jbh7jbiDirOEibOGnKaMhq+PnaCVg6qWg6qegKaff6WhnpKofKGtnomxeZy3noG6dZi+n3vCcpPDcpPGn3bLb4/Mb47UbIrVa4rYoGjdaIbeaIXhoWHmZYHobXvpcHjqdHXreHLroVrsfG/uhGnuh2bwj2Hxk17yl1vzmljzm1j0nlX1olL3AJXWAAAAbXRSTlMAEBAQHx8gICAuLjAwMDw9PUBAQEpQUFBXV1hgYGBkcHBwcXl8gICAgoiIkJCQlJicnJ2goKCmqK+wsLC4usDAwMjP0NDQ1NbW3Nzg4ODi5+3v8PDw8/T09PX29vb39/f5+fr7+/z8/Pz9/v7+zczCxgAABC5JREFUeAHN1ul3k0UUBvCb1CTVpmpaitAGSLSpSuKCLWpbTKNJFGlcSMAFF63iUmRccNG6gLbuxkXU66JAUef/9LSpmXnyLr3T5AO/rzl5zj137p136BISy44fKJXuGN/d19PUfYeO67Znqtf2KH33Id1psXoFdW30sPZ1sMvs2D060AHqws4FHeJojLZqnw53cmfvg+XR8mC0OEjuxrXEkX5ydeVJLVIlV0e10PXk5k7dYeHu7Cj1j+49uKg7uLU61tGLw1lq27ugQYlclHC4bgv7VQ+TAyj5Zc/UjsPvs1sd5cWryWObtvWT2EPa4rtnWW3JkpjggEpbOsPr7F7EyNewtpBIslA7p43HCsnwooXTEc3UmPmCNn5lrqTJxy6nRmcavGZVt/3Da2pD5NHvsOHJCrdc1G2r3DITpU7yic7w/7Rxnjc0kt5GC4djiv2Sz3Fb2iEZg41/ddsFDoyuYrIkmFehz0HR2thPgQqMyQYb2OtB0WxsZ3BeG3+wpRb1vzl2UYBog8FfGhttFKjtAclnZYrRo9ryG9uG/FZQU4AEg8ZE9LjGMzTmqKXPLnlWVnIlQQTvxJf8ip7VgjZjyVPrjw1te5otM7RmP7xm+sK2Gv9I8Gi++BRbEkR9EBw8zRUcKxwp73xkaLiqQb+kGduJTNHG72zcW9LoJgqQxpP3/Tj//c3yB0tqzaml05/+orHLksVO+95kX7/7qgJvnjlrfr2Ggsyx0eoy9uPzN5SPd86aXggOsEKW2Prz7du3VID3/tzs/sSRs2w7ovVHKtjrX2pd7ZMlTxAYfBAL9jiDwfLkq55Tm7ifhMlTGPyCAs7RFRhn47JnlcB9RM5T97ASuZXIcVNuUDIndpDbdsfrqsOppeXl5Y+XVKdjFCTh+zGaVuj0d9zy05PPK3QzBamxdwtTCrzyg/2Rvf2EstUjordGwa/kx9mSJLr8mLLtCW8HHGJc2R5hS219IiF6PnTusOqcMl57gm0Z8kanKMAQg0qSyuZfn7zItsbGyO9QlnxY0eCuD1XL2ys/MsrQhltE7Ug0uFOzufJFE2PxBo/YAx8XPPdDwWN0MrDRYIZF0mSMKCNHgaIVFoBbNoLJ7tEQDKxGF0kcLQimojCZopv0OkNOyWCCg9XMVAi7ARJzQdM2QUh0gmBozjc3Skg6dSBRqDGYSUOu66Zg+I2fNZs/M3/f/Grl/XnyF1Gw3VKCez0PN5IUfFLqvgUN4C0qNqYs5YhPL+aVZYDE4IpUk57oSFnJm4FyCqqOE0jhY2SMyLFoo56zyo6becOS5UVDdj7Vih0zp+tcMhwRpBeLyqtIjlJKAIZSbI8SGSF3k0pA3mR5tHuwPFoa7N7reoq2bqCsAk1HqCu5uvI1n6JuRXI+S1Mco54YmYTwcn6Aeic+kssXi8XpXC4V3t7/ADuTNKaQJdScAAAAAElFTkSuQmCC
+.. _badgelink: https://mybinder.org/v2/gh/panel-demos/glaciers/master?urlpath=/proxy/5006/app
+
+The app contains five elements:
+
+- the **header text** indicates how many glaciers are currently selected
+  (active), and how much of the total area they represent.
+- the **top left panel** is a map of the glacier locations and their area. Moving
+  the mouse over a glacier pixel gives you its glaciated area
+- the **top right panel** displays the elevation of the glaciers with respect to
+  their latitude
+- the **bottom left panel** shows the histogram of the glaciers' mean temperature
+  (at the glacier's mean elevation).
+- the **bottom right panel** shows the histogram of the glaciers' mean annual
+  precipitation (liquid and solid).
+
+When selecting data in each of these panels, the other panels are actualized
+automatically, allowing to ask questions such as:
+
+- where are the wettest glaciers located? And the driests?
+- is there a relationship between temperature and precipitation?
+- how much glacier area is found on Greenland? In the European Alps?
+- what is the relationship between latitude and glacier elevation?
+- ...
+
+
+Data sources
+------------
+
+Possible improvements
+---------------------
+
+- By using other data sources (e.g. ERA-Interim), it would be possible to plot
+  the Antarctic glaciers as well.
+- With a selection by category, it would be possible to differenciate glaciers
+  from ice-caps or marine terminating glaciers from land-terminating ones.
+- By using the data from the global ITMIX experiment, it is possible to convert a
+  selection into sea-level rise equivalent.
diff --git a/docs/index.rst b/docs/index.rst
@@ -3,18 +3,28 @@ Welcome to OGGM-Edu!
 
 This platform will become an educational website about glaciers.
 
-It is currently in construction, please come back soon!
+It is currently in construction, but you can still try a couple of cool things:
 
-Contents:
+Interactive apps
+^^^^^^^^^^^^^^^^
+
+* :doc:`explorer`
 
 .. toctree::
-   :maxdepth: 2
+    :maxdepth: 1
+    :hidden:
+    :caption: Interactive apps
+
+    explorer.rst
 
+Interactive Notebooks
+^^^^^^^^^^^^^^^^^^^^^
 
+* :doc:`notebooks_howto`
 
-Indices and tables
-==================
+.. toctree::
+    :maxdepth: 1
+    :hidden:
+    :caption: Interactive Notebooks
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+    notebooks_howto.rst
diff --git a/docs/notebooks_howto.rst b/docs/notebooks_howto.rst
@@ -0,0 +1,4 @@
+.. _notebooks_howto:
+
+Notebooks: introduction
+=======================
diff --git a/download_cache.py b/download_cache.py
@@ -3,4 +3,3 @@
 
 from oggm.utils import download_oggm_files
 download_oggm_files()
-
diff --git a/environment.yml b/environment.yml
@@ -1,15 +1,9 @@
 name: oggm-env
 channels:
-  - pyviz/label/dev
   - oggm
   - conda-forge
 dependencies:
   - oggm-deps
   - numpy>=1.15.1
-  - appmode
-  - param=1.8.1
-  - panel=0.1.2
-  - holoviews=1.11.0a8
-  - geoviews=1.5.4a13
   - pip:
     - git+https://github.com/OGGM/oggm.git
diff --git a/flowline_model.ipynb → experiments/flowline_model.ipynb b/flowline_model.ipynb → experiments/flowline_model.ipynb
diff --git a/flowline_with_known_bedrock.ipynb → ...riments/flowline_with_known_bedrock.ipynb b/flowline_with_known_bedrock.ipynb → ...riments/flowline_with_known_bedrock.ipynb
diff --git a/surging_experiment.ipynb → experiments/surging_experiment.ipynb b/surging_experiment.ipynb → experiments/surging_experiment.ipynb
diff --git a/graphics/ela_changes_response_time.ipynb → gen_plots/ela_changes_response_time.ipynb b/graphics/ela_changes_response_time.ipynb → gen_plots/ela_changes_response_time.ipynb
diff --git a/glaciers-explorer-panel.ipynb b/glaciers-explorer-panel.ipynb
diff --git a/oggm_edu/__init__.py b/oggm_edu/__init__.py
@@ -0,0 +1 @@
+__version__ = '0.0.1'