.. toctree::

.. include:: RESOURCE.rst

.. _comand_ref:

=======================
Структура рабочего окна
=======================

На :numref:`(Рис. %s)<window_scheme_image>` представлена схема рабочего окна 
интерфейса для задания начальных данных расчетов, обработки и анализа результатов в части
геофильтрационных и геомиграционных задач (далее препостпроцессора). 


.. _window_scheme_image:
.. figure:: pictures\\npp\\screen_struct.png
    :align: center
    :scale: 100%
    
    Схема рабочего окна препостпроцессора
    
Рабочее окно препостпроцессора состоит из 
следующих структурных элементов:

  1. :ref:`Строка заголовка<head_main_ref>` 
  2. :ref:`Панель вкладок<tabbar_main_ref>` 
  3. :ref:`Лента<strip_main_ref>`  
  4. :ref:`Центральное окно<central_widget_main_ref>`  
  5. :ref:`Строка состояния<statusbar_main_ref>`    
     
     
.. _head_main_ref:
    
--------------------------
Строка заголовка
--------------------------

Строка заголовка расположена в верхней части рабочего окна препостпроцессора 
:numref:`(Рис. %s)<head_main_image>`.

.. _head_main_image:
.. figure:: pictures\\head_main.png
    :align: center
    :scale: 100%
    
    Строка заголовка
    
В правом углу строки заголовка расположены кнопки управления рабочим окном препостпроцессора: 
«Закрыть», «Свернуть в окно», «Свернуть». 
В левом углу расположены:

  * пиктограмма системной кнопки |nympha_systray|;
  * название программы: НИМФА;
  * имя проекта, если оно было задано;
  * расположение проекта на ПК.
  
..  * версия препостпроцессора;
..  * дата сборки версии;
..  * версия программного обеспечения, используемого для функционирования .. препостпроцессора: PyQT 5.5 и Python 3.4.4;
  
  

.. _tabbar_main_ref:
    
--------------------------
Панель вкладок
--------------------------

Под строкой заголовка расположена панель вкладок. 
На панели вкладок размещены элементы управления: команды и вкладки.  
Вид панели вкладок зависит от режима работы препостпроцессора. 

На :numref:`(Рис. %s)<tabbar_start_image>` представлен вид панели вкладок 
после запуска препостпроцессора. 
В :numref:`таблице %s<table_main_command>` 
приведено описание элементов управления панели вкладок.

.. _tabbar_start_image:
.. figure:: pictures\\npp\\tabbar_start.png
    :align: center
    :scale: 100%
    
    Вид панели вкладок после запуска препостпроцессора
    
    
.. _table_main_command:
.. table:: Элементы управления панели вкладок после запуска препостпроцессора

  +----------------+------------------------------------------------------------------------------+
  | **Элемент**    | **Описание**                                                                 |
  | **управления** |                                                                              |
  +----------------+------------------------------------------------------------------------------+ 
  | |new|          |  Создать новый гидрогеологический проект                                     | 
  +----------------+------------------------------------------------------------------------------+
  | |load|         |  Загрузить проект из файла :strong:`*.nmp`                                   |
  +----------------+------------------------------------------------------------------------------+
  | |load_bin|     |  Загрузить результаты расчета из файла :strong:`*.bin`                       |
  +----------------+------------------------------------------------------------------------------+
  | |calib_results||  Загрузить  :ref:`результаты калибровки<calibration_result>`                 |
  +----------------+------------------------------------------------------------------------------+                                                             
  | |settings|     |  Открыть :ref:`Диалог глобальных настроек проекта<global_settings>`          |
  +----------------+------------------------------------------------------------------------------+  
  | |about|        |  Открыть :ref:`Показать информацию о программе<inform_project_ref>`          |
  +----------------+------------------------------------------------------------------------------+ 
  | Файлы          |  Открыть :ref:`Экран «последних проектов»<recent_projects_ref>`              |
  +----------------+------------------------------------------------------------------------------+  
  | Помощь         |  Открыть :ref:`Руководство пользователя<user_help_ref>`                      |
  +----------------+------------------------------------------------------------------------------+          


