Release v1.6.0

OGGM · Mar 10, 2023 · ade87f6 · ade87f6
1 parent 6d305a4
commit ade87f6
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 19 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -423,15 +423,15 @@
 
 # -- OGGM Stuffs ----------------------------------------------------
 
-text_version = ('.. warning:: \n\n'
+text_version = ('.. note:: \n\n'
                 '  **This is the model documentation for users and developers '
                 'as of version {}**. '
                 'For the documentation of the latest (cutting-edge) '
                 'repository version, visit `docs.oggm.org/en/latest '
                 '<http://docs.oggm.org/en/latest/>`_.\n'
                 ''.format(oggm.__version__))
 
-text_dev = ('.. warning:: \n\n'
+text_dev = ('.. note:: \n\n'
             '  **This is the model documentation for users and developers of '
             'the latest (cutting-edge) repository version**. For the '
             'documentation of the latest stable release, visit '

diff --git a/docs/index.rst b/docs/index.rst
@@ -15,9 +15,22 @@ encouraging researchers to create unique models and analyses for their research.
 Our framework is designed to be flexible and adaptable, making it an
 ideal tool for a wide range of applications in glaciology and related fields.
 
+.. warning::
+
+   OGGM v1.6.0 is a substantial change to v1.5.3. Among other developments,
+   the mass balance calibration has substantially improved. In order to
+   allow easier and faster developments from the community in the future,
+   several variable names have changed and older workflows are not available
+   anymore. **We recommend our users to switch to 1.6 as soon as
+   possible, but only if they are at the development stage of a study.**
+   Older versions of OGGM will always be available via github and Zenodo,
+   and older documentation pages can be accessed via the interface below.
+
+
 **This webpage is for the software documentation: for general information about the
 OGGM project and related news, visit** `oggm.org <http://oggm.org>`_.
 
+
 .. include:: _generated/version_text.txt
 
 Video presentation

diff --git a/docs/mass-balance-16guide.rst b/docs/mass-balance-16guide.rst
@@ -3,4 +3,4 @@
 For returning users: transition from OGGM 1.5 to 1.6
 ====================================================
 
-TODO
+In construction.
diff --git a/docs/mass-balance-monthly.rst b/docs/mass-balance-monthly.rst
@@ -40,7 +40,8 @@ Calibration
    spend some time in getting familiar with the calibration procedure in
    order to adapt it for their own purposes.
 
-TODO
+Visit the new `mass balance calibration tutorial <https://oggm.org/tutorials/master/notebooks/advanced/massbalance_calibration.html>`_
+for an overview.
 
 Notes
 -----

diff --git a/docs/shop.rst b/docs/shop.rst
@@ -166,9 +166,9 @@ Level   B  10  B  80  B 160  B 240
 **L0**  979M   979M   979M   979M
 **L1**  3.3G   17G    47G    95G
 **L2**  8.3G   49G    142G   285G
-**L3**  14G    55G    148G
-**L4**         58G    152G
-**L5**         11G    11G
+**L3**  14G    55G    148G   292G
+**L4**         58G    152G   296G
+**L5**         11G    11G    12G
 ======  =====  =====  =====  =====
 
 *L4 and L5 data are not available for border 10 (the domain is too small for
@@ -200,8 +200,8 @@ To choose from a specific model configuration, use the ``prepro_base_url``
 argument in your call to :py:func:`workflow.init_glacier_directories`,
 and set it to one of the urls listed below.
 
-See `this tutorial <https://oggm.org/tutorials/stable/notebooks/elevation_bands_vs_centerlines.html>`_
-for an example.
+As of March 10, 2023, we offer several urls. Explore
+`https://cluster.klima.uni-bremen.de/~oggm/gdirs/oggm_v1.6 <https://cluster.klima.uni-bremen.de/~oggm/gdirs/oggm_v1.6>`_ and our `tutorials <https://oggm.org/tutorials>`_ for examples of applications.
 
 .. admonition:: **Version 1.4 and 1.5 directories (before v1.6)**
     :class: note, dropdown

diff --git a/docs/whats-new.rst b/docs/whats-new.rst
@@ -3,12 +3,12 @@
 Version history
 ===============
 
-v1.6.0 (unreleased)
--------------------
+v1.6.0 (March 10, 2023)
+-----------------------
 
 A new major release of the OGGM with several important changes. We recommend
 all users to switch to this version only if they are ready for a new study,
-or rerun their simulations.
+or are prepared to rerun their simulations with changed results.
 
 Breaking changes
 ~~~~~~~~~~~~~~~~
@@ -17,10 +17,18 @@ Breaking changes
   a few OGGM versions. Similarly, other old functions
   (e.g. ``process_cmip5_data``) were also removed.
 - several default parameters were updated to new values. See "migrating guide"
-  below to navigate through these changes.
+  (in construction) to navigate through these changes.
 - the calibration of the mass balance models with the :math:`t^*` ("T star")
-  method is no longer supported. The code is here and can be used, but we
-  don't use it ourselves anymore.
+  method is no longer supported. The new calibration scheme is considerably
+  more flexible, but relies on new parameter names.
+- as a result, old workflows and old glacier directories cannot be used (after
+  Level 3) in OGGM v1.6 anymore.
+
+.. warning::
+
+    Because of the many changes, the list below is not exhaustive at all. We
+    preferred to focus on what is new in the tutorials, and recommend all returning
+    users to go over the new tutorials to familiarize themselves with the changes.
 
 Enhancements
 ~~~~~~~~~~~~
@@ -98,10 +106,6 @@ Bug fixes
   list of DEM sources. (:pull:`1506`).
   By `Daniel Otto <https://github.com/d-otto>`_
 
-Migrating guide
-~~~~~~~~~~~~~~~
-
-Some text here.
 
 v1.5.3 (02.04.2022)
 -------------------