Small additional changes and theme update (#130)

docs/conf.py

@@ -197,8 +197,10 @@
     "extra_navbar": extra_navbar,
 }
 
+# This is necessary to have an optional footer
 html_sidebars = {
-    "**": ["sidebar-search-bs.html", "sbt-sidebar-nav.html", "sbt-sidebar-footer.html"]
+    "**": ["sidebar-logo.html", "search-field.html",
+           "sbt-sidebar-nav.html", "sbt-sidebar-footer.html"]
 }
 
 

docs/environment.yml

@@ -8,4 +8,4 @@ dependencies:
   - sphinx
   - pip
   - pip:
-      - sphinx-book-theme==0.0.42
+      - sphinx-book-theme

docs/index.rst

@@ -42,8 +42,8 @@ These interactive apps can be run on any computer with an internet connection.
 * :doc:`gallery`
 * :doc:`explorer`
 * :doc:`simulator`
-* :doc:`alps_future`
 * :doc:`mb_simulator`
+* :doc:`alps_future`
 
 .. toctree::
     :maxdepth: 1
@@ -53,8 +53,8 @@ These interactive apps can be run on any computer with an internet connection.
     gallery.rst
     explorer.rst
     simulator.rst
-    alps_future.rst
     mb_simulator.rst
+    alps_future.rst
 
 .. _title_graphics:
 

docs/mb_simulator.rst

@@ -13,11 +13,12 @@ You can start the app by clicking on this link: |badge_bokeh_en|_
 
 .. _badge_bokeh_en: https://bokeh.oggm.org/mb_simulator/app
 
-.. important::
+.. note::
 
-  The app uses computer resources on the cloud. If several people are using the app at
-  the same time, the server might become slow or unresponsive. In this case,
-  we recommend to use the app
+  The app uses computer resources on the cloud. It is quite heavy in graphical
+  resources, which makes updates to the plot a bit slow (several seconds).
+  If the app is *very* slow when many people use it at the same time (in a class),
+  we recommend to also use the app
   `on MyBinder <https://mybinder.org/v2/gh/OGGM/mb_simulator/stable?urlpath=panel/app>`_
   or even locally on your own computer (see :ref:`docker-launch-mb-simulator` below).
 
@@ -26,10 +27,10 @@ Getting started with the app
 
 The MB simulator is structured in three parts:
 
-- under 'Mass Balance 1' and 'Mass Balance 2', individual MB models can be defined (with their particular climate configuration and model parameter settings) and explored (up to the monthly contributions).
+- under 'Mass Balance 1' and 'Mass Balance 2', individual MB models can be defined (with their particular climates and model parameter settings) and explored (up to the monthly contributions).
 - under 'Compare mass balances', the two individual MB models are compared to each other.
 
-For an introduction on how to interact with the app and what the individual figures show you should watch the tutorial video below!
+For an introduction on how to interact with the app and what the individual figures, watch the tutorial video below!
 
 Video tutorial
 ---------------
@@ -49,19 +50,28 @@ MB model
 
 The actual equation in the background of the app is a so-called "monthly temperature-index model", as explained in the `OGGM Docs`_. In short:
 
-- The model estimates the ablation (mass loss) only as a function of monthly mean temperature. Whenever the temperature is above a certain threshold (T_melt) ice melt is assumed. How much ice melt is determined by the temperature sensitivity parameter (μ).
-- The daily/monthly temperature cycle isn't taken into account, but ice melt may occur (e.g. around noon) also on days/months with a negative mean temperature. Therefore the melt threshold (T_melt) is often set to negative temperatures to account for this.
-- One should keep in mind that the actual ice melt is described by the whole surface energy balance (including shortwave/longwave radiation, latent/sensible heat flux, surface properties,...) and not the temperature alone.
+- The model estimates the ablation (mass loss) only as a function of monthly mean temperature. Whenever the temperature is above a certain threshold (``T_melt``) ice melt is assumed. How much ice melt is determined by the temperature sensitivity parameter (μ) multiplied by the number of degrees above ``T_melt``.
+- The daily/monthly temperature cycle isn't taken into account, but ice melt may occur (e.g. around noon) also on days/months with a negative mean temperature. Therefore the monthly melt threshold (``T_melt``) is often set to negative temperatures to account for this.
 - The model estimates the accumulation (mass gain) as a function of precipitation and temperature, where the temperature determines the fraction of solid precipitation.
 - For real-world applications, the sensitivity parameter (μ) needs to be calibrated against observation and inherently will account also for all other processes and properties not directly considered by the model (e.g. slope aspect, wind-blown snow, avalanching, ...).
 
+.. admonition:: More details
+    :class: toggle
+
+    One should keep in mind that the actual ice melt is described by the whole surface energy balance (including shortwave/longwave radiation,
+    latent/sensible heat flux, surface properties,...) and not the temperature alone. This model clearly is a simplification!
+    Numerous studies have shown that it is quite a good one, but its accuracy varies with the climate settings.
+    The purpose of this app is not to discuss this, but rather to illustrate how this MB model works.
+
 Dataset
 ~~~~~~~
 
 The temperature and precipitation data is extracted from the `CRU TS v4 Dataset`_. In short:
 
 - CRU TS v4 is a global gridded dataset (0.5° regular grid) derived from weather station observations. It covers the period 1901 - 2020 (updated annually) and provides mean monthly values for each year.