На :numref:`(Рис. %s)<tabbar_nmp_image>` представлен вид панели вкладок, 
когда препостпроцессор работает в режиме подготовки (редактирования) моделей.
В :numref:`(таблице %s)<table_nmp_command>` 
приведено описание элементов управления панели вкладок.

.. _tabbar_nmp_image:
.. figure:: pictures\\npp\\tabbar_nmp.png
    :align: center
    :scale: 110%
    
    Вид панели вкладок в режиме подготовки (редактирования) моделей
    
    
.. _table_nmp_command:

.. table:: Элементы управления панели вкладок в режиме подготовки (редактирования) моделей
 
  +--------------------+----------------------------------------------------------------------------------+
  | **Элемент**        | **Описание**                                                                     |
  | **управления**     |                                                                                  |
  +--------------------+----------------------------------------------------------------------------------+
  | |save|             |  Сохранить модель (формат :strong:`*.nmp`)                                       |
  +--------------------+----------------------------------------------------------------------------------+
  | |save as|          |  Сохранить модель как (формат :strong:`*.nmp`)                                   | 
  +--------------------+----------------------------------------------------------------------------------+
  | |xml|              |  Сохранить вариант (формат :strong:`*.xml`)                                      |
  +--------------------+----------------------------------------------------------------------------------+
  | |xml as|           |  Сохранить вариант как (формат :strong:`*.xml`)                                  |
  +--------------------+----------------------------------------------------------------------------------+
  | |save all|         |  Сохранить модель и вариант                                                      |
  +--------------------+----------------------------------------------------------------------------------+
  | |close|            |  Закрыть  проект                                                                 |
  +--------------------+----------------------------------------------------------------------------------+
  | Параметры          |  Открыть  :ref:`Диалог управления параметрами модели<variant>`                   |
  | модели             |                                                                                  |
  +--------------------+----------------------------------------------------------------------------------+  
  | Породы             |  Открыть :ref:`Редактор пород<soil_editor>`                                      |
  +--------------------+----------------------------------------------------------------------------------+   
  | Геохимия           |  Открыть :ref:`Редактор геохимических зависимостей<geochemistry>`                |
  +--------------------+----------------------------------------------------------------------------------+   
  | Слои               |  Открыть :ref:`Редактор модельных слоев<reservoir_editor>`                       |
  +--------------------+----------------------------------------------------------------------------------+    
  | Сетка              |  Открыть                                                                         |
  |                    |  :ref:`Интегрированный диалог управления параметрами сетки<grid_params>`         |                                                                      
  +--------------------+----------------------------------------------------------------------------------+     
  | 3D модель          |  Открыть :ref:`3D редактор<solid_editor>`                                        |
  +--------------------+----------------------------------------------------------------------------------+    
  | Калибровка         |  Открыть :ref:`Модуль управления данными калибровки<calibration>`                |
  +--------------------+----------------------------------------------------------------------------------+ 

Если в препроцессоре были загружены результаты калибровки, 
то на панели вкладок появится вкладка **«Калибровка-результаты»**.
Данная вкладка осуществляет переход в 
:ref:`Модуль управления результатами калибровки<calibration_result>`.  

Когда препостпроцессор работает в режиме просмотра результатов расчета, 
вид панели вкладок зависит от того, что записано в базе данных результатов.
На :numref:`(Рис. %s)<tabbar_bin_image>` представлен вид панели вкладок 
в режиме работы постпроцессора. 
В :numref:`таблице %s<table_bin_command>` 
приведено описание всех возможных элементов управления панели вкладок.

.. _tabbar_bin_image:
.. figure:: pictures\\npp\\tabbar_bin.png
    :align: center
    :scale: 100%
    
    Вид панели вкладок в режиме просмотра результатов расчета
    
    
