placeholder for DeDop Studio manual

DeDop · Nov 8, 2017 · f93d03c · f93d03c
1 parent fa082b1
commit f93d03c
Show file tree

Hide file tree

Showing 6 changed files with 136 additions and 107 deletions.
diff --git a/docs/_static/README.rst → docs/_static/README b/docs/_static/README.rst → docs/_static/README
diff --git a/docs/conf.py b/docs/conf.py
@@ -44,7 +44,7 @@
     'sphinx.ext.intersphinx',
     'sphinx.ext.todo',
     'sphinx.ext.coverage',
-    'sphinx.ext.pngmath',
+    'sphinx.ext.imgmath',
     'sphinx.ext.ifconfig',
     'sphinx.ext.viewcode',
     'sphinxarg.ext',

diff --git a/docs/index.rst b/docs/index.rst
@@ -18,7 +18,8 @@ Contents:
    introduction
    quickstart
    installation
-   manual
+   manual_shell
+   manual_studio
    api_reference
 
 

diff --git a/docs/manual_bck.rst b/docs/manual_bck.rst
diff --git a/docs/manual.rst → docs/manual_shell.rst b/docs/manual.rst → docs/manual_shell.rst
@@ -1,9 +1,11 @@
-======
-Manual
-======
-
-The DeDop tool set currently comprises only the *DeDop Shell* - a command-line interface to the
-Delay Doppler Processor (DDP).
+======================
+Manual for 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`.
 
 
 .. _workspace_manag:

diff --git a/docs/manual_studio.rst b/docs/manual_studio.rst
@@ -0,0 +1,125 @@
+=======================
+Manual for DeDop Studio
+=======================
+
+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 Studio.
+For the manual of DeDop Shell go to :doc:`manual_shell`.
+
+
+.. _workspace_manag_studio:
+
+Workspace Management
+====================
+
+**Workspace** in DeDop Shell refers to a space in the file system in which all the requires parts for processing are located.
+They include source files, configurations, output files, as well as the Jupyter notebooks. It is possible to have multiple
+workspaces and by default they are located under ``$USER_DIR/.dedop/workspaces``.
+For example::
+
+   C:\\Users\\dummy_user\\.dedop\\workspaces  # Windows
+   /home/dummy_user/.dedop/workspaces         # Linux
+   /Users/dummy_user/.dedop/workspaces        # MacOS
+
+Add a new workspace
+--------------------
+
+
+Remove a workspace
+-------------------
+
+
+Copy a workspace
+-----------------
+
+
+Rename a workspace
+------------------
+
+
+Get current workspace
+----------------------
+
+
+List workspaces
+---------------
+
+
+.. _source_file_manag_studio:
+
+L1A Source File Management
+==========================
+
+
+Add new L1A source file
+------------------------
+
+
+Remove L1A source file
+-----------------------
+
+
+List all L1A source files
+--------------------------
+
+
+.. _config_manag_studio:
+
+Processor Configuration Management
+==================================
+
+
+Add a new configuration
+------------------------
+
+
+Remove a configuration
+-----------------------
+
+
+Modify a configuration
+-----------------------
+
+
+Copy a configuration
+---------------------
+
+
+Rename a configuration
+-----------------------
+
+
+Show configuration info
+------------------------
+
+
+Get current configuration
+--------------------------
+
+
+List configurations
+--------------------
+
+
+Upgrade configurations
+-----------------------
+
+
+Show configuration version
+---------------------------
+
+
+.. _run_proc_studio:
+
+Running the Processor
+=====================
+
+
+.. _analyse_l1b_studio:
+
+Analysing L1B Results
+=====================
+
+
+.. _tool_config_studio: