dedop studio manual

docs/index.rst

@@ -17,9 +17,7 @@ Contents:
 
    introduction
    quickstart
-   installation
-   manual_shell
-   manual_studio
+   user_manual
    api_reference
 
 

docs/user_manual.rst

@@ -0,0 +1,12 @@
+===========
+User Manual
+===========
+
+.. toctree::
+   :maxdepth: 1
+
+   user_manual/um_setup
+   user_manual/um_shell
+   user_manual/um_studio
+
+

docs/user_manual/um_setup.rst

@@ -0,0 +1,52 @@
+======
+Setup
+======
+
+Installation
+=============
+
+From Binaries
+--------------
+
+DeDop is distributed as pre-compiled binaries which can be retrieved from `here <https://github.com/DeDop/dedop/releases/tag/v0.5.3>`_.
+For the windows Windows platforms there is a dedicated installer executable. For Mac OS and Unixes a ZIP file is provided.
+All platform distributions have a bundled Python interpreter, that's also the reason why they are quite large in size
+(roughly 300 megabytes).
+
+After installing (on Windows) / unpacking (on Unixes) you find an executable file named `dedop-shell` in the
+installation's root directory. Running it brings up the *DeDop Shell*.
+
+From Source
+------------
+
+DeDop is programmed in Python so you first need to setup a suitable Python environment.
+We recommend using a `Miniconda <http://conda.pydata.org/miniconda.html>`_ Python3 environment, so
+you don't need to install the DeDop library dependencies in your default Python.
+
+After installing Miniconda open a terminal window and create an isolated Python environment and *activate* it. Type::
+
+    conda create -n dedop python=3.5
+    source activate dedop
+
+
+Then install the DeDop library requirements::
+
+    conda install numpy scipy netcdf4 numexpr pyproj
+
+If you like to perform analysis tasks with DeDop, then also install::
+
+    conda install matplotlib bokeh jupyter ipywidgets
+
+Then checkout the DeDop source code from GitHub::
+
+    git clone https://github.com/DeDop/dedop-core.git
+
+Step into the newly created source directory and install DeDop in the Python environment `dedop`::
+
+    cd dedop-core
+    python setup.py develop
+
+After installing from source, you should be able to run the DeDop Shell, try::
+
+    dedop --help
+

docs/manual_shell.rst → docs/user_manual/um_shell.rst

@@ -1,11 +1,11 @@
-======================
-Manual for DeDop Shell
-======================
+============
+DeDop Shell
+============
 
 The DeDop tool set currently comprises the *DeDop Shell* - a command-line interface to the
 Delay Doppler Processor (DDP) - and *DeDop Studio* - a graphical user interface to the
 Delay Doppler Processor (DDP). In this section, you will find the manual for DeDop Shell.
-For the manual of DeDop Studio go to :doc:`manual_studio`.
+For the manual of DeDop Studio go to :doc:`um_studio`.
 
 
 .. _workspace_manag:

docs/user_manual/um_studio.rst

