Preface

Copyright

This document refers to a plugin of MOHID Studio, priority software protected by copyright. All rights are reserved. Copying or other reproduction of this manual, or related documents, is prohibited without prior written consent of Action Modulers, Consultores de Segurança (Action Modulers).

MOHID Water Modelling System is priority software of the Technical University of Lisbon.

Warranty

The warranty given by Action Modulers is limited as specified in your Software License Agreement. Please note that numerical modelling software programs are very complex system and may not be free of errors, so you are advised to validate your work. Action Modulers shall not be responsible for any damage arising out of the use of this document, MOHID Studio, MOHID Water Modelling System or any related program or document.

Further Information

For further information about MOHID Studio please contact:

Action Modulers - Consulting & Technology

Estrada Principal, nº29 - Paz

2640-583 Mafra, Portugal

Tel.: +351 261 813 660

Fax: +351 261 813 666

E-mail: geral@actionmodulers.pt

Web: http://www.actionmodulers.com


Introduction

System Requirements

This document explains how to install MOHID Studio step-by-step. Before start with the installation the user should ensure that all the system requires are fulfilled (check requirements on the Table 1).

Component Requirements
Operating System Windows 7, 8, Server or later
Processor 1.8 GHz or faster processor
Memory 2GB of RAM
Disk Space[1] 500 MB
Display Resolution 1280x1024 or higher resolution
Display Colour Depth 32 bits
Additional Software Micrososf.NET Framework 4.0
Microsoft Excel 2007 or later</font>

Table 1 : System Minimum Requirements.

MOHID Studio requires the .NET Framework 4.0, full version, to be installed on your system[2].

To export values from MOHID Studio to XLS data sheet file a version of Microsoft Excel 2007 (or later) is required. The version recommended is Microsoft Excel 2010, though MOHID Studio also imports values from Microsoft Excel 97-2003.


MOHID Studio

Install MOHID Studio

Follow the Install Instructions for MOHID Studio

Load Layers

To load special layers from ARCOPOL+ project, press the button "Objects" in the group "Manage Layers" from the map tab menu (represented in Figure 1). A new window will appear, as represented in Figure 2. In this window the user should select the layers that wish to load into MOHID Studio map.

Coastal Risk - Instalation and User Guide 08.png
Figure 1 : Load layers button.
Coastal Risk - Instalation and User Guide 09.png
Figure 2 : Load layers window.

After the user select the desired layers, the user can set the visibility of the layer on the Layers menu, next to map (represented in Figure 3). The user can query the objects to see their properties. For more information, please read the MOHID Studio User Guide.

Coastal Risk - Instalation and User Guide 10.png
Figure 3 : Map: Loaded layers.

Action Server

Install Action Server

Follow the Install Instructions for Action Server

Configuration

After the Action Server is installed is necessary to configure the service. Go to "Services" (Services.msc) and select the "Action Server" service, as represented in Figure 1. Press the right button of the mouse above selected line and then select the "Properties" option. A new window will appear (represented in Figure 2).

Coastal Risk - Instalation and User Guide 17.png
Figure 1 : Action Server configuration: step 1.

In the "General" tab change the startup type to "Automatic (Delayed Start)", as represented in Figure 2.

Coastal Risk - Instalation and User Guide 18.png
Figure 2 : Action Server configuration: step 2.

In the "Recovery" tab change the first failure, second failure and subsequent failures to "Restart the Service", as represented in Figure 3.

Coastal Risk - Instalation and User Guide 19.png
Figure 3 : Action Server configuration: step 3.

The Action Service is now ready to run. Before press the start service button, check if all the plugins configurations are correct.

Plugins Configuration

The Action Server Configuration Files are located in the folder:

C:\ProgramData\Action Modulers\Action.Server\

Plugin: Coastal Risk Calculator

The configuration for the plugin Coastal Risk Calculator can be changed on the file "CoastalRisk.config" on the configuration folder. In this file is possible to change the determine risk schedule and all the parameters used for the risk determination. The begging of the "CoastalRisk.config" is represented in Figure 7.

Coastal Risk - Instalation and User Guide 20.png
Figure 7 : Block of Configuration from file CoastalRisk.config.

