updated documentation

doc/source/conf.py

 # -*- coding: utf-8 -*-
 #
-# HUB TimeSeriesViewer documentation build configuration file, created by
+# EO TimeSeriesViewer documentation build configuration file, created by
 # sphinx-quickstart on Fri Jan 19 11:57:19 2018.
 #
 # This file is execfile()d with the current directory set to its
@@ -48,18 +48,22 @@ templates_path = ['_templates']
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
-source_suffix = ['.rst', '.md']
-#source_suffix = '.rst'
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
 source_parsers = {
    '.md': 'recommonmark.parser.CommonMarkParser',
 }
-# The master toctree document.
+
+source_suffix = ['.rst', '.md']
+
+
 master_doc = 'index'
 
 # General information about the project.
-project = u'HUB TimeSeriesViewer'
-copyright = u'2018, Benjamin Jakimow, Sebastian van der Linden, Patrick Hostert'
-author = u'Benjamin Jakimow'
+project = 'EO Time Series Viewer'
+copyright = '2018, Benjamin Jakimow, Sebastian van der Linden, Fabian Thiel, Patrick Hostert'
+author = 'Benjamin Jakimow, Fabian Thiel'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -148,7 +152,7 @@ html_sidebars = {
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'HUBTimeSeriesViewerDoc'
+htmlhelp_basename = 'EOTimeSeriesViewerDoc'
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -175,8 +179,8 @@ latex_elements = {
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'HUBTimeSeriesViewer.tex', u'HUB TimeSeriesViewer Documentation',
-     u'Benjamin Jakimow', 'manual'),
+    (master_doc, 'EOTimeSeriesViewer.tex', 'EO Time Series Viewer Documentation',
+     'Benjamin Jakimow', 'manual'),
 ]
 
 
@@ -185,7 +189,7 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'hubtimeseriesviewer', u'HUB TimeSeriesViewer Documentation',
+    (master_doc, 'eotimeseriesviewer', u'EO Time Series Viewer Documentation',
      [author], 1)
 ]
 
@@ -196,8 +200,8 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'HUBTimeSeriesViewer', u'HUB TimeSeriesViewer Documentation',
-     author, 'HUBTimeSeriesViewer', 'One line description of project.',
+    (master_doc, 'EOTimeSeriesViewer', u'EO Time Series Viewer Documentation',
+     author, 'EOTimeSeriesViewer', 'One line description of project.',
      'Miscellaneous'),
 ]
 
