[[PageOutline(2-5,Contents,pullout)]]

= Welcome to Ocean Visuals Documentation =

This documentation will give an overview of OV's main user interface, its
concepts and features; of the onboard installation and its administration.

== Terminology ==

  * AIS - [https://en.wikipedia.org/wiki/Automatic_Identification_System Automatic Identification System]
    is used to provide information of nearby (to an Observer) vessel information 
  * Device - a device represents a physicial grouping of Observation Types e.g. a LIDAR
    which measures: oil pollution, CDOM, water transparency etc.
  * Incident - a collection of Observations where a specified Observation Type is
    out of the normal range(s) for that specified Observation Type
  * Observation - a group of measurements for one or several Observation Types
    at a specific time and location (latitude, longitude)
  * Observation Type - a single measurable entity - an instrument / a sensor -
    providing a scalar value e.g. temperature, oil pollution, water transparency etc.
  * Observer - a vessel or a stationary platform carrying one or several Devices for Observation gathering.

== Web UI ==

At the highest level the Web UI functionality at https://web.oceanavisuals.no is
divided into 2 groups: anonymous users, public data; authenticated users, enhanced data.

Anonymous users have access to the [#live-view public data] and the aggregated
[#stats-view statistics] of that data.

Authenticated users have access to additional information regarding:
  * Private Observers and their Observations
  * Maps with an AIS Layer
  * Detailed Incident Reports with AIS history
  * Device monitoring and management
  * [wiki:OnboardAdministration Onboard Administration]

=== Live View === #live-view
By default when opening the Web UI the //Live// view is selected. The main
purpose of the //Live// view is to present a quick high-level overview of
various Observation points and Observer positions.

The major UI components in the //Live// view, annotated in [#fig1-1 figure 1.1] are:
  1. Observation Type and Observers selection
  2. Observer tracking
  3. Latest Data panel
  4. Plot
  5. Map
  
==== 1. Observation Type and Observers Selection
The selected Observer Type in conjunction with the authentication state will
determine which Observers are accessible - that is will provide data - and visible
in the Observers selection and on the Map.

When opened the Observers selection provides information on:
  * accessible Observers
  * last contact from an Observer - if latest contact (ping) is more than
    1 minute ago a specific time-stamp is shown instead of a short //OK//

Clicking on an Observer in the list will focus and zoom in the Map on
the latest Observer position as shown in [#fig1-1 figure 1.2].

The latest Observer position is either the latest Observation position or the
latest AIS position, whichever has the newer time-stamp.

==== 2. Observer Tracking
Enabling tracking for an Observer will focus and zoom in the Map on the
selected Observer's latest position. The map will continuously update itself and
"follow" the Observer's latest positions automatically on each successive position
update, as shown in [#fig1-3 figure 1.3].

==== 3. Latest Data Panel
The Latest Data Panel samples the latest Observations of all available Observation
Types over all the available Observers and automatically updates itself as the
Observations are coming in.

==== 4. Plot
Similarly to the Latest Data Panel the Plot aggregates Observations over all
available Observers and their Observations.

==== 5. Map
The Map reacts to user input from the Observation Type and Observers selection
and can be navigated independently by utilizing the mouse for dragging and zooming.
Explicit buttons for controlling zooming are located in the left upper corner of
the Map.

==== Figure 1.1 - Live view #fig1-1

[[Image(ov-live-view.png)]]

==== Figure 1.2 - clicking on an Observer #fig1-2

[[Image(ov-live-view-vessel-click.png)]]

==== Figure 1.3 - Observer tracking #fig1-3

[[Image(ov-live-view-tracking.png)]]

=== Statistics View === #stats-view

== Onboard Administration ==

The Onboard installation combines the main Onboard applications for logging
and uploading data to Onshore at https://web.oceanvisuals.no with a standalone
(locally deployed) version of Onshore services that enable to (re)use the same
web based user interface (Web UI) from https://web.oceanvisuals.no in offline mode.

The official operating system for the Onboard installation is [http://lubuntu.net/ Lubuntu 16.04 LTS].
The documentation for Lubuntu can be found at https://help.ubuntu.com/community/Lubuntu/Documentation  

=== Install Locations