Risk Calculation Cron Expression – Schedule to determine the coastal risk. The Coastal Risk calculation include: the vessel risk, the coastal risk without Lagrangian model and with Lagrangian model (optional).

Vessel Back Window Minutes – This is the interval of vessel positions that will be used. The default value is 30 minutes. This meaning that if you determine the coastal risk at 9h00m, all the vessels position between 8h30m and 9h30m will be consider. The position that is used is the position that has the time closer to the coastal risk determination time. For example, id a vessel has positions at: 8h32m, 8h47m, 9h02m, 9h17m, the position that will be used is the 9h02m. In the service mode, the coastal risk only gets positions from the past, because it is a real time service. In this case, the position used would be the 8h47m. [See more information about this in the subsection about Risk on Demand – subsection 5.5].

The rest of the properties from the Coastal Risk configuration are described in subsection 5.5.1. All the configurations are similar, but here are defined in a file. The user can set all the definition through the Risk on Demand window and then save them into a file and replace with this one. This allows an easier way ,through the User Interface, to configure this file for the first time. For more information read the subsection 5.5.

Plugin: Maretec Data Downloader

The configuration for the plugin Maretec Data Downloader can be changed on the file "MaretecDataDownloader.config" on the configuration folder. In this file is possible to change the download schedule and all the credentials for FTP access. Inside the configuration file there is one or more blocks like the one represented in Figure 8.

Coastal Risk - Instalation and User Guide 21 2.png
Figure 8 : Block of Configuration from file MaratecDataDownloader.config.

This block (from Figure 8) represents one file to download and can be repeated for each block. The model domain needs to be defined (in this project there are 3 model domains: MM5, MOHID, WW3). If the property "Download Results" is set to false, the file will not be downloaded. The results from file, after successfully downloaded can be added to database (if the property "Insert Into Database" is set to true) and extracted to time series (if the property "Extract Time Series" is set to true).

The Storage Directory is the folder where all the files will be storage after downloaded.

The properties relative to FTP should be filled with the FTP access, credentials and preferences (Passive mode, time out, proxy…).

The option to "Get the most recent file from FTP", if is set to true, checks if the file from FTP is newer than the file that was already downloaded (for the same model domain and for the same period of time). If the new file is downloaded, the data from the previous download will be replaced by this one. This allows the user to have always the most recent data file from the FTP.

The last property, "FTP minimum download file size without error", indicates the minimal acceptable size (in bytes) of the file for this model domain. This is simple error validation. If the file size is below of this value, the file will be deleted and will be downloaded on the next time.

Plugin: Vessel Position Tracker

The configuration for the plugin Vessel Poition Tracker can be changed on the file "Vessel.config" on the configuration folder. In this file is possible to change the download schedule and all the credentials for FTP access. Inside the configuration file there is one or more blocks like the one represented in Figure 9.

Coastal Risk - Instalation and User Guide 22.png
Figure 9 : Block of Configuration from file Vessel.config.

Vessel Download Cron Expression – Schedule to download the KMZ file (with vessel positions) from marine traffic.

Vessel Position Update Interval – Number of minutes between the update positions of the same vessel. Example:

download file1: 9h00m (saved in database)

download file2: 9h03m (not saved in database)

download file3: 9h06m (not saved in database)

download file4: 9h09m (not saved in database)

download file5: 9h12m (not saved in database)

download file7: 9h15m (saved in database)

download file8: 9h18m (not saved in database)

Only the file1 and file7 will be saved in database. Sometimes the vessel position is missing in one file. If the file1 contain the vessel position and if the file7 does not contain the position for this vessel, the vessel will be updated on the next time, file 8. Than wait another 15 minutes.

Thread Sleep Time After Download Request – Number of milliseconds to wait before require for more information from marine traffic website.

Thread Sleep Time After Download Request – Number of milliseconds to wait before require for more information from marine traffic website.

Vessel Properties Update Interval – Number of minutes between vessel properties update. After the vessel is saved into the database, the vessel properties (name, flag…) will be updated in time to time.

Link To Download KMZ File From Web – Link to download the KML file from the Marine Traffic website.

