add docs

_sources/getting_started.rst.txt

@@ -1,2 +1,29 @@
 Getting started
 ===============
+
+If you haven't done so already, read :doc:`prerequisites` and follow the
+applicable steps.
+
+
+Processing the first waveform
+-----------------------------
+
+If you are new to swath processing, it may be informative to follow the
+tutorial on (processing and) viewing a single waveform. While this is
+not the kind of data that you will need to analyze a glaciers evolution,
+this is its foundation. Knowledge about the smallest parts of the data
+can help you understand the larger picture.
+
+Find the tutorial in ``scripts/tutorial__process_first_waveform.ipynb``.
+
+
+Processing the first track
+--------------------------
+
+Similar to viewing a single waveform, you might wonder how swath data of
+a single track look like. Again, a single track will not tell you much
+about a glacier's evolution, but it may help to understand higher level
+data.
+
+``scripts/tutorial__process_first_track.ipynb`` will give you a hand
+using cryoswath to process a single track and visualize the data.

_sources/index.rst.txt

@@ -10,7 +10,6 @@ Find the associated GitHub repository at https://github.com/j-haacker/cryoswath.
 To set up a working/testing environment, follow the steps discribed in :doc:`prerequisites`.
 See the quickstart guide in :doc:`Getting started <getting_started>`, if needed.
 
-
 .. toctree::
    :maxdepth: 1
    :caption: Contents:

cryoswath.misc.html

@@ -411,10 +411,10 @@
 <dl class="py function">
 <dt class="sig sig-object py" id="cryoswath.misc.load_basins">
 <span class="sig-prename descclassname"><span class="pre">cryoswath.misc.</span></span><span class="sig-name descname"><span class="pre">load_basins</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rgi_ids</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">GeoDataFrame</span></span></span><a class="reference external" href="https://github.com/j-haacker/cryoswath/blob/main/cryoswath/misc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cryoswath.misc.load_basins" title="Link to this definition"></a></dt>
-<dd><p>Loads RGI v7 basin or complex outlines and meta data</p>
+<dd><p>Loads RGI v7 basin ~or complex~ outlines and meta data</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>rgi_ids</strong> (<em>list</em><em>[</em><em>str</em><em>]</em>) – RGI basin ids.</p>
+<dd class="field-odd"><p><strong>rgi_ids</strong> (<em>list</em><em>[</em><em>str</em><em>]</em>) – RGI basin ids, all within the same RGI o1 region.</p>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
 <dd class="field-even"><p>Queried RGI data with geometry column containing

getting_started.html

@@ -47,7 +47,11 @@
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="prerequisites.html">Prerequisites</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Getting started</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Getting started</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#processing-the-first-waveform">Processing the first waveform</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#processing-the-first-track">Processing the first track</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
 <li class="toctree-l1"><a class="reference internal" href="tests.html">Tests</a></li>
 <li class="toctree-l1"><a class="reference internal" href="cryoswath.l1b.html">cryoswath.l1b module</a></li>
@@ -85,6 +89,26 @@
 
   <section id="getting-started">
 <h1>Getting started<a class="headerlink" href="#getting-started" title="Link to this heading"></a></h1>
+<p>If you haven’t done so already, read <a class="reference internal" href="prerequisites.html"><span class="doc">Prerequisites</span></a> and follow the
+applicable steps.</p>
+<section id="processing-the-first-waveform">
+<h2>Processing the first waveform<a class="headerlink" href="#processing-the-first-waveform" title="Link to this heading"></a></h2>
+<p>If you are new to swath processing, it may be informative to follow the
+tutorial on (processing and) viewing a single waveform. While this is
+not the kind of data that you will need to analyze a glaciers evolution,
+this is its foundation. Knowledge about the smallest parts of the data
+can help you understand the larger picture.</p>
+<p>Find the tutorial in <code class="docutils literal notranslate"><span class="pre">scripts/tutorial__process_first_waveform.ipynb</span></code>.</p>
+</section>
+<section id="processing-the-first-track">
+<h2>Processing the first track<a class="headerlink" href="#processing-the-first-track" title="Link to this heading"></a></h2>
+<p>Similar to viewing a single waveform, you might wonder how swath data of
+a single track look like. Again, a single track will not tell you much
+about a glacier’s evolution, but it may help to understand higher level
+data.</p>
+<p><code class="docutils literal notranslate"><span class="pre">scripts/tutorial__process_first_track.ipynb</span></code> will give you a hand
+using cryoswath to process a single track and visualize the data.</p>
+</section>
 </section>