Update documentation

GLIMS-RGI · Jul 26, 2023 · 0d14671 · 0d14671
1 parent 062d06d
commit 0d14671
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 26 deletions.
diff --git a/01_introduction.html b/01_introduction.html
@@ -448,7 +448,7 @@ <h2>Data distribution policy<a class="headerlink" href="#data-distribution-polic
 <section id="dataset-reference">
 <span id="reference"></span><h2>Dataset reference<a class="headerlink" href="#dataset-reference" title="Permalink to this headline">#</a></h2>
 <p><strong>The RGI 7.0 dataset should be cited as:</strong></p>
-<p><em>RGI 7.0 Consortium, 2023. Randolph Glacier Inventory - A Dataset of Global Glacier Outlines, Version 7.0. Boulder, Colorado USA. NSIDC: National Snow and Ice Data Center. doi:NSIDC</em></p>
+<p><em>RGI 7.0 Consortium, 2023. Randolph Glacier Inventory - A Dataset of Global Glacier Outlines, Version 7.0. Boulder, Colorado USA. NSIDC: National Snow and Ice Data Center. doi:10.5067/f6jmovy5navz. Online access: <a class="reference external" href="https://doi.org/10.5067/f6jmovy5navz">https://doi.org/10.5067/f6jmovy5navz</a></em></p>
 <p>All names of the consortium are listed in <a class="reference internal" href="#rgi-consortium"><span class="std std-ref">The RGI 7.0 Consortium</span></a>.
 We request all users to use this reference in publications that use RGI 7.0 data.</p>
 <p><strong>This user guide should be cited as</strong>:</p>