Copy Error Files To Temp Directory – If the user wishes to save the kmz files that are downloaded with errors in the storage directory. This is usefully for debug and understanding the missing updates.

Save Copy Of Downloaded Kmz File – If the user wishes to save the kmz files that are downloaded from Marine Traffic website containing the vessel positions. The file will be saved in storage directory. This is usefully to compare the vessel positions or to load vessels into Google Earth.

Storage Directory – Folder where all the downloaded files will be saved.

Download Region Longitude West – This define the window section for the Longitude West coordinate. Only vessels inside this window will be updated.

Download Region Longitude East – This define the window section for the Longitude East coordinate. Only vessels inside this window will be updated.

Download Region Latitude West – This define the window section for the Latitude West coordinate. Only vessels inside this window will be updated.

Download Region Latitude East – This define the window section for the Latitude East coordinate. Only vessels inside this window will be updated.

Filter Vessel Type by Cargo Fishing Tanker – This property filter the vessels by vessel type. This property must be true for ARCOPOL+ project in order to download properties and update only vessels wity type of cargo, fishing and tanker. This flag reduce the amount of data in database and reduce the requests to Marine Traffic. All vessels that has a different type of vessel are ignored.


Coastal Risk Plugin – MOHID Studio

Introduction

The Coastal Risk Plugin, represented in Figure 10, allows the user to view the vessel details and positions, the vulnerability indexes (Environmental, Socio-Economic and Ecological), the vessel risk values, the coastal risk values, analyse the risk and determine the coastal risk on demand.

Coastal Risk - Instalation and User Guide 23.png
Figure 10 : Coastal Risk Tab in MOHID Studio.

Vessels

The vessel window list displays the list of all vessels witch has the vessel type: cargo, fishing and taker vessels (represented on Figure 11). To check the vessel details and positions, select a row and press the "Edit" button.

Coastal Risk - Instalation and User Guide 24.png
Figure 11 : Vessel List Window.

A new window will open, represented on Figure 12, containing the entire vessel details available (name, MMSI, type of vessel, dead weight, year, flag and photo) and all positions. It is possible to add, edit or remove vessel positions. The vessel picture might not appear (requires internet connection to display the picture).

Coastal Risk - Instalation and User Guide 25.png
Figure 12 : Vessel Detail Window.

Vulnerability Indexes

The Vulnerability Indexes group allows the user to check the values defined for each section of the geo location area. There are three types of Vulnerability Indexes in this application: Environmental Vulnerability Index (represented in Figure 13), Socio-Economic Vulnerability Index (represented in Figure 14) and Ecological Vulnerability Index (represented in Figure 15).

Coastal Risk - Instalation and User Guide 26.png
Figure 13 : Environmental Vulnerability Index Window.
Coastal Risk - Instalation and User Guide 27.png
Figure 14 : Socio-Economic Vulnerability Index Window.
Coastal Risk - Instalation and User Guide 28.png
Figure 15 : Ecological Vulnerability Index Window.

Risks

In the group of Risks there are two distinct types of Risks: Geo Location Risks and Vessel Risks. Each one is described over the next sub-sections.

Geo Location Risk

The Geo Location Risk Window displays all geo locations in the database (represented in Figure 16). After select one geo location (select the entire row), press the "Details" button and the Geo Location Risk Detail Window will appear (represented in Figure 17).

Coastal Risk - Instalation and User Guide 29.png
Figure 16 : Geo Location Risk Window.

In the Geo Location Risk Detail Window is possible to see and analyse the value of the coastal risk values determined for each instant. Each column represents a different type of risk (risk of collision ship-to-ship, risk of grounding,…) and each risk is displayed twice: determined value for the non-modelled risk and the determined value for the Lagrangian modelled risk. The meaning of each column is represented in Table 2.

Coastal Risk - Instalation and User Guide 30.png
Figure 17 : Geo Location Risk Detail Window.