.. _table_bin_command:
.. table:: Элементы управления панели вкладок в режиме просмотра результатов расчета


  +--------------------+----------------------------------------------------------------------------------+
  | **Элемент**        | **Описание**                                                                     |
  | **управления**     |                                                                                  |
  +--------------------+----------------------------------------------------------------------------------+  
  | 3D визуализация    |  Открыть :ref:`3D данные<3dvis_ref>`                                             |
  +--------------------+----------------------------------------------------------------------------------+   
  | Изолинии           |  Открыть :ref:`2D данные<2dvis_ref>`                                             |
  +--------------------+----------------------------------------------------------------------------------+   
  | Наблюдательные     |  Открыть :ref:`Данные с наблюдательных скважин<observation_borehole_ref>`        |
  | скважины           |                                                                                  |  
  +--------------------+----------------------------------------------------------------------------------+    
  | Водный баланс      |  Открыть :ref:`Данные по водному балансу<water_budget_ref>`                      |                           
  +--------------------+----------------------------------------------------------------------------------+     
  | Массовый баланс    |  Открыть :ref:`Данные по массовому балансу<mass_budgets_ref>`                    |
  +--------------------+----------------------------------------------------------------------------------+    
  | Объекты водного    |  Открыть :ref:`Данные по объектам водного баланса<balance_zone_ref>`             |
  | баланса            |                                                                                  |  
  +--------------------+----------------------------------------------------------------------------------+  
  | Информация         |  Открыть :ref:`Информацию по модели<info_bin_ref>`                               |
  +--------------------+----------------------------------------------------------------------------------+      

.. _inform_project_ref:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Информация о программе
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^  
 
Отобразить информацию о программе, а также о её компонентах можно с помощью кнопки ленты |about|.
На :numref:`(Рис. %s)<info_project_image>` представлено окно «О программе» на вкладке «Общие сведения» с информацией
о названии, версии препостпроцессора, дате сборки, разработчике.

.. _info_project_image:
.. figure:: pictures\\npp\\common_info_nympha.png
    :align: center
    :scale: 100%
                
    Общие сведения о программе

В данном окне также присутствуют такие вкладки, как:

  * "Компоненты" - перечень расширений, используемых в программном комплексе;	
  * "Обратная связь с разработчиками". При возникновении вопроса/проблемы вы можете обратиться к специалистам по электронной почте (М.Л. Сидоров) **mlsidorov@vniief.ru** или по адресу **nympha@logos-hydrogeology.ru**. 	

.. _strip_main_ref:

--------------------
Лента
--------------------

Под панелью вкладок расположена лента. 
При выборе вкладки в ленте появляются команды, 
а также элементы управления для соответствующего модуля или диалога препостпроцессора.
Часть вкладок препостпроцессора не имеет ленты. Например, «Файлы», «Калибровка», «Помощь» и др. 
На :numref:`(Рис. %s)<strip_variant_image>` представлен вид ленты 
для вкладки «Параметры модели».
 
.. _strip_variant_image:
.. figure:: pictures\\variant\\strip_variant.png
    :align: center
    :scale: 100%
                
    Вид ленты для вкладки «Параметры модели» 

Подробное описание элементов управления ленты для каждой вкладки будет приведено 
в соответствующих разделах настоящего руководства.            



.. _central_widget_main_ref:
    
--------------------------
Центральное окно
--------------------------
    
При переключении вкладок на панели вкладок в центральном окне отображаются 
соответствующие модули и диалоги препостпроцессора.  
Подробное описание всех модулей и диалогов препостпроцессора приведено 
в соответствующих разделах настоящего руководства.

.. _recent_projects_ref:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Экран «последних проектов»
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

После запуска препостпроцессора в центральном окне отображается 
экран «последних проектов» (если они были открыты ранее).

.. _recent_projects_image:
.. figure:: pictures\\npp\\recent_projects.png
    :align: center
    :scale: 100%
    
    Экран «последних проектов»   

Экран «последних проектов» состоит из списка и таблицы «последних проектов». В списке приведены имена файлов. В таблице «последних проектов» представлены пиктограммы, на которых схематично нанесены основные особенности проекта. При наведении курсора мыши на пиктограмму появляется подсказка, в которой приведена некоторая справочная информация о проекте :numref:`(Рис. %s)<recent_project_tooltip_image>`.

.. _recent_project_tooltip_image:  
.. figure:: pictures\\npp\\recent_project_tooltip.png
    :align: center
    :scale: 100%
    
    Справочная информации о проекте
    
Чтобы открыть проект из экрана «последних проектов», нужно нажать на его пиктограмму или выбрать в списке левой кнопкой мыши.

Если один из проектов экрана «последних проектов» подсвечен красной рамкой :numref:`(Рис. %s)<recent_project_closer_image>`, это означает, что в настоящий момент он открыт в препостпроцессоре.    

