Update docs info.

aerospaceresearch · Aug 19, 2019 · 1435456 · 1435456
1 parent 23e6289
commit 1435456
Show file tree

Hide file tree

Showing 8 changed files with 54 additions and 5 deletions.
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/tutorials.doctree b/docs/_build/doctrees/tutorials.doctree
diff --git a/docs/_build/html/_modules/directdemod/georeferencer.html b/docs/_build/html/_modules/directdemod/georeferencer.html
@@ -249,10 +249,6 @@ <h1>Source code for directdemod.georeferencer</h1><div class="highlight"><pre>
                   <span class="n">srcDSOrSrcDSTab</span><span class="o">=</span><span class="n">constants</span><span class="o">.</span><span class="n">TEMP_TIFF_FILE</span><span class="p">,</span>
                   <span class="n">options</span><span class="o">=</span><span class="n">options</span><span class="p">)</span>
 
-        <span class="c1"># save descriptor to new tif?</span>
-        <span class="c1"># with tifffile.TiffFile(output_file) as t:</span>
-        <span class="c1">#   t.imsave(output_file, image, description=JSON.stringify(descriptor))</span>
-
         <span class="n">os</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">constants</span><span class="o">.</span><span class="n">TEMP_TIFF_FILE</span><span class="p">)</span></div>
 
 <div class="viewcode-block" id="Georeferencer.georef_os"><a class="viewcode-back" href="../../visualization.html#directdemod.georeferencer.Georeferencer.georef_os">[docs]</a>    <span class="k">def</span> <span class="nf">georef_os</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">descriptor</span><span class="p">:</span> <span class="nb">dict</span><span class="p">,</span> <span class="n">output_file</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>

diff --git a/docs/_build/html/_sources/tutorials.rst.txt b/docs/_build/html/_sources/tutorials.rst.txt
@@ -135,6 +135,24 @@ To run `globe.html` go to tms directory and start the http server on port 8000 (
 
 Then open browser and go to `http://localhost:8000/globe.html`.
 
+Running server with timeline
+----------------------------
+
+To run a server with timeline on a local machine (Linux) please do the following tasks.
+Navigate to `directdemod/server/` and execute following commands.
+
+::
+
+   export FLASK_APP=web_server.py
+   flask run
+
+This will start a server at port 5000. Open the page in your browser
+`http://localhost:5000/map.html`. You can upload images via the `upload.html` page.
+To configure update interval please edit `conf.json` file `update_rate` parameter, set it in seconds
+and restart the server. The server contains two channels (left and right parts of NOAA image), you
+can toggle between them using toggle button in the left top corner, you can switch between images
+on the timeline using switcher widget in the bottom of the page.
+
 Help
 -----------------------
 

diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html
@@ -188,6 +188,7 @@ <h1>Welcome to DirectDemod’s documentation!<a class="headerlink" href="#welcom
 <li class="toctree-l2"><a class="reference internal" href="tutorials.html#map-overlay">Map Overlay</a></li>
 <li class="toctree-l2"><a class="reference internal" href="tutorials.html#merger">Merger</a></li>
 <li class="toctree-l2"><a class="reference internal" href="tutorials.html#map-generation-tutorial">Map generation tutorial</a></li>
+<li class="toctree-l2"><a class="reference internal" href="tutorials.html#running-server-with-timeline">Running server with timeline</a></li>
 <li class="toctree-l2"><a class="reference internal" href="tutorials.html#help">Help</a></li>
 </ul>
 </li>

diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js
diff --git a/docs/_build/html/tutorials.html b/docs/_build/html/tutorials.html
@@ -90,6 +90,7 @@
 <li class="toctree-l2"><a class="reference internal" href="#map-overlay">Map Overlay</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#merger">Merger</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#map-generation-tutorial">Map generation tutorial</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#running-server-with-timeline">Running server with timeline</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#help">Help</a></li>
 </ul>
 </li>
@@ -311,6 +312,21 @@ <h2>Map generation tutorial<a class="headerlink" href="#map-generation-tutorial"
 </div>
 <p>Then open browser and go to <cite>http://localhost:8000/globe.html</cite>.</p>
 </div>
+<div class="section" id="running-server-with-timeline">
+<h2>Running server with timeline<a class="headerlink" href="#running-server-with-timeline" title="Permalink to this headline">¶</a></h2>
+<p>To run a server with timeline on a local machine (Linux) please do the following tasks.
+Navigate to <cite>directdemod/server/</cite> and execute following commands.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">export</span> <span class="n">FLASK_APP</span><span class="o">=</span><span class="n">web_server</span><span class="o">.</span><span class="n">py</span>
+<span class="n">flask</span> <span class="n">run</span>
+</pre></div>
+</div>
+<p>This will start a server at port 5000. Open the page in your browser
+<cite>http://localhost:5000/map.html</cite>. You can upload images via the <cite>upload.html</cite> page.
+To configure update interval please edit <cite>conf.json</cite> file <cite>update_rate</cite> parameter, set it in seconds
+and restart the server. The server contains two channels (left and right parts of NOAA image), you
+can toggle between them using toggle button in the left top corner, you can switch between images
+on the timeline using switcher widget in the bottom of the page.</p>
+</div>
 <div class="section" id="help">
 <h2>Help<a class="headerlink" href="#help" title="Permalink to this headline">¶</a></h2>
 <p>If you encountered an error or want to add a fix, you can contact us directly on

diff --git a/docs/tutorials.rst b/docs/tutorials.rst
@@ -135,6 +135,24 @@ To run `globe.html` go to tms directory and start the http server on port 8000 (
 
 Then open browser and go to `http://localhost:8000/globe.html`.
 
+Running server with timeline
+----------------------------
+
+To run a server with timeline on a local machine (Linux) please do the following tasks.
+Navigate to `directdemod/server/` and execute following commands.
+
+::
+
+   export FLASK_APP=web_server.py
+   flask run
+
+This will start a server at port 5000. Open the page in your browser
+`http://localhost:5000/map.html`. You can upload images via the `upload.html` page.
+To configure update interval please edit `conf.json` file `update_rate` parameter, set it in seconds
+and restart the server. The server contains two channels (left and right parts of NOAA image), you
+can toggle between them using toggle button in the left top corner, you can switch between images
+on the timeline using switcher widget in the bottom of the page.
+
 Help
 -----------------------