Column Name Risk Name
Risk [NM] Integrated Risk [Non-Modelled]
Risk [M] Integrated Risk [Modelled]
RCSS [NM] Risk of Collision Ship to Ship [Non-Modelled]
RPC [NM] Risk of Port Collision [Non-Modelled]
RG [NM] Risk of Grounding [Non-Modelled]
RDG [NM] Risk of Drift Grounding [Non-Modelled]
RF [NM] Risk of Foundering [Non-Modelled]
RDGN [NM] Risk of Drift Grounding During Navigation [Non-Modelled]
RCSS [M] Risk of Collision Ship to Ship [Modelled]
RPC [M] Risk of Port Collision [Modelled]
RG [M] Risk of Grounding [Modelled]
RDG [M] Risk of Drift Grounding [Modelled]
RF [M] Risk of Foundering [Modelled]
RDGN [M] Risk of Drift Grounding During Navigation [Modelled]

Table 2 : Fields from Geo Location Risk Detail Window.

Vessel Risk

The Vessel Risk Window displays all the vessel risks in the database (represented in Figure 18). The meaning of each column is represented in Table 2.

Coastal Risk - Instalation and User Guide 31.png
Figure 18 : Vessel Risk Detail Window.

Risk on Demand

The group Risk on Demand contains a button that allows the user to determine the vessel risk and the coastal risk on demand. This feature gives the user the liberty to determine the risk on a selected instant. After pressing the button "On Demand" a new side window will open, as represented in Figure 19. This windows is divided into two sections: Configuration and Date Time Interval.

Coastal Risk - Instalation and User Guide 32.png
Figure 19 : Risk on Demand Window.

Configuration

The Configuration of the Risk on Demand Window (represented in Figure 20) can be a little tricky, so we will explain the basic steps. This configuration allows the user to select almost each parameter of the risk determination.

Coastal Risk - Instalation and User Guide 33.png
Figure 20 : Risk on Demand window – Configuration group.

The Risk on Demand window has the parameters organized in groups. Each group is explained in the next subsections. After a property is selected, as shown in Figure 20, a brief description of the property is described below (at the grey bar).

The user can save the configuration file (save button located on the top right – Figure 20) or can load a previous saved configuration file (open button located on the top right – Figure 20).

Accident Frequency Constant

The accident frequency constant is an essential parameter to determine the vessel risk and the coastal risk. These values can be changed by the user in order to adjust the risk calculation. The default values are presented on the Table 3.

Type of Risk Shallow Waters Deep Waters
Risk of Collision Ship to Ship 1.9 x 10-7 6.8 x 10-9
Risk of Port Collision 2.28 x 10-7 -
Risk of Grounding 1.53 x 10-7 -
Risk of Drift Grounding - 1.02 x 10-8
Risk of Foundering - 4.95 x 10-8
Risk of Drift Grounding During Navigation - 6.65 x 10-8

Table 3 : Accident Frequency Constant default values.
Correction Factors

The correction factors allow the user to reduce the impact of using constant values. These values can be changed by the user in order to adjust the risk calculation. The default values are presented on the next tables for: shoreline proximity (Table 4), currents velocity (Table 5), visibility for risk type of ship to ship collision (Table 6), visibility for risk type of foundering (Table 7), waves (Table 8) and wind velocity (Table 9).

For tables where the value is present "below" from a certain value (and the minimum value is not defined), the user should set the minimum value as "0". Where the maximum value is not defined, the user should insert a larger number. The minimum and maximum values can’t be null or not defined.

The correction factors appear as "(Collection)" (see Figure 20). To edit this field, press the button with "…" and a new window will open (represented in Figure 21). In this case, the correction factor value is 2 (field name = "ValueKey") for shoreline values between 0 (field name = "ValueMin") and the 11112 m (field name = "ValueMax"). This value corresponds to the first row of the Table 4.

Coastal Risk - Instalation and User Guide 34.png
Figure 21 : Configuration – Edit Correction Factor values.


Proximity to shoreline (in m) Multiplying correction factor
<= 11112 2.0
11112 < … <= 14816 1.0
> 14816 0.8

Table 4 : Correction factor associated to proximity to shoreline default values.


Currents velocity (in m/s) Multiplying correction factor
<= 0.3601 0.4
0.3601 < … <= 0.5144 0.8
0.5144 < … <= 1.0289 1.2
1.0289 < … <= 1.5433 1.6
> 1.5433 2.0

Table 5 : Correction factor associated to currents velocity default values.