.. _recent_project_closer_image:  
.. figure:: pictures\\npp\\recent_project_closer.png
    :align: center
    :scale: 100%
    
    Подсветка пиктограммы открытого проекта на экране «последних проектов»
 
 
В правом верхнем углу пиктограммы проекта расположены кнопки:

   * «...» - открыть в проводнике директорию, где расположен проект 
     (если он существует на жестком диске);
   * «X» - удалить проект из «последних проектов».

Очистить экран «последних проектов» можно с помощью следующих действий: 
«Контекстное меню» | «Очистить».


.. _navigation_widget_ref:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Навигатор
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

После создания (или загрузки из окна "последних проектов") модели или загрузки результатов расчета в центральном окне отображается навигатор. Он предназначен для быстрого перемещения по модулям и диалогам препостпроцессора.

.. _navigator_nmp_image:
.. figure:: pictures\\npp\\navigator_nmp.png
    :align: center
    :scale: 100%
    
    Навигатор препроцессора
    
    
.. _navigation_bin_image:
.. figure:: pictures\\npp\\navigator_bin.png
    :align: center
    :scale: 100%
    
    Навигатор постпроцессора
    
    
Навигатор состоит из пунктов и информационной части. 
Названия пунктов навигатора совпадают с названиями соответствующих вкладок 
на :ref:`панели вкладок<tabbar_main_ref>`. 
При наведении курсора мыши на пункт навигатора 
в информационной части отображается краткое описание возможностей соответствующего 
модуля или диалога препостпроцессора. 
Если какой-то из пунктов навигатора неактивен, например, пункт «Наблюдательные скважины» 
на :numref:`(Рис. %s)<navigation_bin_image>`, 
это означает, что таких данных нет в модели или в результатах расчета.

Навигатор отображается в центральном окне сразу после создания 
или загрузки модели или результатов расчета.  
Затем после выбора какого-либо пункта он исчезает. 
Чтобы снова открыть навигатор, нужно нажать клавишу «Esc». 
Для того, чтобы вернуться в модуль или диалог препостпроцессора, из которого был вызван 
навигатор, нужно нажать клавишу «Esc» повторно.


.. figure:: pictures\\npp\\navigator_when_escape_pressed.png
    :align: center
    :scale: 100%
    
    Навигатор препроцессора, вызванный нажатием клавиши «Escape»


.. _user_help_ref:
    
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Контекстная помощь
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

В препостпроцессоре всегда доступна вкладка «Помощь», которая содержит 
руководство пользователя в HMTL виде :numref:`(Рис. %s)<help_image>`. 
Пользователь может «вручную» искать в нем информацию или же 
воспользоваться системой контекстной помощи. 
Для этого нужно:

  1. навести курсор мыши на тот элемент препостпроцессора (диалоговое окно, команду и пр.), 
     описание которого необходимо найти;
  2. нажать клавишу «F1». Руководство пользователя откроется на той странице, 
     где приведено описание нужного элемента. 

Если снова нажать клавишу «F1», то откроется модуль или диалог препостпроцессора, 
из которого была вызвана контекстная помощь.

.. _help_image:
.. figure:: pictures\\help_form_nympha.png
    :align: center
    :scale: 100%
    
    Руководство пользователя, встроенное в препостпроцессор
    

.. _statusbar_main_ref:

--------------------------
Строка состояния
--------------------------

Под центральным окном препостпроцессора расположена строка состояния
:numref:`(Рис. %s)<statusbar_layer_image>`. 
Набор управляющих элементов строки состояния зависит от того, 
какой модуль или диалог препостпроцессора открыт. 
В общем случае строка состояния может отображать информационные сообщения, 
переключатели, поля отображения данных и пр. 
Подробное описание элементов управления строки состояния будет приведено 
в соответствующих разделах настоящего руководства пользователя.

.. _statusbar_layer_image:
.. figure:: pictures\\npp\\statusbar_layer.png
    :align: center
    :scale: 100%
    
    Строка состояния 

.. note:: Если информационные сообщения в строке состояния подсвечены красным, 
          это означает, что в настоящий момент препостпроцессор обрабатывает данные. 
          