-- Whenever there are no observations available for a certain period the variables are set to their 1961 - 1990 monthly average.
+- Whenever there are no observations available for a certain period, the variables are set to their 1961 - 1990 monthly average.
+- We extract the nearest grid point to each glacier location - the reference elevation of the climate timeseries therefore
+  often does not correspond to the glacier elevation. The temperature is corrected with the ``T_grad`` parameter.
 
 Questions to explore with this app
 ----------------------------------
@@ -73,7 +83,7 @@ Monthly contributions to annual MB
 
 **Experiment:**
 
-- Choose as a base climate 'Hintereisferner (Alps, continental)' and let all the other settings unchanged.
+- Choose as a base climate 'Hintereisferner (Alps, continental)' and leave all the other settings unchanged.
 - Now look at the climograph (showing precipitation and temperature at each month) and try to answer the questions below.
 
 **Questions to answer:**
@@ -82,17 +92,25 @@ By only looking at (or moving with your mouse over) the climograph, try to guess
 
 - In which month do you think the accumulation is largest at 4000 m?
 - In which month do you think the ablation is largest at 2000 m?
-- Which month has the lowest altitude with a MB of 0 kg m⁻² month⁻¹ (lowest monthly Equilibrium Line Altitude, ELA)?
+- Which month has the lowest altitude with a MB of 0 kg m⁻² month⁻¹ (lowest monthly Transient Equilibrium Line Altitude, T-ELA)?
 
-After you made your guess you can compare the different months by switching them on and off at the left of the accumulation plot. Tip: Move your mouse over the plots to get exact values.
+After you made your guesses, you can compare the different months by switching them on and off at the left of the accumulation plot.
+Tip: Move your mouse over the plots to get exact values.
 
 .. admonition:: Take home messages
     :class: toggle
 
-    - Largest accumulation at 4500 m in June, the month with the largest precipitation amount
-    - Largest ablation at 2000 m in July, the month with the highest temperature
-    - Lowest monthly ELA in December, even January has the lowest temperature, but in December more precipitation
-    - Advanced comment: Comparing ablation of December and January in 1600 m shows slightly more negative value in January than December. But from the definition of the ablation we would expect a more negative value for December when only looking at the mean temperature shown in the climograph (the lower the temperature the smaller the ablation). This is an example showing the difference of calculating the monthly MB at each month and then calculating the mean (as it is done in the background) or first calculating a mean temperature for a month and then using this for the calculation of the monthly MB. For more information look at this `OGGM Blogpost`_.
+    - Largest accumulation at 4500 m in June, the month with the largest precipitation amount - Largest ablation at 2000m in July,
+      the month with the highest temperature
+    - Lowest monthly T-ELA is in December. Indeed, January has the
+      lowest temperature, but December has more precipitation
+    - Advanced comment: comparing ablation values in December and
+      January at 1600 m shows slightly more negative values in January than December. But from the definition of the
+      ablation we would expect a more negative value for December when only looking at the mean temperature shown in the
+      climograph (the lower the temperature the smaller the ablation). This is an example showing the difference of
+      calculating the monthly MB FOR each month and then calculating the mean (as it is done here), or first
+      calculating a mean temperature for a month and then using this for the calculation of the monthly MB. For more
+      information, look at this `OGGM Blogpost`_.
 
 
 Compare different locations/climates
@@ -105,9 +123,9 @@ Compare different locations/climates
 
 **Questions to answer:**
 
-- Compare the accumulation and ablation at the ELA.
+- Compare the accumulation and ablation at the average Equilibrium Line Altitude (ELA).
 - Compare the total MB profile and the position of the ELA.
-- *Advanced*: How do you believe these differences influence the glacier flow?
+- *Advanced*: How will these differences influence glacier ice flow?
 
 .. admonition:: Take home messages
     :class: toggle
@@ -136,10 +154,11 @@ Compare different periods of the same base climate
     :class: toggle
 
     - higher Temperatures results in a higher ELA in 1990 - 2020 compared to 1902 - 1932
-    - but due to the larger precipitation amount ('total Prec.' when moving the mouse over a climograph) the mass gain is larger at high elevations (>5100 m) in 1990 - 2020 compared to 1902 - 1932
+    - but due to the larger total precipitation amount, the mass gain is larger at
+      high elevations (>5100 m) in 1990 - 2020 compared to 1902 - 1932
 
-Influence of MB settings
-~~~~~~~~~~~~~~~~~~~~~~~~
+Influence of model settings
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 **Experiment (suggestion):**
 

docs/simulator.rst

@@ -15,7 +15,7 @@ You can start the app by clicking on this link: |badge_bokeh_en|_
 
 .. _badge_bokeh_en: https://bokeh.oggm.org/simulator/app
 
-.. important::
+.. note::
 
   The glacier simulator app runs a numerical glacier model in the background,
   using computer resources on the cloud. If several people are using the app at