Visibility (in m) Multiplying correction factor
<= 1852 1.76
> 1852 0.24

Table 6 : Correction factor associated to visibility (Risk of Collision Ship to Ship) default values.


Visibility (in m) Multiplying correction factor
<= 1852 1.4
> 1852 0.6

Table 7 : Correction factor associated to visibility (Risk of Foundering) default values.


Risk Type Multiplying correction factor – Waves (in m)
<= 2.5 > 2.5
Drift Grounding 0.22 1.78
Foundering 0.1 1.0
Grounding during Navigation 0.6 1.4

Table 8 : Correction factor associated to waves default values.


Wind velocity (in m/s) Multiplying correction factor
<= 8.3333 0.8
8.3333< … <= 13.8889 1.2
13.8889 < … <= 25 1.6
> 25 2.0

Table 9 : Correction factor associated to wind default values.
Geo Locations

Path to file: KML – Insert here the path to file "atlascosteiro.kml". This file should contain the coastal sections and the vulnerability indexes for environment, socio-economic and ecological. If the field is empty, the risk will be determined for all the coastal sections in the database. (To check all the coastal sections from database, read section: 5.4.1).

Path to file: Shallow Water – Insert here the path to file "Portugal3MilesZone.shp". This file should contain the coastal area for the shallow water zone.

Model

Backup Input Files – TRUE / FALSE. It is possible to save the initial conditions from the Lagrangian model. If this field is "TRUE", a zip file will be created in Storage Directory containing the folders: "data", "exe" and "General Conditions". The file name will be similar to: "Input_Files_yyyymmdd_hhmmss.zip". The date instant corresponds to the start instant of the simulation. In case of more than one simulation start at the same instant, the file name will be similar to: "Input_Files_yyyymmdd_hhmmss_n.zip" (where "n" corresponds to a number). If this field is "FALSE" the initial conditions will be deleted after the model finish the execution.

Backup Result Files – TRUE / FALSE. It is possible to save the result files from the Lagrangian model to analyze them after the model execution. If this field is "TRUE", a zip file will be created in Storage Directory containing the "res" folder. The file name will be similar to: "Result_Files_yyyymmdd_hhmmss.zip". The date time instant in the file name corresponds to the start instant of the simulation. In case of more than one simulation start at the same instant, the file name will be similar to: "Result _Files_yyyymmdd_hhmmss_n.zip" (where "n" corresponds to a number). If this field is "FALSE" the result files (*.tro) from model will be deleted after the model finish the execution and all the calculus are finished.

L unit – 1000 [m]. This field corresponds to the shoreline distance unit, also known as "Length Unit" in the Q* formula [Q* = (Q x M)/L stretch x L unit].

Model Executable File – "exe\MOHIDWater_release_single.exe". This field is the relative path (from the Root Directory) to the execution model file. The Lagrangian model that will be executable is the file indicated in this field.

Model Grid File – "GeneralData\Batim\Portugal_20080707Final.dat". This field is the relative path (from the Root Directory) to the grid file used by the Lagrangian model.

Model Name: Hydrodynamic – "MOHID". This field contains the model domain name for hydrodynamics.

Model Name: Meteorological – "MM5". This field contains the model domain name for meteorological.

Model Name: Waves – "WW3". This field contains the model domain name for waves.

Model Root Directory – This field contains the absolute path for the model root directory. The Model Root Directory is the base folder of the Lagrangian model. This folder contains the folders: "data", "exe", "General Data", "Model Runs" and "res".

Path to file: Hydrodynamic – This field can be empty or containing a path to an HDF5 file. This is the hydrodynamic data that will be used for the model. If the field is empty, the database values are used for the model execution. If the user input an HDF5 file, the values from the file will be used for the model execution.

Path to file: Meteorological – This field can be empty or containing a path to an HDF5 file. This is the meteorological data that will be used for the model. If the field is empty, the database values are used for the model execution. If the user input an HDF5 file, the values from the file will be used for the model execution.

Path to file: Waves – This field can be empty or containing a path to an HDF5 file. This is the wave data that will be used for the model. If the field is empty, the database values are used for the model execution. If the user input an HDF5 file, the values from the file will be used for the model execution.