diff --git a/_sources/01_introduction.md b/_sources/01_introduction.md
@@ -28,9 +28,9 @@ The RGI may be used freely under the [Creative Commons Attribution 4.0 Internati
 
 **The RGI 7.0 dataset should be cited as:**
 
-*RGI 7.0 Consortium, 2023. Randolph Glacier Inventory - A Dataset of Global Glacier Outlines, Version 7.0. Boulder, Colorado USA. NSIDC: National Snow and Ice Data Center. doi:NSIDC*
+*RGI 7.0 Consortium, 2023. Randolph Glacier Inventory - A Dataset of Global Glacier Outlines, Version 7.0. Boulder, Colorado USA. NSIDC: National Snow and Ice Data Center. doi:10.5067/f6jmovy5navz. Online access: https://doi.org/10.5067/f6jmovy5navz*
 
-All names of the consortium are listed in [](rgi-consortium). 
+All names of the consortium are listed in [](rgi-consortium).
 We request all users to use this reference in publications that use RGI 7.0 data.
 
 **This user guide should be cited as**:

diff --git a/_sources/products/centerlines_product.md b/_sources/products/centerlines_product.md
@@ -46,7 +46,7 @@ The following attributes are available in the RGI 7.0 shapefiles. For more detai
 : `long_name`: Outflow segment identifier <br/> `description`: Each secondary centerline flows into another centerline. This identifier points to the `segment_id` to which this centerline flows to. <br/> `datatype`: int <br/> `units`:  <br/> `source`: RGI
 
 `strahler_n`
-: `long_name`: Strahler number of this centerline. <br/> `description`: Strahler number (Hydrological order) of the centerline, from lowest (0, line without tributaries but with possible descendants) to highest (the main centerline). <br/> `datatype`: int <br/> `units`:  <br/> `source`: RGI
+: `long_name`: Strahler number of this centerline. <br/> `description`: Strahler number (hydrological order) of the centerline, from lowest (1, line without tributaries but with possible descendants) to highest (the main centerline). <br/> `datatype`: int <br/> `units`:  <br/> `source`: RGI
 
 `length_m`
 : `long_name`: Centerline length <br/> `description`: Length of the centerline in meters. <br/> `datatype`: int <br/> `units`: m <br/> `source`: RGI
@@ -61,7 +61,7 @@ The centerlines and their attributes are computed by OGGM {cite:p}`Maussion2019`
 
 ### Strahler number
 
-The Strahler number `strahler_n` is a measure of branching complexity defined by {cite:p}`Strahler1952` commonly used in hydrological applications. A Strahler number of 0 indicates a centerline without any tributaries. A Strahler number of 1 indicates a centerline with one or more upstream tributaries of the same order, i.e. each of them having a Strahler number of 0. If a centerline with a Strahler number of 1 meets a downglacier centerline, the latter is assigned a Strahler number of 2. This ordering is important for mass flow routing. Each centerline contains a reference to its descendant, and this reference might be used by models to transfer mass from the tributaries towards the main centerline. Note that in the original concept Strahler numbers start with 1 instead of 0.
+The Strahler number `strahler_n` is a measure of branching complexity defined by {cite:p}`Strahler1952` commonly used in hydrological applications. A Strahler number of 1 indicates a centerline without any tributaries. A Strahler number of 2 indicates a centerline with one or more upstream tributaries of the same order, i.e. each of them having a Strahler number of 1. If a centerline with a Strahler number of 2 meets a downglacier centerline, the latter is assigned a Strahler number of 3. This ordering is important for mass flow routing. Each centerline contains a reference to its descendant, and this reference might be used by models to transfer mass from the tributaries towards the main centerline.
 
 ### Main centerline
 

diff --git a/_sources/welcome.md b/_sources/welcome.md
@@ -2,21 +2,17 @@
 
 The Randolph Glacier Inventory ([RGI](https://www.glims.org/RGI)) is a global inventory of glacier outlines including a set of attributes and other relevant auxiliary information. This user guide provides detailed documentation of the RGI version 7.0 but also includes general information on the RGI and its earlier versions.
 
-```{warning}
-
-**This user guide is a work in progress and refers to the beta version of RGI 7.0.**
-
-```
-
 ```{admonition} Data download
 
-[Download the RGI 7.0 beta version files](https://cluster.klima.uni-bremen.de/~fmaussion/misc/rgi7_data/l6_rgi7b2_zip). For review only!
+**Download the RGI 7.0 files**: [https://doi.org/10.5067/f6jmovy5navz](https://doi.org/10.5067/f6jmovy5navz)<br>
+Download previous RGI versions: https://www.glims.org/RGI
 ```
 
-```{admonition} Contributing to this documentation
-:class: tip
+```{admonition} Known issues in RGI 7.0
+:class: warning
+
+Currently known issues with the RGI 7.0 dataset are listed here: [https://github.com/GLIMS-RGI/rgi_issue_tracker](https://github.com/GLIMS-RGI/rgi_issue_tracker).<br>If you discover an issue with the RGI 7.0, please report it there!
 
-If you wish to contribute to this documentation, visit [CONTRIBUTING.md](https://github.com/GLIMS-RGI/rgi_user_guide/blob/main/CONTRIBUTING.md)  
 ```
 
 ## Contents

diff --git a/products/centerlines_product.html b/products/centerlines_product.html
@@ -461,7 +461,7 @@ <h2>Product files<a class="headerlink" href="#product-files" title="Permalink to
 </dd>
 <dt><code class="docutils literal notranslate"><span class="pre">outflow_id</span></code></dt><dd><p><code class="docutils literal notranslate"><span class="pre">long_name</span></code>: Outflow segment identifier <br/> <code class="docutils literal notranslate"><span class="pre">description</span></code>: Each secondary centerline flows into another centerline. This identifier points to the <code class="docutils literal notranslate"><span class="pre">segment_id</span></code> to which this centerline flows to. <br/> <code class="docutils literal notranslate"><span class="pre">datatype</span></code>: int <br/> <code class="docutils literal notranslate"><span class="pre">units</span></code>:  <br/> <code class="docutils literal notranslate"><span class="pre">source</span></code>: RGI</p>
 </dd>
-<dt><code class="docutils literal notranslate"><span class="pre">strahler_n</span></code></dt><dd><p><code class="docutils literal notranslate"><span class="pre">long_name</span></code>: Strahler number of this centerline. <br/> <code class="docutils literal notranslate"><span class="pre">description</span></code>: Strahler number (Hydrological order) of the centerline, from lowest (0, line without tributaries but with possible descendants) to highest (the main centerline). <br/> <code class="docutils literal notranslate"><span class="pre">datatype</span></code>: int <br/> <code class="docutils literal notranslate"><span class="pre">units</span></code>:  <br/> <code class="docutils literal notranslate"><span class="pre">source</span></code>: RGI</p>
+<dt><code class="docutils literal notranslate"><span class="pre">strahler_n</span></code></dt><dd><p><code class="docutils literal notranslate"><span class="pre">long_name</span></code>: Strahler number of this centerline. <br/> <code class="docutils literal notranslate"><span class="pre">description</span></code>: Strahler number (hydrological order) of the centerline, from lowest (1, line without tributaries but with possible descendants) to highest (the main centerline). <br/> <code class="docutils literal notranslate"><span class="pre">datatype</span></code>: int <br/> <code class="docutils literal notranslate"><span class="pre">units</span></code>:  <br/> <code class="docutils literal notranslate"><span class="pre">source</span></code>: RGI</p>
 </dd>
 <dt><code class="docutils literal notranslate"><span class="pre">length_m</span></code></dt><dd><p><code class="docutils literal notranslate"><span class="pre">long_name</span></code>: Centerline length <br/> <code class="docutils literal notranslate"><span class="pre">description</span></code>: Length of the centerline in meters. <br/> <code class="docutils literal notranslate"><span class="pre">datatype</span></code>: int <br/> <code class="docutils literal notranslate"><span class="pre">units</span></code>: m <br/> <code class="docutils literal notranslate"><span class="pre">source</span></code>: RGI</p>
 </dd>
@@ -474,7 +474,7 @@ <h2>Product files<a class="headerlink" href="#product-files" title="Permalink to
 <p>The centerlines and their attributes are computed by OGGM <span id="id4">[<a class="reference internal" href="../07_references.html#id62" title="Fabien Maussion, Anton Butenko, Nicolas Champollion, Matthias Dusch, Julia Eis, Kévin Fourteau, Philipp Gregor, Alexander H. Jarosch, Johannes Landmann, Felix Oesterle, Beatriz Recinos, Timo Rothenpieler, Anouk Vlug, Christian T. Wild, and Ben Marzeion. The Open Global Glacier Model (OGGM) v1.1. Geoscientific Model Development, 12(3):909–931, mar 2019. doi:10.5194/gmd-12-909-2019.">Maussion <em>et al.</em>, 2019</a>]</span>, which implements an algorithm described by <span id="id5">Kienholz <em>et al.</em> [<a class="reference internal" href="../07_references.html#id14" title="C. Kienholz, J. L. Rich, a. a. Arendt, and R. Hock. A new method for deriving glacier centerlines applied to glaciers in Alaska and northwest Canada. The Cryosphere, 8(2):503–519, mar 2014. doi:10.5194/tc-8-503-2014.">2014</a>]</span>. The implementation in OGGM follows closely the description by <span id="id6">Kienholz <em>et al.</em> [<a class="reference internal" href="../07_references.html#id14" title="C. Kienholz, J. L. Rich, a. a. Arendt, and R. Hock. A new method for deriving glacier centerlines applied to glaciers in Alaska and northwest Canada. The Cryosphere, 8(2):503–519, mar 2014. doi:10.5194/tc-8-503-2014.">2014</a>]</span>, but it is coded in a different framework and thus may lead to slightly different results (the OGGM implementation is coded entirely in python, while the original implementation relied on ArcGIS tools). Neither the original algorithm nor its implementation in OGGM are perfect, and it is likely that centerlines on individual glaciers would be drawn differently by a human or other algorithms. We note that we do not use any velocity product but rely purely on geometric and topographic considerations.</p>
 <section id="strahler-number">
 <h3>Strahler number<a class="headerlink" href="#strahler-number" title="Permalink to this headline">#</a></h3>
-<p>The Strahler number <code class="docutils literal notranslate"><span class="pre">strahler_n</span></code> is a measure of branching complexity defined by <span id="id7">[<a class="reference internal" href="../07_references.html#id70" title="Arthur N Strahler. Hypsometric (Area - Altitude) Analysis of Erosional Topography. Geological Society of America Bulletin, 63(11):1117–1142, 1952. doi:10.1130/0016-7606(1952)63[1117:HAAOET]2.0.CO;2.">Strahler, 1952</a>]</span> commonly used in hydrological applications. A Strahler number of 0 indicates a centerline without any tributaries. A Strahler number of 1 indicates a centerline with one or more upstream tributaries of the same order, i.e. each of them having a Strahler number of 0. If a centerline with a Strahler number of 1 meets a downglacier centerline, the latter is assigned a Strahler number of 2. This ordering is important for mass flow routing. Each centerline contains a reference to its descendant, and this reference might be used by models to transfer mass from the tributaries towards the main centerline. Note that in the original concept Strahler numbers start with 1 instead of 0.</p>
+<p>The Strahler number <code class="docutils literal notranslate"><span class="pre">strahler_n</span></code> is a measure of branching complexity defined by <span id="id7">[<a class="reference internal" href="../07_references.html#id70" title="Arthur N Strahler. Hypsometric (Area - Altitude) Analysis of Erosional Topography. Geological Society of America Bulletin, 63(11):1117–1142, 1952. doi:10.1130/0016-7606(1952)63[1117:HAAOET]2.0.CO;2.">Strahler, 1952</a>]</span> commonly used in hydrological applications. A Strahler number of 1 indicates a centerline without any tributaries. A Strahler number of 2 indicates a centerline with one or more upstream tributaries of the same order, i.e. each of them having a Strahler number of 1. If a centerline with a Strahler number of 2 meets a downglacier centerline, the latter is assigned a Strahler number of 3. This ordering is important for mass flow routing. Each centerline contains a reference to its descendant, and this reference might be used by models to transfer mass from the tributaries towards the main centerline.</p>
 </section>
 <section id="main-centerline">
 <h3>Main centerline<a class="headerlink" href="#main-centerline" title="Permalink to this headline">#</a></h3>

diff --git a/searchindex.js b/searchindex.js
diff --git a/welcome.html b/welcome.html
@@ -422,17 +422,14 @@ <h2> Contents </h2>
   <section class="tex2jax_ignore mathjax_ignore" id="welcome">
 <h1>Welcome<a class="headerlink" href="#welcome" title="Permalink to this headline">#</a></h1>
 <p>The Randolph Glacier Inventory (<a class="reference external" href="https://www.glims.org/RGI">RGI</a>) is a global inventory of glacier outlines including a set of attributes and other relevant auxiliary information. This user guide provides detailed documentation of the RGI version 7.0 but also includes general information on the RGI and its earlier versions.</p>
-<div class="admonition warning">
-<p class="admonition-title">Warning</p>
-<p><strong>This user guide is a work in progress and refers to the beta version of RGI 7.0.</strong></p>
-</div>
 <div class="admonition-data-download admonition">
 <p class="admonition-title">Data download</p>
-<p><a class="reference external" href="https://cluster.klima.uni-bremen.de/~fmaussion/misc/rgi7_data/l6_rgi7b2_zip">Download the RGI 7.0 beta version files</a>. For review only!</p>
+<p><strong>Download the RGI 7.0 files</strong>: <a class="reference external" href="https://doi.org/10.5067/f6jmovy5navz">https://doi.org/10.5067/f6jmovy5navz</a><br>
+Download previous RGI versions: <a class="reference external" href="https://www.glims.org/RGI">https://www.glims.org/RGI</a></p>
 </div>
-<div class="tip admonition">
-<p class="admonition-title">Contributing to this documentation</p>
-<p>If you wish to contribute to this documentation, visit <a class="reference external" href="https://github.com/GLIMS-RGI/rgi_user_guide/blob/main/CONTRIBUTING.md">CONTRIBUTING.md</a></p>
+<div class="warning admonition">
+<p class="admonition-title">Known issues in RGI 7.0</p>
+<p>Currently known issues with the RGI 7.0 dataset are listed here: <a class="github reference external" href="https://github.com/GLIMS-RGI/rgi_issue_tracker">GLIMS-RGI/rgi_issue_tracker</a>.<br>If you discover an issue with the RGI 7.0, please report it there!</p>
 </div>
 <section id="contents">
 <h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">#</a></h2>