@@ -0,0 +1,122 @@
+=============
+DeDop Studio
+=============
+
+DeDop Studio is a desktop application with a primary aim of providing a user-friendly experience for processing L1A files.
+It was designed based on the already-existing DeDop Shell, so the behavior is almost the same with its command line counterpart.
+
+.. figure:: ../_static/figures/dedop-studio.png
+   :scale: 75%
+   :align: center
+
+DeDop Studio was designed at a window size of 1366 x 768, which is at the moment the most common laptop screen resolution.
+This means that all the component placements were decided based on what looks best at 1366 x 768 resolution. However,
+using other window sizes should not affect your experience greatly.
+
+The image above shows the first screen of DeDop Studio. At the top there is a screen title that will be updated once the
+user navigates to another screen. On the right side of this top section, there is a section for **Workspace management**.
+This is the area where user can perform workspace-related operations, such as adding, removing, copying, renaming, changing,
+and deleting a workspace. Right under the screen title, there are breadcrumbs showing the available four screens of this
+application. They also correspond to the four icons that are lined up vertically on the left side of the screen. These
+components act as the **navigator** of the application, to give the user an idea on where he/she is in the application,
+and also in the workflow. Both the workspace management and the navigator are components that are static, which means they
+will be visible on all the screens. **Functionality panels**, on the other hand, is the main area of the application where
+users can interact and it will change depending on which screen is selected.
+
+.. _workspace_manag_studio:
+
+Workspace Management
+====================
+
+.. figure:: ../_static/figures/dedop-studio-workspace_manag.png
+   :scale: 75%
+   :align: center
+
+Clicking the blue Workspace button at the top right will display a workspace management popover menu. With this menu, one
+can perform workspace-related operations. Under this button, the current workspace name is displayed. For example, from
+the image above, we can see that the current workspace is **default**.
+
+What happened behind the scene when any workspace-related operations (in fact, most of the operations) are triggered at
+DeDop Studio is that it makes some modifications on ``.dedop`` directory, as the case in DeDop Shell.
+
+.. _source_file_manag_studio:
+
+L1A Source File Management
+==========================
+
+.. figure:: ../_static/figures/dedop-studio-source_data.png
+   :scale: 75%
+   :align: center
+
+On the **Source Data** screen, there are three panels: L1A Datasets, Global Attributes, and Footprints. In **L1A Datasets**
+panel, initially users can add an L1A file into the current workspace. Clicking the ``Add Files`` button will open
+a file selector window, using which the user can select a single file from the file system. When the adding process is
+finished, the newly-added file, together with all previously-added files, will be displayed as a list. When a single file
+is clicked, the **Global Attributes** panel will display the global attributes of the netCDF file. At the same time,
+**Footprints** panel will display the footprints of the selected netCDF file in a Cesium globe. Note that this display on
+the globe is only possible when the source file is a conformant L1A data.
+
+One more thing that happens when a file is selected is that, DeDop Studio stores this information and this will be selected
+as the default file (although still changeable) when a process is about to be started. This is explained in more detail in
+:ref:`Processing Screen <run_proc_studio>`.
+
+
+.. _config_manag_studio:
+
+Processor Configuration Management
+==================================
+
+.. figure:: ../_static/figures/dedop-studio-configuration.png
+   :scale: 75%
+   :align: center
+
+There are two panels in **Configuration** screen: Configuration Names and Configuration Details. In
+**Configuration Names** panel, users can do configuration-related operations such as add, copy, rename, remove, or change
+the current configuration. Single-clicking a configuration name on the list will display the contents of that particular
+configuration on **Configuration Details** panel. To select a configuration as the current configuration, double-click it.
+Another way is to select it from the drop-down list in **Run Settings** panel inside
+:ref:`Processing Screen <run_proc_studio>`.
+
+In **Configuration Details** panel, users can modify the configuration files in two ways: using HTML components or using
+code editor. In HTML mode, configuration items are listed in a form appearance either as a label-texinput (when the
+expected value is of type number or string) or a checkbox (when the expected value is of type boolean). When the code editor
+mode is active (by activating ``Code editor`` toggle at the top), a JSON code editor will appear. Here, users can
+modify the values of the configurations in JSON format.
+
+In both modes, as soon as a value has been changed, the ``Save Configuration`` button is enabled. Click this button if
+the change(s) is to be made, otherwise this change(s) will not be reflected on the actual configuration files.
+
+By default (in DeDop Studio v1.2.0), the modification of ``Characterization`` and ``Constants`` configurations are disabled.
+You will notice that under these tabs, the HTML elements are disabled and the Code Editor is read-only.
+
+.. _run_proc_studio:
+
+Running the Processor
+=====================
+
+.. figure:: ../_static/figures/dedop-studio-processing.png
+   :scale: 75%
+   :align: center
+
+There are 4 panels under **Processing** screens: L1A Input, Run Settings, L1B & L1BS Output Directory, and Processor Runs.
+The first two panels form a summary on which L1A dataset and which configuration the users have chosen on **Source Data**
+and **Configuration** screens, respectively. A small note on **L1A Input** panel: at the moment only processing of single
+files are available. In **L1B & L1BS Output Directory**, users can select another output directory for the product results.
+
+To initiate a processing, click ``Run`` button inside **Processor Runs** panel. DeDop Studio will check whether all the
+required parameters (input file, configuration, and output directory) have been selected. When any of them are missing,
+a dialog box will pop up with the information on which field you have to fill up. Otherwise, the processing will be started,
+marked by a new entry on the table. You can monitor the progress of the processing and at the moment, because the tool is
+capable only running one process at a time, the ``Run`` button is blocked as long as a process is running.
+
+
+.. _analyse_l1b_studio:
+
+Analysing L1B Results
+=====================
+
+.. figure:: ../_static/figures/dedop-studio-result_analysis.png
+   :scale: 75%
+   :align: center
+
+