Run Time – 24 [hour]. This field represents the number of hours that the Lagrangian model will simulate forward in time.

Storage Directory – This field contains the absolute path for the storage directory. This is the folder where the input and result files will be saved, if the user wish to storage them.

Use Lagrangian – TRUE / FALSE. If the Lagrangian model should be used for determine the coastal risk.

Water Depth (Minimum) – 0 [m]. Minimum Water Depth where the vessel can be located.

Risk Calculation

Vessel Window – 30 [minute]. This field represents the time window (in minutes) that will be added to an instant, in order to get more vessel positions. If the instant is 10h, the application will get from database for each vessel the closest position to 10h, between 9h30m and 10h30m. This interval is needed because the vessel position update may not be at the precise instant.

Spill Generic Risk

The default values used for the spill generic list are presented on Table 10 and Table 11.

Type of Vessel Shallow Waters
Cargo 0.1
Fishing 0.3
Tanker 0.2

Table 10 : Default values for Correction factor based on spill site used, in function of ship type.


Parameter Default value
Minimum value to display Coastal Risk 6
Percentile 98

Table 11 : Default parameters values for determine the Coastal Risk.
Correction Vessel Factor

The values for the correction factor used for the vessel risk determination are presented for: vessel type Cargo (Table 12), vessel type Fishing (Table 13) and for vessel type Tankers (Table 14).

Type of Risk Shallow Waters Deep Waters
Risk of Collision Ship to Ship 2 3.343
Risk of Port Collision 1 -
Risk of Grounding 1.6 -
Risk of Drift Grounding - 2.133
Risk of Foundering - 3.606
Risk of Drift Grounding During Navigation - 4.286

Table 12 : Default values for: Correction vessel factor – Cargo.


Type of Risk Shallow Waters Deep Waters
Risk of Collision Ship to Ship 0.3 -
Risk of Port Collision 0.7 -
Risk of Grounding 0.2 -

Table 13 : Default values for: Correction vessel factor – Fishing.


Type of Risk Shallow Waters Deep Waters
Risk of Collision Ship to Ship 1.7 1.629
Risk of Port Collision 1 -
Risk of Grounding 1.6 -
Risk of Drift Grounding - 1.6
Risk of Foundering - 0.113
Risk of Drift Grounding During Navigation - 0.612

Table 14 : Default values for: Correction vessel factor – Tanker.

Date Time Interval

On the Date Time Interval group (represented on Figure 22) the user can define the mode of the risk determination. First the user should select a start instant and end instant. The Risk Calculation Frequency defines the hour of the loop. The checkbox, if checked, indicates that the Lagrangian model will be executed for the risk determination. If not, only the non-modelled risk will be determined. After the configuration is complete, press the button Determine Risk. Note: The result might be a little slow, depends on the quantity of vessels and the number of coastal section.

Coastal Risk - Instalation and User Guide 35.png
Figure 22 : Risk on Demand – Date Time Interval group.

For example, if the user wishes to determine the risk at each 6 hours for a 24 hour period, the configuration should be similar to the one represented on Figure 23.

Coastal Risk - Instalation and User Guide 36.png
Figure 23 : Example of the date time interval configurations for several runs.

Results

After finish the determination of coastal risk a new window with the results will appear (represented on Figure 24). The meaning of each column is represented in Table 2. The results from this window can be exported to a XLS file (top right button).

Coastal Risk - Instalation and User Guide 37.png
Figure 24 : Risk on Demand – Results window.

Along with the results window from Risk on demand, 2 (or 3) layers are appended to the map: Risk on Demand – Vessel Risk; Risk on Demand – Coastal Risk (Non-Modelled) and Coastal Risk (Modelled) [only appears if Lagrangian mode was selected], as represented in Figure 25.

Coastal Risk - Instalation and User Guide 38.png
Figure 25 : Risk on Demand – Layers visualization.

  1. – Disk Space required by MOHID Studio only. The disk space requited for additional software and projects is not included.
  2. .NET Framework 4.0 will be installed, if necessary, automatically by the MOHID Studio installer. It is also possible to download from the Microsoft Website: http://www.microsoft.com/en-us/download/details.aspx?id=17851


Links

User Guides