@@ -206,5 +210,5 @@ texinfo_documents = [
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {'https://docs.python.org/': None,
-                       'python':('https://docs.python.org/2.7', None),
+                       'python':('https://docs.python.org/3.6', None),
                        'http://www.pyqtgraph.org/documentation':None}

doc/source/index.rst

@@ -4,18 +4,18 @@
    contain the root `toctree` directive.
 
 ======================
-HUB Time Series Viewer
+EO Time Series Viewer
 ======================
 
-**Welcome to the HUB Time Series Viewer Documentation!**
+**Welcome to the EO Time Series Viewer Documentation!**
 
 
-.. seealso:: `EnMAP Box 3 <https://bitbucket.org/hu-geomatics/enmap-box/wiki/Home>`_ - Another QGIS Plugin developed at HUB
+.. seealso:: `EnMAP Box 3 <https://bitbucket.org/hu-geomatics/enmap-box/wiki/Home>`_ - Another QGIS Plugin developed at Humboldt-Universität zu Berlin
 
 About
 -----
 
-The Humboldt-Universität zu Berlin (HUB) Time Series Viewer (TSV) is a QGIS Plugin to visualize raster based earth observation time series data.
+The Earth Observation (EO) Time Series Viewer is a QGIS Plugin to visualize raster based earth observation time series data.
 
 Its major aims are:
 
@@ -75,6 +75,6 @@ This program is free software; you can redistribute it and/or modify it under th
 Indices and tables
 ==================
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+    * :ref:`genindex`
+    * :ref:`modindex`
+    * :ref:`search`

doc/source/installation.rst

 
+.. |icon| image:: img/logo.png
+   :width: 30px
+   :height: 30px
+
+
 ============
 Installation
 ============
 
 
-.. warning:: Time Series Viewer requires QGIS Version 2.18.xx
+.. warning:: EO Time Series Viewer requires QGIS Version 3.0 +
 
 .. note:: If you have not installed QGIS yet, you can get it `here <https://www.qgis.org/en/site/forusers/download.html>`_.
 
@@ -15,30 +20,16 @@ Windows
 
 .. tip:: On windows we recommend to use the **OSGeo4W Network Installer**!
 
-Standard QGIS Plugin Installation
+Standard QGIS 3 Plugin Installation
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-1. Download the most recent zip archive of the HUB TimeSeriesViewer QGIS Plugin from https://bitbucket.org/jakimowb/hub-timeseriesviewer/downloads
-2. Extract the ``timeseriesviewerplugin`` folder and copy it to the user' QGIS python plugin directory ``~/.qgis2/python/plugins/timeseriesviewerplugin``
-
-    Alternatively, you can choose any other folder ``my/qgis/plugins/timeseriesviewerplugin`` if you ensure that it is known to the QGIS_PLUGINPATH:
-
-    * In QGIS, go to :menuselection:`Settings --> Options --> System`.
-    * Enable the Environment group box.
-    * Create a new entry that append ``my/qgis/plugins`` to the variable ``QGIS_PLUGINPATH``.
+1. Download the most recent zip archive of the EO Time Series Viewer QGIS Plugin from https://bitbucket.org/jakimowb/eo-time-series-viewer/downloads
 
-3. The TimeSeriesViewer requires `pyqtgraph <http://pyqtgraph.org/>`_. It's best to install it via the **OSGeo4W Shell**. Open it and type::
+2. Start QGIS 3 and open *Plugins* > *Manage and Install Plugins* > *Install from ZIP*.
 
-        pip install pyqtgraph
-4. Finally restart QGIS, go to :menuselection:`Plugins --> Manage and Install Plugins` and enable the HUB-TimeSeriesViewer.
+3. Select the downloaded *timeseriesviewerplugin.0.5.YYYYMMDDTHHMM.QGIS3.zip* and start *Install plugin*.
 
-.. image:: img/settings_plugin_enable.png
-    :width: 80%
-    :align: center
-
-5. You can now access the Plugin via the |icon| button in your QGIS Toolbar or via the dropdown menu: :menuselection:`Raster --> HUB TimeSeriesViewer`
-
-.. |icon| image:: img/icons/icon.svg
+4. Start the EO Time Series Viewer via the |icon| icon. In case of missing requirements you should see an error message. Please install the requested packages.
 
 Developers
 ~~~~~~~~~~
@@ -60,21 +51,5 @@ Larger binary files, e.g. for exemplary data, are distributed via the Git Large
         git checkout development
         git lfs checkout
 
-3. Start QGIS, go to :menuselection:`Plugins --> Manage and Install Plugins` and enable the "HUB TimeSeriesViewer" Plugin.
-4. Download updates if available::
-
-        cd %USERPROFILE%\.qgis2\python\plugins\hub-timeseriesviewer
-        git pull
-
-Linux
------
-
-tbd
-
-Mac
----
-
-tbd
-
-
 
+.. todo:: add detailed description hot to setup an IDE to run the EO Time Series Viewer without QGIS
\ No newline at end of file

doc/source/requirements.txt

@@ -3,4 +3,5 @@
 
 ###### Requirements to build documentation with sphinx ######
 sphinx>=1.7.2
-sphinx_rtd_theme>=0.3.0
\ No newline at end of file
+sphinx_rtd_theme>=0.3.0
+recommonmark
\ No newline at end of file

doc/source/user_guide.rst

@@ -7,7 +7,7 @@ The Interface
 
 .. figure:: img/interface.png
 
-    This is what the Time Series Viewer's interface looks like when opening it.
+    This is what the EO Time Series Viewer's interface looks like when opening it.
 
 .. note:: Just like in QGIS, many parts of the GUI are adjustable panels. Therefore you can arrange them either tabbed or in separate windows.
           Activate/Deactivate panels under :menuselection:`View --> Panels`
@@ -92,18 +92,26 @@ Now, for every Map View you can alter the following settings:
 .. image:: img/mapviewsettings.png
 
 * *Hide/Unhide* the Map View via the |hidemapview| :superscript:`Toggle visibility of this map view` button.
+
 * *Activate/Deactivate Crosshair* via the |crosshair| :superscript:`Show/hide a crosshair` button. Press the arrow button next to it to enter
   the *Crosshair specifications* |symbology| , where you can customize e.g. color, opacity, thickness, size and further options.
+
 * You may rename the Map View by altering the text in the ``Name`` field.
+
 * **Vector Rendering** allows you to visualize vector data (e.g. a shapefile). In order to do so, open the file in QGIS. Once loaded in the QGIS Layers Panel, it will become selectable
   in the dropdown menu. Vector styling will be same as in QGIS (i.e. if you want to adjust it, do it in QGIS). Check |cbc| or uncheck |cbu| in order to activate/deactivate Vector Rendering.
+
 * Under **Raster Rendering** you can adjust the visualisation of the raster layers. Every sensor, as specified in the :ref:`Sensors / Products` tab, has its separate
   rendering option section (since band specifications differ among sensors). The handling is very similar to the QGIS style options.
+
         * Multiband (RGB) as well as singleband rendering is supported. Select the desired mode in the dropdown menu.
+
         * Select the desired band(s) for display using the slider. In the dropdown menu at the bottom you can specify the contrast enhancement to be used for the value stretch.
           In case TSV has sufficient wavelength information for the bands, you can choose several presets: *True* (True Color; red-green-blue),
           *CIR1* (colored infrared; swir-red-green) and *CIR2* (colored infrared; swIR-mwIR-red)
+
         * You can copy and paste styles using the |copy| :superscript:`Copy style to clipboard` and |paste| :superscript:`Paste style from clipboard` buttons (also between QGIS and TSV)
+
         * Once you specified your rendering settings, press |refresh| to apply them.