Contents

Preface

Copyright

This document refers to MOHID Studio, proprietary computer software which is protected by copyright. All rights are reserved. Copying or other reproduction of this document or related programs 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 modeling 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, Consultores de Segurança Lda.

Rua Cidade de Frehel, Bloco B, Nº 12 A

2640-469 Mafra, Portugal

Tel.: +351 261 813 660

Fax: +351 261 813 666

E-mail: geral@actionmodulers.com

Web: http://www.actionmodulers.com

MOHID Studio

Introduction

MOHID Studio is a graphical user interface for the MOHID Water Modelling System. With MOHID Studio you can use MOHID Numerical Engines from inside a user friendly environment, managing all tasks required in order to prepare, execute and analyze results of numerical simulations done by MOHID Numerical Engines.

Features

MOHID Studio is an integrated system which permits to manage and edit data files, create and launch simulations and analyze model results. Map data can be displayed through an integrated GIS system and time series data can be displayed in an integrated graph visualization engine. A set of tools allows the user to create and preprocess MOHID data files. A special module allows managing data from field campaigns and/or automatic stations. MOHID Studio also offers the possibility to convert data among a set of common formats and MOHID internal formats. All features of MOHID Studio are described along this user guide.

Backward compatibility

MOHID Studio replaces the existing MOHID graphical user interfaces, namely MOHID GUI, MOHID GIS, MOHID Time Series Editor and MOHID Post Processor.

Backward compatibility allows importing projects created with MOHID GUI. Some formats of MOHID ASCII files (points, lines and polygons) have been replaced by a new generic geometry format, XML based. MOHID Studio Tools allows convert from one format to another[1].

Concepts behind MOHID Studio

MOHID Studio uses a database to store all information about projects and data from field campaigns and/or automatic stations. Data and result files from numerical models are stores in a well-defined directory structure.

Starting MOHID Studio

To start MOHID Studio, use the Windows Start Button (see Figure 22 1): All Programs ‒> Action Modulers ‒> MOHID Studio ‒> MOHID Studio.

MOHID Studio - User Guide 02.png
Figure 2 2 1: Execute MOHID Studio.

Main Window

MOHID Studio’s main window is shown in Figure 22 2. On the top of the main window is placed the main menu. Inside the client area different dockable windows are located. The "Explorer" window (currently shown in Figure 22 2) allows managing simulations and the "Map" window (hidden in Figure 22 2) shows the content of the GIS engine.

MOHID Studio - User Guide 03.png
Figure 2 2 2: MOHID Studio’s main window.

Beside the "Explorer" window and the "Map" window (that are always open) other windows may appear in the client area of the main window (for example: XY Graphs, Tools, Reports, etc.).

Dockable Windows

Windows inside the client area are "dockable". This means that the user can arrange them as needed. The Figure 22 3 shows MOHID Studio’s main window where the "Explorer" window and the "Map" window are docked side by side.

MOHID Studio - User Guide 04.png
Figure 2 2 3: MOHID Studio’s main window (side by side docking).

To change the dock state of a window, double click on the title bar (this turns the window floating). Then drag it to the desired position.

Main Menu

The main menu is divided into several tabs and organized by features (and works in a similar way as the ribbon’s menu of Microsoft Office 2007). Each tab contains a ribbon menu, organized in groups, with several items for a specific task. As an example the Figure 22 4 shows the ribbon menu related to the Map window. Each menu is explained in detail in this guide.

MOHID Studio - User Guide 05.png
Figure 2 2 4: Example of a Ribbon Menu (Map).

Home menu

The "Home" ribbon menu (see Figure 22 5) is the first menu displayed by MOHID Studio and helps you to get started with the application. This menu is divided into three distinct groups: "Workspace", "Getting Started with MOHID" and "Links". The "Workspace" group allows to use workspaces very quick (learn how to use workspaces in subsection 2.9).

MOHID Studio - User Guide 06.png
Figure 2 2 5: Home menu.

The group "Getting Started with MOHID" has some examples to introduce you to MOHID Studio application. These examples allow importing sample solutions and sample unit tests for a better understanding of MOHID Studio. These samples contain basic examples (ready to run the model) helping you to create your own solutions and domains (for more information read subsection 2.8).

The "Links" group contains a variety of links where it is possible to find some help with the MOHID community (MOHID Homepage, MOHID Forum, MOHID Wiki and MOHID Studio Homepage).

Getting Started with MOHID Studio

The best way to start working with MOHID Studio is to load a sample solution. On the group "Getting Started with MOHID", from menu Home (see Figure 22 5), there are four sample solutions (two for MOHID Water and two for MOHID Land). Each solution contains one or more domains[2]. MOHID Studio domains are always represented by a color corresponding to the type of model, for an easy way to work. The color blue stands for MOHID Water domains, the color yellow stands for MOHID Land domains and the color red stands for MOHID River domains (as shown in Figure 22 6).

MOHID Studio - User Guide 07.png
MOHID Studio - User Guide 08.png
Figure 2 2 6: Example of domain icons: Mohid Water (blue) and Mohid Land (Yellow).

The sample solution is loaded to MOHID Studio by pressing one of the sample solutions button and everything is ready to run, letting you easily explore all the features of MOHID Studio. The loaded sample solution can be changed or modified according to your needs. It can also be saved, replacing the original sample solution. So, the next time the sample solution button is pressed, on "Getting Started with MOHID" from menu "Home" (see Figure 22 5), the saved sample solution will be prompted with all the layers opened. Although the original sample solution was replaced, it is always possible to restore it again. It is also possible to save the solution as a new workspace (see subsection 2.9).

The original sample solution can be restored by executing three simple steps:

1 – Delete the workspace associated to the sample solution on Workspace Manager (on the group "Workspace", from menu Home (see Figure 22 5));
2 – Delete the sample solution saved on Solution Manager (on the group "Solution", from menu Project (see Figure 23 1) – for more information read section 3.2.3 );
3 – Delete the projects from the sample solution on Project Manager (on the group "Domain", from menu Project (see Figure 23 1) – for more information read section 3.3.4).

MOHID Studio help can always be found in this user guide, in MOHID Studio tutorials, on internet forums or by e-mail. It is possible to export your solution and then send and request for professional help (to see how to export solution check subsection 3.2.4) through the option "Request Support".

Workspaces

Introduction to Workspaces

Workspaces allow storing the state of MOHID Studio between two consecutive work sessions. For this, the workspace keeps track of the current open solution (see subsection 3.2) and loaded layers.

Working with Workspaces

MOHID Studio does not have an explicit way to create a workspace. After MOHID Studio starts the Workspace Manager window will appear on your screen (as shown in Figure 22 7). You might select an empty workspace, load a sample workspace or to load an existing workspace.

MOHID Studio - User Guide 09.png
Figure 2 2 7: Create a new workspace or load an existing one.

When a workspace is closed (by closing MOHID Studio or when another solution or workspace is opened) a window will appear asks if the user wants to save the current workspace, as shown in Figure 22 8.

MOHID Studio - User Guide 10.png
Figure 2 2 8: Save workspace on program exit.

Workspaces can be changed or saved at any time during a session. To create a new workspace or to open another workspace, press Open in "Workspace" group from menu Home (see Figure 22 5). To save the current workspace press button Save in "Workspace" from the Home menu (see Figure 22 5).

Managing Workspaces

Managing workspaces involves renaming and deleting existing workspaces. To manage the workspaces select "Manage" (from the group "Workspace" in the menu "Home" (see Figure 22 5). The Workspace Manager will appear (like the one on Figure 22 9) and the user can easily manage your MOHID Studio Workspaces. To rename a workspace just press the "Rename" button after selecting the Workspace to rename. The name of the workspace must be unique.

To delete a workspace, first select the workspace to delete on the list of Manage Workspace (see Figure 22 9), then press the "Remove" button. The workspace only can be removed it is closed. The current workspace cannot be removed.

MOHID Studio - User Guide 11.png
Figure 2 2 9: Managing Workspaces.

Project Management

Introduction

MOHID Studio organizes projects by dividing them into three major units: (i) solutions, (ii) domains and (iii) simulations.[3]

A solution is the topmost unit and groups together one or more domains. For each workspace, only one solution can be opened by MOHID Studio.

A domain is characterized by a geographic region which is covered (through the Digital Terrain Model), the type of numerical model to use (MOHID Water, MOHID Land or MOHID River) and the physical path on the disk where files are stored. Each domain belongs to one or more solutions and contains a set of simulations. In the case of MOHID Water, nested domains can be created.

A simulation is one execution of the numerical model over a given period of time. All files (input files and result files) related with the execution also belong to the simulation.

Solutions, domains and simulations can be managed from the "Project" menu (see Figure 23 1).

MOHID Studio - User Guide 12.png
Figure 2 3 1: Project menu.

Data associated with projects is displayed in the "Explorer" window (see Figure 23 2). This window is divided into three main areas: (i) the Project Tree on the left, (ii) the Modules window in the middle and (iii) the File Editor on the right.

MOHID Studio - User Guide 13.png
Figure 2 3 2: Explorer window.

The Project Tree shows the hierarchical structure of projects. In Figure 23 2 a solution called "OpenMI Implementation" is shown. This solution contains two domains: (i) Sample Estuary and (ii) Sample Catchment. The domain Sample Estuary shows two simulations, ReferenceRun and Sim#2.

Some functions which can be accessed from the "Project" menu can also be accessed from the context menu (by clicking on the right mouse button) accessible from the Project Tree (see Figure 23 3).

MOHID Studio - User Guide 14.png
Figure 2 3 3: Accessing project management options from the context menu.

Solution

Like previously mentioned, a solution is the topmost unit and groups together one or more domains. For each workspace, only one solution can be opened by MOHID Studio.

Creating or opening solutions

A new solution can be created by selecting "New" on Solution group, from the "Project" menu (see Figure 23 1). The window to create solutions is represented on Figure 23 4. When creating a new solution, a name of the solution must be provided and must be unique.

To open an existing solution, press "Open" on Solution group, also from "Project" menu (see Figure 23 1). The window to open existent solutions is very similar to the one that is represented on Figure 23 4.

When a new solution is created or opened, the current opened solution in MOHID Studio will be closed. Note that the solution of the current workspace will be replaced by the new solution opened or created. To prevent unwanted results, save the working workspace before opening or creating a new solution.

MOHID Studio - User Guide 15.png
Figure 2 3 4: Creating a new solution.

Closing solutions

Solutions can be closed by selecting "Close" on Solution group, from the "Project" menu (see Figure 23 1).

Managing solutions

There are several tasks which can be performed with solutions: (i) rename, (ii) delete, (iii) import and (iv) export. All these tasks can be performed by selecting "Manage" on Solution group, from the "Project" menu (see Figure 23 1).

To change the name of a solution, use the "Rename" button. Any new name can be given, with the exception that solution names must be unique.

MOHID Studio - User Guide 16.png
Figure 2 3 5: Solution Management.

To remove a solution, use the "Remove" button. Any solution can be removed, except the currently opened solution. When a solution is removed, domains associated to the solution are NOT removed. All domains remain available in the Domain Manage (for more information read subsection 3.3.4).

Exporting solutions

Exporting a solution allows to store all information about the solution, including all domains and data files, in a single ZIP file. This is very useful if you want to exchange solutions between computers, backup the solution or if you want to request professional help. To export a solution, select the "Export" button from the "Solution Management" window (see Figure 23 5). A window like the one represented in Figure 23 6 will appear.

The file name must be a "ZIP" archive to which the solution will be exported. By default, the exported ZIP archive does not include the result files (since they can be very large). Result files are only included if the "Include Result files" options is checked. By clicking the "Export" button the export process begins. Depending on the number and size of files included in the solution, the process can take longer.

MOHID Studio - User Guide 17.png
Figure 2 3 6: Exporting solutions.

Importing solutions

To import a solution select the "Import" button from the "Solution Management" window (see Figure 23 5). A window like the one represented in Figure 23 7 will appear.

MOHID Studio - User Guide 18.png
Figure 2 3 7: Importing solutions.

Importing solutions allows processing two types of solutions: (i) a previously exported solution or (ii) a project from MOHID GUI.

To import a previously exported solution check the MOHID Studio option and browse for the ZIP archive which contains the solution.

To import a MOHID GUI project check the MOHID GUI option and browse for the MOH file of the MOHID Project[4].

By clicking the "Import" button the import process begins. Depending on the number and size of files included in the solution, the process can take longer.

NOTE: If a solution with the same name of the solution to import already exists, the newly imported solution is automatically renamed (example: ImportedSolution_1).

Domains

Like previously mentioned, domains are characterized by a covered geographic region (through the Digital Terrain Model), the type of numerical model to use (MOHID Water, MOHID Land or MOHID River) and the hard drive path’s where the files will be stored. Each domain can belong to one or more solutions and contains a set of simulations. For MOHID Water domains it is possible to create nested domains.

Creating domains

New domains can be created by pressing the "New" button in "Domain" group from the "Project" menu (see Figure 23 1). A window like in Figure 23 8 appears.

The information provided in the creating new domain window characterizes your domain. The following restrictions must be fulfilled:

  • the domain name must be unique;
  • the root directory must be empty (when the domain is created or imported).

The path to the Digital Terrain Model may not be specified during domain creation. It is possible to import the digital terrain from another place or to create one with MOHID Studio Tools. It is always possible to return to this window (domain properties) after the domains is created.

MOHID Studio - User Guide 19.png
Figure 2 3 8: Creating a new domain.

When a new domain is created, MOHID Studio creates automatically four special folders to store general data files: (i) one root directory (General Data) and (ii) three subdirectories (Initial Conditions, Boundary Conditions and Digital Terrain). MOHID Studio also creates three specific folders for MOHID model runs: (i) data, (ii) exe and (iii) res. The directory structure for one specific folder, after the domain is created is represented in Figure 23 9.

MOHID Studio - User Guide 20.png
Figure 2 3 9: Directory structure for a domain.

NOTE: This approach is different to the one that is used by MOHID GUI, since there is now one General Data folder for each domain (in MOHID GUI the General Data Folder was shared among domains).

Domain properties

Domain properties can be accessed and changed by selecting the button "Properties", in the Domain’s group from the "Project" menu (see Figure 23 1). The window similar to the one that is showed in Figure 23 8 will appear.

NOTE: It is not recommended to change the Root Directory of a domain after data files and/or simulations have been added to the domain.

Removing domains

Domains can be removed by selecting the button Remove, on Domain’s group from the "Project" menu (see Figure 23 1). After removing a domain from one solution, the domain still persisted in the data base. To permanently remove one domain use the "Manage" domains window options (see subsection 3.3.4).

Managing domains

It is possible to manage domains by selecting the "Manage" button on the Domain’s group from the "Project" menu (see Figure 23 1). In the Figure 23 10 is represented the window that will appear after pressing "Manage" domains.

Using this window it is possible: (i) to create new domains by selecting the "Add" button, (ii) to edit existing domains by selecting the "Edit" button and (iii) to remove a domain by selecting the "Remove" button. After removing a domain, MOHID Studio asks if the folders associated to the domain are also to be removed (Figure 3 11).

MOHID Studio - User Guide 21.png
Figure 2 3 10: Managing Domain.

By selecting "Yes" the entire directory will be permanently deleted from your hard disk, including the structure of the domain’s Root Directory and including all files inside that directory. Before press "Yes", make sure that you do not have important files inside that directory or subdirectory.

MOHID Studio - User Guide 22.png
Figure 2 3 11: Remove Domain.

Nested domains

Nested domains are used to run models with sub models. This feature is currently only implemented in MOHID Water, so MOHID Studio only allows to create nested domains for domains with the "MOHID Water" type. The process of creating nested domains is similar to the process of creating root domains. The main difference is the fact that the "father" domain must be selected in the tree view while the new nested domain is created. To create a new nested domain select the "father" domain, on the tree view, and then press the button "New" on Domain’s group, from the "Project" menu (see Figure 23 1). It is also possible to select the "father" domain, on the tree view, and click with the right button of the mouse, above the "father" domain, and select "Insert nested domain" (as represented on the Figure 23 12).

MOHID Studio - User Guide 23.png
Figure 2 3 12: Insert nested domain.

When creating a nested domain, MOHID Studio sets the root directory for the nested domain automatically. In Figure 23 13 is represented the Project Tree with an example of a nested domain (domain North Atlantic and with the nested domain Portuguese Coast).

MOHID Studio - User Guide 24.png
Figure 2 3 13: Project Tree showing a domain with a nested domain.

Simulations

Like previously mentioned, a simulation is one execution of the numerical model over a given period of time. All files (input files and result files) related with the execution also belong to the simulation.

Creating simulations

To create a new simulation, select the tree node where the simulation will be added. The selected node can be either a domain node or a simulation node, depending on whether the user wants to insert a first simulation into a domain or a time extension of a previous existing simulation. After selecting the desired node, a new simulation can be created by pressing the button "New" on Simulation’s group from the "Project" menu (see Figure 23 1). A window like the one represented in Figure 23 14 will appear. This window can be used to specify the properties of the simulation: (i) name, (ii) description and (iii) modules to activate.

MOHID Studio - User Guide 25.png
Figure 2 3 14: Creating a new simulation.

Each simulation receives automatically an ID (internal identification which cannot be changed). All files belonging to a given simulation will contain this ID at the end, before the extension of the file. For example, the input file for the hydrodynamic module of the simulation with ID 5 will be called "Hydrodynamic_5.dat".

Simulation properties

Simulation properties can be accessed and changed by selecting the button "Properties" in the Simulation’s group from Properties from the "Project" menu (see Figure 23 1). An identical window to the one showed in Figure 23 14 will appear.

Root and sequential simulation

MOHID Studio distinguishes between two types of simulations: (i) sequential simulations or (ii) root simulations.

MOHID Studio assumes that root simulations always start as "cold start" (initial conditions are obtained from the data files) and that sequential simulations always start as "hot start" (initial conditions are obtained from the previous simulation). MOHID Studio allows creating branches of ordered simulations to study different scenarios.

On Figure 23 15 is represented an example of the Project Tree after setting up the simulations for scenarios which involve studying the combination of the following cases: (i) No Discharge vs. With Discharge and (ii) East Wind vs. West Wind. This example shows two root (Spin up) simulations, one for the "No Discharge" case and one for the "With Discharge" case. For both root simulations several time-sequential simulations are shown (Day 1 and Day 2). The branches were created after the Spin Up, for the "East Wind" and "West Wind" cases.

MOHID Studio - User Guide 26.png
Figure 2 3 15: Project Tree showing root and sequential simulation and the usage of branches.

In case of inserting a simulation which continues from a previous simulation, MOHID Studio will automatically set the start date of the new simulation to be the same as the end date of the previous simulation. Also the option "continues" in all module data files will be changed to "true".

Removing simulations

Simulations can be removed by selecting "Delete" in the group Simulation from the "Project" menu (see Figure 23 1). When deleting a simulation, all nested child simulations will also be removed.

Simulation associated files

Numerical models, like MOHID, need data files (to read the initial conditions and general compute options) in order to produce result files. Each simulation has associated a set of files. After selecting a specific simulation in the Project Tree, files associated to the selected simulation are displayed in the Module List Views, located in the middle of the Explorer Window. Figure 23 16 shows the files associated to the selected simulation in the Module List Views. On top are located Data Files, in the middle HDF Files and at the bottom Time Series Files.

MOHID Studio - User Guide 27.png
Figure 2 3 16: Files associated to simulations.

Data files can be easily modified and saved by MOHID Studio (for more information about this method read subsection 3.6).

Copying simulation data files

It is common for users to set up two simulations which are very similar. In this case it can be useful to copy data files from one simulation to another. To copy one simulation press the button "Copy" on the Simulation group, from the "Project" menu (see Figure 23 1). A window like the one represented on Figure 23 17 will appear. In this window is possible to select one simulation to copy to another domain. On the left side (Source Module Data Files) are the simulation that will be copied and in the right side the new simulation. To copy one simulation check it on the tree view from the left side. When checking a simulation all the module data files from that simulation are also checked. The files that are checked are the ones that will be copied to the new simulation. Select the target simulation, on the right side, by checking the destination simulation. After checking all the files to copy press the button copy to copy the module data files to the target simulation. Note: by default, the simulation data folders are also copied. If you don’t want this option please uncheck the box "Copy Simulation Data Folders".

MOHID Studio - User Guide 28.png
Figure 2 3 17: Copy Module Data Files Window.

Comparing Simulations

To comparing simulation allows the user to compare two distinguish solutions and check the differences between them. To use the Compare Simulations window (represented on the Figure 23 18) press "Compare" on the Simulation group from the "Project" menu (see Figure 23 1). This window only compares simulations that have the domains opened or loaded into the Project Tree View.

On the upper part of the window the user should select the two simulations to compare (one from the left column and the other on the right column). Then press the "Compare" button and all the Module Data Files will be compared. The list of the differences between the two simulations is listed below the "Compare" button, identifying the fires that are equal or different. To check the differences double click the module name desired and the differences will be shown on the box located on the bottom right side of the window. The differences are marked with the lines "!<-- ############" (for Simulation 1) and "! --> ############" (for Simulation 2).

MOHID Studio - User Guide 29.png
Figure 2 3 18: Comparing Simulations.

Cleaning simulation result files

In some circumstances it might be useful to erase all result files associated to a specific simulation. This can be easily done selecting the simulation in the Project Tree and then pressing the button "Clean" on Simulation’s group from the "Project" menu (see Figure 23 1).

Organizing data files

Data files play a central role when running numerical simulations. Like described previously, MOHID Studio:

  • Automatically creates and organizes data files associated to simulations;
  • Creates a directory structure where data files associated to domains can be stored.

Data files associated to simulations

When a simulation is selected in the Project Tree, it is displayed in the Module List Views all the files associated to the selected modules. The names of these files are automatically created based on the simulation ID.

Data files associated to domains

The data files associated to domains (e.g. Digital Terrain, Boundary Conditions and Initial Conditions) must be supplied by the user. These files should be stored in the General Data directory (or any subdirectory). The directory structure of the General Data directory is displayed in the Project Tree. When a directory is selected in the Project Tree, the files located in this directory are displayed in the Module List Views.

NOTE: MOHID Studio considers the HDF Files that have an extension *.hdf or *.hdf5 and Time Series Files have the extension *.sr*.

From the context menu (pressing the right mouse button) of the Project Tree several tasks can be performed (see Figure 23 19):

  • Creating a new directory inside the General Data directory
  • Removing an existing directory
  • Create a new empty data file
  • Create a new time series template file
  • Import an existing file
MOHID Studio - User Guide 30.png
Figure 2 3 19: Project Tree - Context menu.

Editing data files

Data files can be edited in the File Editor, which is located at the right side of the Explorer window (represented on Figure 23 20). To edit data files, simply double click over them inside the Data File List View. Data files will appear as tabs inside the File Editor.

If a data file for a given module does not exist yet, MOHID Studio will create it automatically, using a template with the most common options for the selected module.

MOHID Studio - User Guide 31.png
Figure 2 3 20: File Editor with two open data files.

Inside the File Editor data files have syntax highlighting based in the following rules:

  • Keyword are red;
  • Keyword values are blue;
  • Block delimiter are purple;
  • Comment lines are green.

In the upper right corner of the File Editor Window are available a set of commands (represented on the Figure 23 21) which help editing data files:

  • Find Text / Replace Text – to find / replace a specific text inside the data file
  • Copy / Paste
  • Comment / Uncomment lines
  • Save / Save All
  • Close / Close All
MOHID Studio - User Guide 32.png
Figure 2 3 21: File Editor commands.

By right clicking the mouse, inside the Text Editor, the context menu will pop up. Context menu allows to copy, cut and paste selected text (as represented on Figure 23 22).

MOHID Studio - User Guide 33.png
Figure 2 3 22: File Editor – Context menu.

Executing Models

When all data files are prepared it is possible to execute simulations. MOHID Studio provides two options to execute models: (i) run a single simulation or (ii) schedule a set of simulations.

Executing a single simulation

To execute a single simulation, just select the simulation to execute on the Project Tree and then press the button "Run Now" on the Execute Models group from the "Project" menu (see Figure 23 1). The simulation will start running immediately.

Executing a set of simulations

A set of simulations (including nested simulations) can be executed by pressing "Schedule" on the Execute Models group from the "Project" menu. A window like the one represented on the Figure 23 23 will appear.

MOHID Studio - User Guide 34.png
Figure 2 3 23: Scheduling a set of simulations.

First it is "open" the node with the root domain and then select all the simulations which the user wants to be executed.

For nested domains, the selection of the simulations must be paired, like the example represented on the Figure 23 24.

MOHID Studio - User Guide 35.png
Figure 2 3 24: Scheduling (for nested domains.

Simulation progress

Feedback on simulation progress appears below the Project Tree, in the "Model Controller" window (represented on the Figure 23 25). The progress bar indicates the evolution of the simulation.

It is possible to see the screen output from the numerical model by selecting the "Output" button in the Model Controller. A window like shown in Figure 23 26 appears.

MOHID Studio - User Guide 36.png
Figure 2 3 25: Model Controller Window.
MOHID Studio - User Guide 37.png
Figure 2 3 26: Model screen output window.

The execution of the model can be interrupted at any time, by pressing the button "Kill" from the Model Controller (represented on the Figure 23 25).

When a simulation is finished, the entire model screen output is stored. It is possible to access this information by selecting "View Last Log" from the context menu of the Project Tree (represented on Figure 23 19).

Visualizing results

After the model execution is completed, the list views containing the HDF results and the Time Series results are updated. There are several options to visualize the results directly inside MOHID Studio. All options can be accessed from the commands located in the upper right corner of the list views (read subsections 3.8.1 and 3.8.2).

Visualizing HDF results

HDF Files can be loaded into the GIS map engine as animated maps. There are several options to display HDF results, depending on the model. A detailed description on how to display animated maps inside MOHID Studios can be found on section 4 of this manual.

From the HDF List view it is possible to load HDF files as polygons, vectors or lagrangian animations, using the command in the upper right corner of the list view.

MOHID Studio - User Guide 38.png
Figure 23 27: HDF List View with commands.

Visualizing Time Series results

Time Series Files can be loaded into the XY Graph engine. A detailed description on how to display XY Graphs inside MOHID Studio can be found at section 5 of this manual.

From the Time Series List view it is possible to load Time Series files into the XY Graph engine or edit them in the File Editor.

MOHID Studio - User Guide 39.png
Figure 23 28: Time Series List View with commands.

Map Visualization (GIS)

Introduction

MOHID Studio uses a customized Geographical Information System (GIS) to display dynamic maps. Information which can be displayed includes raster images and vector data. All data is presented in form of layers.

Raster images are typically used to add a background to the image. These can be added from local images or from Web Map Servers (WMS).

MOHID Studio supports different kinds of vector data sources.</center> Special emphasis is given to data related to MOHID models: (i) special ASCII (and XML) files in MOHID format and (ii) model results stored in HDF Files. Other vector data sources can also be added, including ESRI Shapefiles and HGT files. Vector data can be displayed in several different ways, using simple styles or theme based styles. MOHID Studio also supports time animated vector data.

Tasks related to the map visualization can be performed from the "Map" menu (represented on Figure 24 1).

MOHID Studio - User Guide 40.png
Figure 2 4 1: Map menu.

Layers are displayed in the "Map" window (Figure 4 2). This window is divided into two main areas: (i) the list of Layers (Layers List), on the left side of the window, and (ii) the Map Display, on the right side of the window.

MOHID Studio - User Guide 41.png
Figure 2 4 2: Map window.

The list of Layers shows the currently loaded layers of the map. At the bottom of Layers List is located a small tool box which allows to control the current display time (in the case time animations are loaded). The Date & Time control is further explained on subsection 4.2.

The Map Display shows the maps based on the currently loaded layers. A small set of tools, located in the upper right corner of the Map Display (represented on Figure 24 3), allows panning, zooming and querying the map. At the right side of the Map Display appears the legend of the currently loaded layers (see Figure 24 2).

MOHID Studio - User Guide 42.png
Figure 2 4 3: Map Display controls.

Some functions which can be accessed from the "Map" menu can also be accessed from the context accessible from the Layers List (Figure 4 4).

MOHID Studio - User Guide 43.png
Figure 2 4 4: Accessing map options from the context menu.

Date & Time

The Date & Time control allows to change the date and time of visualization, displaying the results on the Map window. When pressing "play" (see Figure 24 5) the results from the simulation will be played and will be displayed as an animation on the Map window.

MOHID Studio - User Guide 44.png
Figure 2 4 5: Date & Time control.

The start time and end time can be changed as well as the step between displayed times. To change these settings press on the green clock (the button on the right of Date & Time control – see Figure 24 5). The time displayed can be changed in the Current Time window as shown on the Figure 24 6.

MOHID Studio - User Guide 45.png
Figure 2 4 6: Current Time Window.

Start time, End time and the Step configure how the Date & Time Control will behave. By adding a new layer, these values are automatically updated.

Maximum Offset (Max. Offset, on Figure 24 6) is the time span which is used to look for data inside time based layers (HDF Files). The GIS engine will only display data sets which instant is greater than the current display time less the maximum offset and lower than the current display time plus the maximum offset.

The time step is the time the application waits before displaying the next frame, after pressing the "Play" button.

Layers General Properties

Layers loaded into MOHID Studio’s GIS have common properties: (i) if they are to be displayed (enabled/disabled), (ii) minimum/maximum zoom visible, and (iii) layer name.

Enabled layers are displayed in the map on top of each other, considering the same order as shown in the Layers Lists (the top layer in the Layers List is the topmost layer in the Map Display). Layers can be moved, up and down, through the context menu or through the buttons "Move up" or "Move Down" in group the Manage Layers from Map menu (see Figure 24 1). Layers can be enabled / disabled by checking / unchecking the box in the "Visible" column in the Layers List.

The properties of a layer (see subsection 4.10) can be accessed by: (i) double clicking over it on the Layers List, (ii) selecting "Properties" from context menu of the Layers List or (iii) by pressing F4.

Raster Layers

Raster layers are mainly used to display some background in the map. MOHID Studio supports two main types of raster layers: (i) raster collections from georeferenced images and (ii) raster images from WMS server.

Raster Collections

Raster Collection are a set of georeferenced raster images which are stored on your computer. These images can be added by pressing the button "Local Raster" on the Background group from the Map menu (see Figure 24 1). A window like the one represented in Figure 24 7 will appear to configure the Raster Collection. Here it is possible to add or remove individual images to the raster collection.

Individual raster images must be georeferenced. This means that these images are either images which contain information about their georeference (example: GeoTiff) or that there is an additional file which contains the georeference information (ESRI world file - *.jpw).

For large raster collections, and for raster collection with different resolutions, the option to set the minimum and maximum visibility level is particularly useful. This allows MOHID Studio to show always an image with the appropriate resolution, without being very memory demanding.

For example, if the user pretends to use the Blue Marble collection[5] as a background image, Table 11 shows the typical resolution configuration for minimum and maximum visibility levels.

MOHID Studio - User Guide 46.png
Figure 2 4 7: Adding Raster Collections.
Resolution Minimum Visibility Maximum Visibility
250m 0.0 1.0
1km 1.0 10.0
4km 10.0 30.0
16km 30.0 Infinite
Table 1 1: Examples for visibility levels (Blue Marble image gallery.
MOHID Studio - User Guide 47.png
Figure 2 4 8: Displaying a Raster Layer in MOHID Studio.

WMS Layers

WMS Layers[6] are provided by online servers over the Internet. MOHID Studio has two preconfigured WMS Servers: (i) Demis Map and (ii) JPL Nasa. WMS Layers can be added by selecting "WMS" on the Background group from the Map menu (see Figure 24 1). A window like the one represented on Figure 24 9 will appear. In this is possible to select from one of the predefined WMS Servers or to add the name address (URL) to a user defined WMS Server. After selecting the server, press the "Get Layers" button to obtain the list of possible WMS layers.

NOTE: There are several different WMS versions. MOHID Studio only supports WMS versions 1.0.0, 1.1.0, 1.1.1 and 1.3.0.

MOHID Studio - User Guide 48.png
Figure 2 4 9: Adding WMS Layer.

The Figure 24 10 shows an example of the WMS layer for Europe (from DEMIS map) inside the MOHID Studio.

MOHID Studio - User Guide 49.png
Figure 2 4 10: Displaying a WMS layer in MOHID Studio.

Web Tiles

MOHID Studio can display, as background image, tiles from Google Maps, Bing Maps and Open Street Map. Web Tiles[7] layers can be added by pressing the "Web Tile" button on the group Background from the Map menu (see Figure 24 1). The Load Tile Layer window, represented on Figure 24 11 will appear. In this window is possible to select one of the supported Web Tile providers list.

MOHID Studio - User Guide 50.png
Figure 2 4 11: Adding Web Tile Layer.

NOTE: When adding Web Tile layers, the map projection must be set to Web Mercator (more information on subsection 4.13).

On Figure 24 12 is represented an example of a simple application using the Web Tile Layer (Google Satellite) in MOHID Studio.

MOHID Studio - User Guide 51.png
Figure 2 4 12: Displaying a Web Tile layer in MOHID Studio.

MOHID ASCII Layers

MOHID ASCII layers are special layers to load files which contain simplified information about geometries specific to the usage of MOHID Water Modelling System. These layers include: (i) XYZ Points, (ii) Grids, (iii) Grid Data, (iv) Drainage Network and (v) Polygons.

As an example, Grid Data files are used by MOHID Water to read information about the bathymetry.

Some tools included into MOHID Studio use information from this layer while other tools help to create specific MOHID ASCII Files.

As an example, to create a bathymetry (Grid Data File) it is necessary to load:

  • The base data (in form of a XYZ Points layer);
  • Information about the grid in form of a Grid Layer;
  • Information about non compute areas in form of a polygon file.

XYZ Points layer

XYZ Point layers are loaded from XYZ Files (for more information read subsection 10.1.2) and are used as input to create Grid Data Files. A XYZ Point layer can easily be added by pressing the button "XYZ Points" on ASCII group from the "Map" menu (see Figure 24 1).

After selecting a valid XYZ file, a window like the one represented in Figure 24 13 will appear. By default, the layer name is generated based on the filename, the minimum and maximum visibility are set to "always" visible and the layer style is set to the default’s gradient style, respecting the minimum and maximum values found in the XYZ file.

MOHID Studio - User Guide 52.png
Figure 2 4 13: Adding a XYZ Point vector layer.

On the Figure 24 14 is represented an example of a XYZ Point Layer displayed in MOHID Studio.

MOHID Studio - User Guide 53.png
Figure 2 4 14: Displaying a XYZ Point layer.

Grid layer

Grid layers are loaded from Grid files (for more information read subsection 10.1.5). A Grid layer can be added by pressing the button "Grid" in ASCII group from the "Map" menu (see Figure 24 1). The process of adding a Grid Layer is similar to the process of adding a XYZ Point layer (read subsection 4.5.1). On the Figure 24 15 is represented a Grid Layer showing part of a curvilinear grid.

MOHID Studio - User Guide 54.png
Figure 2 4 15: Displaying a Grid layer.

Grid Data layer

Grid Data layers are loaded from Grid Data files (for more information read subsection 10.1.6). A Grid Data layer can be added by pressing the "Grid Data" button on ASCII group, from the "Map" menu (see Figure 24 1). The process of adding a Grid Data layer is similar to the process of adding a XYZ Point layer (read subsection 4.5.1). On the Figure 24 16 is represented a Grid Data Layer of the bathymetry of the Tagus Estuary.

MOHID Studio - User Guide 55.png
Figure 2 4 16: Displaying a Grid Data layer.

Drainage Network layer

Drainage Network layers are loaded from Drainage Network files (for more information read subsection 10.1.7). A Drainage Network layer can be added by pressing the "Drainage Network" on the ASCII group, from the "Map" menu (see Figure 24 1). The process of adding a Drainage Network layer is similar to the process of adding a XYZ Point layer (read subsection 4.5.1). On the Figure 24 17 is represented a Drainage Network Layer of the Trancão Watershed.

MOHID Studio - User Guide 56.png
Figure 2 4 17: Displaying a Drainage Network layer.

Polygons layer

Polygons layers are loaded from Polygon files. A Polygon layer can be added by pressing the "Polygons" button on the ASCII groups from the "Map" menu (see Figure 24 1). The process of adding a Polygon Layer is similar to the process of adding a XYZ Point layer (read subsection 4.5.1). On the Figure 24 18 is represented a Polygon Layer representing the boundaries of a watershed.

MOHID Studio - User Guide 57.png
Figure 2 4 18: Displaying a Polygon layer.

HDF Files

MOHID uses HDF files to store information about large data sets. Within MOHID, HDF files are primarily used to store model results, but they may also be used to provide boundary conditions or initial conditions.

MOHID uses HDF files with some special groups / datasets, in order to store time based and georeferenced data sets. Dataset can apply to grid based (sometimes referenced as polygon based) datasets, vector field datasets, drainage network data sets and lagrangian particle data sets.

Grid Map

HDF Grid Map layers are the most common HDF layers used in MOHID Studio. A HDF Grid Map layer allows to display the temporally evolution of a grid based property from the information stored in a single HDF file. An HDF Grid Map layer can be added by pressing "HDF Map" in HDF group from the "Map" menu (see Figure 24 1).

After selecting a valid HDF file, a window like the one represented in Figure 24 19 will appear.

This window (see Figure 24 19) has several options about which and how the data is presented:

  • "Feature" – From the drop down box it is possible to select the property to represent on the map;
  • "Mapping" – from the drop down box it is possible to select the type of mapping (Water points or Open points);
  • "Geo Dataset" – Coordination type: if it is metric, select Connection X / Connection Y, if it is geographic coordinates, select Latitude / Longitude);
  • "Slice" - the horizontal layer (by default this property is set to the top most layer.
MOHID Studio - User Guide 58.png
Figure 2 4 19: Adding a Grid Map vector layer.

The other options available on this window, represented in the Figure 24 19, have been already explained in this manual.

After adding a HDF Grid Map layer, the time animator window will be enabled (Date & Time controller, located below the Layer List – represented in Figure 24 2). Using this animator it is possible to loop trough individual layers of the HDF Grid Map. To start or stop the animation use the Date & Time Controller (read subsection 4.2).

Vector (Arrow) Map

HDF Vector Field layers are used in MOHID Studio to display the temporally evolution of a vector field based on the information stored in a single HDF file. HDF Vector Field layer can be added by pressing "Vector Field" on the HDF group from the "Map" menu (see Figure 24 1). The window that will open is similar to the one represented in Figure 24 19, with the difference that the available features are vector fields (with X and Y components). In Figure 24 20 is represented a Vector Map of the current velocity at the Tagus Estuary Mouth.

MOHID Studio - User Guide 59.png
Figure 2 4 20: Displaying a Vector Map.

Drainage Network Map

HDF Drainage Network layers are used in MOHID Studio to display the temporally evolution of properties inside a drainage network based on the information stored in a single HDF file. A HDF Drainage Network layer can be added by pressing the "Drainage Network" button on the HDF group, from the "Map" menu (see Figure 24 1). A window like the one represented in the Figure 24 19 will appear in order to configure the HDF layer.

Lagrangian Particle Map

HDF Lagrangian Particle layers are used in MOHID Studio to display the temporally evolution of properties of lagrangian particle, based on the information stored in a single HDF file. A HDF Lagrangian Particle layer can be added by pressing "Particle Field" on the HDF group from the "Map" menu (see Figure 24 1). The window that will be open is similar to the one represented in Figure 24 19.

Other Vector Layers

Besides the MOHID specific vector data formats listed previously, MOHID ASCII Layers (see subsection 4.5) and HDF Files (see subsection 4.6), other vector layers can be loaded into MOHID Studio’s GIS engine. Providers of these layers are: (i) ESRI Shapefiles, (ii) XML Geometries and (iii) HGT Layers.

ESRI Shapefiles Layers

ESRI Shapefiles are widely used to store geographic data. Layers based on data from ESRI Shapefiles can be loaded to MOHID Studio by pressing the button "SHP" (Shapefile) on group Vector Data from the "Map" menu (see Figure 24 1). A window similar to the one represented in Figure 24 13 will appear, after selecting the shapefile to open.

XML Geometry Layers

XML Geometries are layers based on XML files which contain geometries stored by MOHID Studio (see subsection 10.2). Layers based on XML Geometry files can be easily loaded into MOHID Studio, by pressing the button "XML" (XML Geometry) on Vector Data group from the "Map" menu (see Figure 24 1). After selecting the xml to open a window similar to the one that is represented in Figure 24 13 will pop out in order to configure the new layer.

HGT Layers

HGT layers are based on NASA SRTM (Shuttle Radar Topography Mission) files and are the main source for building digital terrains for MOHID Land. HGT Layers can be added by pressing the button "HGY" (NASA HGT) on group Vector Data from the "Map" menu (see Figure 24 1). A window like the one represented in Figure 24 21 will appear.

MOHID Studio - User Guide 60.png
Figure 2 4 21: Adding a HGT vector layer.

In the HGT Vector Layer window (represented in Figure 24 21) is necessary to specify the geographic region for which the HGT layer is to be loaded: (i) the current view or (ii) the boundaries of a given layer.

After selecting the region, the necessary HGT files will be automatically downloaded from NASA’s FTP server and cached on your local computer.

NOTE: Downloading and displaying HGT layers for big areas can be time consuming and generate a lot of internet traffic. It is recommended that the user should not try to load HGT layers that cover more than 4 square degrees at once.

Label Layers

Label layers are a special kind of layer which allows to quickly obtain information about the numerical data represented by a given vector layer. Label layers can be created be choosing "Create Label Layer" from the context menu in the Layers List. In the Figure 24 22 is represented an example showing how to create a label layer from a vector layer.

MOHID Studio - User Guide 61.png
Figure 2 4 22: Creating a Label layer.

Moving Layers

Layers are displayed in the map on top of each other, considering the same order as shown in the Layers List (the topmost layer in the Layers List is also the topmost layer in the Map Display). Layers can be moved up and down through the context menu of the Layers List or by pressing the buttons "Move Up" or "Move Down" in the Manage Layers group from the "Map" menu (see Figure 24 1). Layers can also be removed from the map through the context menu of Layers List or by pressing "Remove" on Manage Layers group from the "Map" menu (see Figure 24 1).

Layer Styles

Vector layers are rendered based on their current layer style. Layer styles can be "simple" or based on the feature data which is represented. Different layer styles can be applied to different vector layers, depending on the type of the style and type of the layer.

Layer styles of a given layer can be accessed by selecting "Edit" in the layers properties window. In the Figure 24 23 is represented an example of how to access the layer style.

NOTE: Properties of a layer can be accessed by: (i) double clicking over it on the Layers List, (ii) selecting "Properties" from context menu of the Layers List (see Figure 24 4) or (iii) by pressing F4.

MOHID Studio - User Guide 62.png
Figure 2 4 23: Editing the layer style.

MOHID Studio allows creating style templates to reuse as predefined layer styles. Template styles can be applied by hitting the "Apply" button, represented in Figure 24 23.

Simple Vector Style

A simple vector style can be applied to almost any type of vector layers. A simple vector style renders all geometries in the same way, independent of the feature data.

Simple Vector Styles are applied by default to MOHID ASCII Polygon layers, XML Geometry layers and ESRI Shapefile layers.

In the Figure 24 24 is represented the window which allows configuring a simple vector style. Depending on the geometry to be rendered, different styles are used:

  • Points are represented by the symbol;
  • Lines are drawn with the line color / width and optional and outlined with the outline color / width optional;
  • Polygons are filled with the fill color, using the alpha value as transparency and optional outlined with the outline color / width.
MOHID Studio - User Guide 63.png
Figure 2 4 24: Configuring a simple vector style.

In the Figure 24 25 it is possible to see two images of the same map but using different simple vector styles. On the first map, the top map, country borders are represented by simple yellow lines and the cities are represented with white markers. On the second map, the bottom one, the country borders are represented by black lines, the areas are filled in with transparency and the cities are represented with green circle markers.

MOHID Studio - User Guide 64.png
MOHID Studio - User Guide 65.png
Figure 2 4 25: Showing different simple vector styles.

Gradient Layer Style

Gradient layer style can be applied to almost any type of vector layers. A gradient layer styles render geometries based on the feature data, applying a gradient color scale between a minimum and a maximum value.

Gradient Layer Styles are applied, by default, to MOHID Grid Data layers, HDF Grid Map Layers, HDF Drainage Network Layers and HDF Lagrangian Layers.

In the Figure 24 26 is represented the window where is possible to configure a gradient layer style and in the Figure 24 27 is represented, in MOHID Studio, a grid data layer with a gradient layer style applied.

MOHID Studio - User Guide 66.png
Figure 2 4 26: Configuring a gradient layer style.
MOHID Studio - User Guide 67.png
Figure 2 4 27: Showing a gradient layer style.

Transparency Layer Style

Transparency Layer Style can be applied to almost of any type of vector layers. A transparency layer style render geometries based on the feature data consist on a transparency color scale between a minimum and a maximum value.

In the Figure 24 28 is represented the window to configure a gradient layer style and in the Figure 24 29 is represented the grid data layer with a transparency layer style applied.

MOHID Studio - User Guide 68.png
Figure 2 4 28: Configuring a transparency layer style.
MOHID Studio - User Guide 69.png
Figure 2 4 29: Showing a transparency layer style.

Classified Layer Style

Classified Layer Style can be applied to almost any type of vector layers. A classified layer style renders geometries based on the feature data consists on a classified color scheme (each color is defined between a range of values).

The Figure 24 30 shows the window to configure a classified layer style and in the Figure 24 31 is represented a grid data layer with a classified layer style applied.

MOHID Studio - User Guide 70.png
Figure 2 4 30: Configuring a classified layer style.
MOHID Studio - User Guide 71.png
Figure 2 4 31: Showing a classified layer style.

Arrow Layer Style

Arrow Layer Styles are the only type of styles which can be applied to vector fields. Arrow layer styles render arrows with a given color. The size of arrows is based on a linear correspondence between a minimum and maximum modulus values of the vector and the minimum and maximum pixel sizes of the arrows.

In the Figure 24 32 is represented the window to configure the Arrow Layer Style and in the Figure 24 33 is the represented, in MOHID Studio, the application of the arrow layer style to a vector field layer.

MOHID Studio - User Guide 72.png
Figure 2 4 32: Configuring an arrow layer style.
MOHID Studio - User Guide 73.png
Figure 2 4 33: Appling of an arrow layer style to a vector field layer.

Style Templates

MOHID Studio allows the user to define several style templates to use in different workspaces. To define a new style templates (or modify an existing one), press the button "Style Manager" on the group Manage Layers from the "Map" menu (represented in Figure 24 1). A window like the one represented in Figure 24 34 will appear. Here it is possible to add, edit or remove style templates.

Style templates can be applied to a layer, by selecting "Apply" in the layer style properties window (represented in Figure 24 23).

MOHID Studio - User Guide 74.png
Figure 2 4 34: Managing Style Templates.

Querying Data

Data displayed by vector layers can be queried and displayed in a tabular form. In order to perform a query, on a given layer, it is necessary to select first, in the Layers List, the chosen layer to perform the query. After selecting the layer, the selected row will turn orange. Now, it is possible to query the data by activating the query tool from the map tool box (as shown in Figure 24 3) and then selected region or draw one (by pressing the left mouse button) where to perform the query. The results of the query will be displayed in the query result window. In the Figure 24 35 is represented the operation of querying the map.

MOHID Studio - User Guide 75.png
Figure 2 4 35: Querying the Map.

Saving Images

MOHID Studio allows to saves the current map as an image or as an animated gif. To save a single image or an animation, press the button "Save Image" or "Save Animation" on group Images, from the "Map" Menu (see the Figure 24 1). A window similar to the one represented in Figure 24 36 will appear, in order to configure the image/animation to save.

From this window, represented in Figure 24 36, is possible to configure the layout of the image to be saved, for example: legends, north arrow, scale used and marker lines. By pressing the "Save" button, the image or animation will be saved in the selected path with the selected filename.

MOHID Studio - User Guide 76.png
Figure 2 4 36: Save Map as image.

Coordinate Transformation

MOHID Studio supports coordinate transformation on the fly, so layers with different coordinate system can be overlaid. Whenever a new layer is added to the map, the information about its coordinate system must be provided. This happens every time a new layer is added through the dialog boxes (which have been presented previously in the section, for example: Figure 24 11 and Figure 24 13). In each of these dialog window appears a box, represented in Figure 24 37. Using this box it is possible to specify the coordinate system of a given layer.

MOHID Studio - User Guide 77.png
Figure 2 4 37: Layer Coordinate System.

MOHID Studio map displays the layers in its own coordinate system. The current map coordinate system can be changed through the general map configurations. The map configurations are accessible through the small icon located in the upper right area of the map window (highlighted in the Figure 24 38). The map configurations windows is represented in the Figure 24 39.

MOHID Studio - User Guide 78.png
Figure 2 4 38: Access to map configurations (highlighted button).
MOHID Studio - User Guide 79.png
Figure 2 4 39: Map configurations.

Graph Visualization

Introduction

MOHID Studio uses a customized graph engine to display time series in from of XY Graphs. The series can be loaded directly from MOHID ASCII Time Series files or from MOHID Studio’s database.

Tasks related with Graph Visualization can be performed from the "XY Graph" menu (represented in Figure 25 1).

MOHID Studio - User Guide 80.png
Figure 2 5 1: XY Graph menu.

Time Series are displayed in "XY Graph Windows" (represented in Figure 25 2). "XY Graph Window" is divided in two main areas: (i) the Series List, on the left side, and (ii) the Series Display graph, on the right side of the window. "XY Graph Window" will open a new tab and will be placed next to the tab "Explorer" and "Map".

MOHID Studio - User Guide 81.png
Figure 2 5 2: XY Graph window.

The Series List contains series that are currently loaded and on the Graph Display are represented the series graph. A small set of control tools, located in the upper right corner of the Graph Display, allows panning, zooming and querying the series graph (represented in Figure 25 3).

MOHID Studio - User Guide 82.png
Figure 2 5 3: XY Graph controls.

Graph Windows

Graph windows can be created by several different ways: (i) opening a MOHID ASCII Time Series File, (ii) loading a series from MOHID Studio’s database, (iii) loading a previously saved Graph Window or by (iv) opening a series from MOHID Studio’s Explorer window.

After selecting one of any these four options, the Time Series Selection window (represented in the Figure 25 4) will appear. Through this window is possible to choose the time series that will appear on graph. To select a time series check the row, on the field "Load", (on the upper part of the window see Figure 25 4). It is possible to select on or more time series. After selecting the time series, to be loaded in the graph window, choose if they will be displayed on a new graph window or added to an existing window (lower part of window, see Figure 25 4). If you select to add on an existent window, select in which one is to be loaded. The XY Graph windows can be renamed to easily identify them (lower part of window, see Figure 25 4).

MOHID Studio allows select a chosen chart style. The chart styles available are available on a dropdown box. If none of the chart styles is selected, MOHID Studio will use the default chart style.

MOHID Studio - User Guide 83.png
Figure 2 5 4: Time Series Selection Window.

Create from MOHID ASCII Time Series File

A new Graph Window, using a MOHID ASCII Time Series File as initial source, can be created by pressing "New (File)" on Graph Windows group from the "XY Graph" menu (see Figure 25 1). After selecting a file, containing one or more time series, the Time Series Selection Window will be shown (represented in Figure 25 4). After selecting one or more series press the "Ok" button and the new graph window will be created.

Create from MOHID Studio’s database

A new Graph Window, using a MOHID Studio’s database as initial source, can be created by selecting "New (DB)" on Graph Windows group from the "XY Graph" menu (see Figure 25 1). This brings up immediately the Time Series Selection Window (represented in Figure 25 4) with all available series from the MOHID Studio’s database. After selecting one or more series press the "Ok" button and the new graph window will be created.

Closing a Graph Window

A Graph Window can be closed by pressing the button "Close" on the Graph Windows group from the "XY Graph" menu (see Figure 25 1). This will close the current Graph Window. It is also possible to close the Graph Window by clicking in the XY Graph window with the middle mouse button or press the cross in the upper right corner of the window (represented in Figure 25 5).

MOHID Studio - User Guide 84.png
Figure 2 5 5: Close XY Graph Window.

Saving a graph window

A graph window can be saved, including all the series and associated data. To save a graph window press the button "Save" on Graph Windows group from the "XY Graph" menu (see Figure 25 1). This will save the entire graph as an XML file and can be loaded at any time.

Open/Load a saved graph window

A graph window can be created from a previously saved XML file (see subsection 5.2.4). To open a previously saved graph window, press the button "Load" on Graph Windows group from the "XY Graph" menu (see Figure 25 1). The graph will be displayed with all series and settings previously saved.

Create from Explorer

It is also possible to create graph windows directly from MOHID model results. This can be easily done, after the model execution is complete, by double clicking over a given Time Series file listed in the Explorer window (under the Time Series Files group), as represented in Figure 25 6. Another way to create a graph from the explorer window, is to select the chosen Time Series file, as represented in Figure 25 6, and click on the first button from the left on the Time Series Files group (the button is highlighted in Figure 25 6).

MOHID Studio - User Guide 85.png
Figure 25 6: Open Graph windows from Studio Explorer.

Series

Adding Series

Series can be added, as mentioned previously (see subsection Erro! A origem da referência não foi encontrada.</center>), from MOHID ASCII Time Series Files or directly from MOHID Studio’s database. The processes of adding series to an existent Graph Window is the same as create a new window, the only change needed is to select the option "Add to an existent graph" on Series Selection window (see Figure 25 4).

Series can also be added to a graph by pressing "Add (File)"/Add (DB) in group Series from the "XY Graph" menu (see Figure 25 1).

Removing Series

Series can be removed from a graph by pressing "Remove" in group Series from the "XY Graph" menu (see Figure 25 1).

Graph Layout

MOHID Studio’s XY Graph window allows the user to configure the all layout area of the graph. To configure the Graph are use the Property Window.

Property Window

The properties of the XY Graph Window can be easily changed by pressing the top right button, from the XY Graph Window (highlighted in Figure 25 7). After pressing the property window button a new window will opened (represented in Figure 25 8).

MOHID Studio - User Guide 86.png
Figure 2 5 7: Graph property window.

In the Graph properties window is possible to change the layout area of the graph (for example: background color, the series palette, series legend and so on).

Templates

MOHID Studio’s Graph engine allows creating completely costumes layout of graphs, save these layouts as templates and then they can be applied as template to other graphs.

The Graph’s layout can be saved by pressing the button "Save Layout" on Image group from the "XY Graph" menu (see Figure 25 1). The Layout will be saved as an XML file.

To apply a saved layout, after the graph is loaded, press the button "Apply Layout" on Image group from the "XY Graph" menu (see Figure 25 1). Then choose a saved template (XML file) and press the button "apply". The layout will instantly be applied to your graph.

MOHID Studio - User Guide 87.png
Figure 2 5 8: XY Graph Property Window.

Save image

MOHID Studio’s Graph window also allows the user to save the graph as an image file. To save an image file with your graph press the button "Save" on Image group from the "XY Graph" menu (see Figure 25 1). Then select the location and the name for the image file and press "Save". The image file types available are: BMP, GIF and PNG.

Series layout

Series can be individually configured in the "Series Properties" box (represented in Figure 25 9), located below the Series List (see Figure 25 2). For more specific properties press the button "more".

MOHID Studio - User Guide 88.png
Figure 2 5 9: Series Properties.

Axis Properties

The graph axis can be also configured. To configure the axis use the "Axis Properties" box (represented in Figure 25 10), located below the Series List (see Figure 25 2). For more specific properties press the button "more".

MOHID Studio - User Guide 89.png
Figure 2 5 10: Axis Properties.

Small Graphs

Small graph is a tool of MOHID Studio that allows the user to have small graphs in a dockable window. This window is very useful to monitoring real time values. This window, by default, opens on the right side of MOHID Studio and will be auto hided.

To open a new small graph press the button "Add" on Small Graph group from the "XY Graph" menu (see Figure 25 1). Choose the Time Series File you desire to open and press "Open". The new small graph will be loaded to the "Small Graph Window". An example of a Small Graph is represented in Figure 25 11.

MOHID Studio - User Guide 90.png
Figure 2 5 11: Small Graphs.

Tools

Introduction

MOHID Studio contains a set of tools. The majority of these tools works interactively over the Map Visualization and provides the possibility to generate MOHID specific data files.

MOHID Studio Tools can be easily accessed from the "Tool" menu, represented in Figure 26 1.

MOHID Studio - User Guide 91.png
Figure 2 6 1: Tool menu.

MOHID Studio tools are divided into: (i) geometry layers creation, (ii) grid creation, (iii) grid data tools, (iv) watershed tools, (v) time series tools, (vi) HDF tools and (vii) boxes tools.

MOHID Studio tools work interactively over the map. Some tools require creating one or more temporary layers. These layers are automatically added to the map when the tool is started and automatically removed after the tool is closed. Since MOHID Studio tools work interactively over the map, MOHID Studio does not allow more than one tool to be used simultaneously.

MOHID Studio tools are explained, in detail, along the next subsections. All tools are provided with a help window, located on the bottom of the tool window. To display the help window click over the "Show help" text (presented in Figure 26 2).

MOHID Studio - User Guide 92.png
Figure 2 6 2: Show help – To open the help window.

Geometry Layer Tools

Geometry layers tools allow creating geometries interactively over the map. Normally, geometries created with this tools, are used afterwards by other tools (e.g. points can be used to create time series locations, polygons to define non compute areas and so on).

Named Points

The Named Points tool allows creating XML Geometry file with points. This tool can be activated by selecting Named Points on Geometry Layer group from the "Tool" menu (see Figure 26 1). The tool window will appear docked on the right side of the main window as shown in Figure 26 3.

MOHID Studio - User Guide 93.png
Figure 2 6 3: Creating Named Points.

With the use of this tool it is possible to create a list of points. Points can be added to the list by pressing the button "Draw" (this button will turn orange) and afterwards click on the map, to mark the points. When clicking on the map a new marker is added to the map and the list of points is updated, adding the new point. The point location and name can be edited by double clicking over the list shown under "Defined Points". It is possible to remove the current selected point, by pressing the "Remove" button, or to remove all points, by pressing the "Clear List" button. The current list can be saved, as an XML Geometry file, by clicking the "Save" button.

Named Lines

The Named Lines tool allows creating XML Geometry file with lines. This tool can be activated by clicking the Named Lines button on Geometry Layer group from the "Tool" menu (see Figure 26 1). The tool window will appear docked on the right side of the main window as shown in Figure 26 4.

MOHID Studio - User Guide 94.png
Figure 2 6 4: Creating Named Lines.

Using this tool it is possible to create a list of lines. Lines can be added to the list by pressing the button "Draw" (this button will turn orange) and afterwards click on the map, to add the vertices. Each click on the map adds a single vertex to the line. The line is ended by double clicking the last point. Line names can be edited by double clicking over the list shown under "Defined Lines". Lines can be removed from the list using the button "Remove", deleting the current line, or using the button "Clear List", deleting all the lines from the map. The current list can be saved, as a XML Geometry file, by selecting the "Save button".

Named Polygons

The Named Polygons tool allows creating XML Geometry file with polygons. This tool can be activated by clicking the Named Polygons on Geometry Layer group from the "Tool" menu (see Figure 26 1). The tool window appears docked on the right side of the main window as shown in Figure 26 5.

MOHID Studio - User Guide 95.png
Figure 2 6 5: Creating Named Polygons.

Using this tool it is possible to create a list of polygons. Polygons can be added to the list by selecting the button "Draw" (this button will turn orange) and afterwards click on the map, drawing the polygons. Each click on the map adds a vertex to the polygon. The polygon is closed by double clicking the last point. Polygon names can be edited by double clicking over the list shown under "Defined Polygons". Polygons can be removed from the list using the button "Remove", deleting the current selected polygon, or using the button "Clear List", deleting all the polygons. The current list can be saved, as a XML Geometry file, by selecting the "Save" button.

XYZ Points

The XYZ Points tool allows creating MOHID ASCII XYZ file with points. This tool can be activated by pressing the button "XYZ Points" on Geometry Layer group from the "Tool" menu (see Figure 26 1).

The XYZ Points tool works very similarly as the "Named Points" tool (for more information about the "Named Points" tool can be founded in subsection 6.2.1 of this manual).

Grid Tools

Grid tools allow creating grids interactively over the map and to refine existing grids for nested models.

Constant Grid

Constant grids can be created by pressing the button "Constant" on Grids group from the "Tool" menu (see Figure 26 1). The tool window appears docked on the right side of the main window as shown in Figure 26 6.

MOHID Studio - User Guide 96.png
Figure 2 6 6: Creating Constant Grid.

The constant grid can be defined on the "Grid Parameters". There are two ways to set the origin of the grid:

  • introducing manually the origin values of the X and Y coordinates;
  • press the button "Pick…" (the button will turn orange) and then click on the map to set the origin of the grid (lower left corner).

The number of columns and rows can be set in the JUB and IUB fields, respectively. The horizontal and vertical grid step can be set in the dX and dY fields and the grid angle in the Angle field. The "Coordinates" box allows selecting the grid coordinates (MOHID internal format). Recommended options are:

  • 4 for geographic coordinates
  • 5 for metric (local) coordinates

After changing any options the grid can be visualized by selecting the "Refresh" button, under the "Preview". It is also possible to set the window to auto update mode (by checking the "Auto Update" box).

The Constant Grid created can be saved, as MOHID ASCII file, by pressing the "Save" button.

Variable Spaced Grid

Variable spaced grids can be created by selecting "Variable" on Grids group from the "Tool" menu (see Figure 26 1). The tool window appears docked on the right side of the main window as shown in Figure 26 7.

MOHID Studio - User Guide 97.png
Figure 2 6 7: Creating Variable Grid.

The variable spaced grid can be defined on the "Grid Parameters". There are two ways to set the origin of the grid:

  • introducing manually the origin values of the X and Y coordinates;
  • press the button "Pick…" (the button will turn orange) and then click on the map to set the origin of the grid (lower left corner).

The variable spaced is set in the XX and YY fields. Here accumulated values (starting at zero), for the grid edges must be specified. It is recommended to use an application like Microsoft Office Excel to generate the XX and YY values.

The other options Angle and Coordinates, works in the same way as for the constant spaced grid (please read the subsection 6.2.1).

After changing any options the grid can be visualized by selecting the "Refresh" button, under the "Preview". It is also possible to set the window to auto update mode (by checking the "Auto Update" box).

The Variable Spaced Grid created can be saved, as MOHID ASCII file, by pressing the "Save" button.

Refine Grid

Nested Grids[8] can be created by pressing the button "Nested" on Grids group from the "Tool" menu (see Figure 26 1). The tool window appears docked on the right side of the main window as shown in Figure 26 8. The Nested Grid Tool it is only available when a Grid layer is loaded on the map.

MOHID Studio - User Guide 98.png
Figure 2 6 8: Created Nested Grid.

To create a new Nested Grid, first select the main grid, from the drop down box "Grid" on the "Select Grid" box. Then select the position for the nested grid using the mouse, by pressing the button "Pick…." and then pressing the grid, or by supplying the lower and upper bound in the text boxes from "Select Area".

The Nested Grid created can be saved, as MOHID ASCII file, by pressing the "Save" button.

Grid Data Tools

Grid Data tools allow creating and modifying MOHID Grid Data files. MOHID Grid Data is used to provide MOHID data on a per grid cell basis (for example: bathymetry, topography, etc.).

Using MOHID Studio’s Grid Data Tools, grid data can be created from a set of points or from a set of polygons.

Creating Grid Data from Points

Grid Data can be created from a set of points by pressing the button "From Points" on Grid Data Tools group from the "Tool" menu (see Figure 26 1). This tool is typically used to create the digital terrain model for the MOHID Water (bathymetry) and MOHID Land (topography) models.

Creating a Grid Data from points requires: (i) a grid on which the grid data will be based, (ii) base data (points) which will be used to fill the grid data and (iii) polygons which define non-compute areas (optional).

The tool window appears docked on the right side of the main window as shown in Figure 26 9.

In the "Select Grid" box the desired grid can be chosen. The non-compute areas can be defined by pressing the "Pick" button and then click over the map on the polygon which defines a non-compute area. Several polygons can be selected.

The base information can be either XYZ Data or HGT layers. Multiply sources can be selected. The interpolation option allows choosing the desired interpolation method. After selecting the filename for the final grid data, the process button activates the interpolation process.

For large data sets or large grids, the interpolation process might take a while, be patient. Through the progress bar is possible to analyze the evolution of the process status.

MOHID Studio - User Guide 99.png
Figure 2 6 9: Creating a Grid Data from Points.

Creating Grid Data from Shapefiles

Grid Data can be created from a set of points by pressing the button "From Shape" on Grid Data Tools group from the "Tool" menu (see Figure 26 1). This tool is typically used to create files which contain information about land use, vegetation or soil types for the MOHID Land model.

Creating a Grid Data from ESRI Shapefiles requires: (i) a Grid Data on which the grid data will be based (Non compute areas will remain the same as in the base grid data and (ii) a Shapefile with polygons data. The tool appears docked on the right side of the main window as shown in Figure 26 10.

After selecting the base Grid Data and the source Shapefile, it is necessary to select the feature (e.g. land covers code) on which the value mapping is to be performed. After selecting the desired feature, press the "Analyze" button in order to obtain a list of distinguish features (e.g. forest, urban areas, etc.) in the shapefile. For each feature, a value which will be assigned to the corresponding grid cells must be provided. These values can be saved or loaded by using the "Load" and "Save" buttons, in the Value Mapping box.

MOHID Studio - User Guide 100.png
Figure 2 6 10: Creating a Grid Data from Shapefile (Polygons).

After filling the Value Mapping, the Grid Data file can be created using the "Process" button.

Modifying a Grid Data

Grid Data can be modified by pressing the "Modify" button on Grid Data Tools group from the "Tool" menu (see Figure 26 1). The tool to modify grid data appears docked on the right side of the main window as shown in Figure 26 11.

After selecting the Grid Data to modify under the "Select Grid Data" box, it is possible to select the grid cells to modify over the map, using the "Pick" button. After selecting the grid cells on the map, the selected cells get highlighted and appear in the point list. After all points to modify have been selected, several operations can be performed, by choosing the appropriate options in the "Math Operations" box.

Points can be transformed into "Compute Points" or "Non Compute Points" through the "Open / Close non compute points" box.

MOHID Studio - User Guide 101.png
Figure 2 6 11: Modifying a Grid Data.

After editing the Grid Data, changes can be saved or discarded in the "Persist Changes" box.

Operator a Grid Data

Grid Data can be changed by pressing the "Operator" button on Grid Data Tools group from the "Tool" menu (see Figure 26 1). The tool to operate grid data appears docked on the right side of the main window as shown in Figure 26 12.

MOHID Studio - User Guide 102.png
Figure 2 6 12: Operating a Grid Data.

To open Grid Data Operator tool a grid data file must be loaded to the map. This tool allows modifying grid data files. On the "Select Grid Data" box select the Grid Data 1, and if exist, the Grid Data 2. A selection of points can be created, on the "Select Grid Data Points" box. The values can be added or removing to a selection (depending on the selection behavior selected) and the points can be chosen by using the mouse, by geometry or filter them. In Figure 26 12 is represented a new selection where the only selected points has the value filtered, between a minimum and maximum value defined.

The operations, between the grid data’s are displayed on a drop down box on the Operations box. In this box is possible to create the operation to apply to the all grid data, or only to the selection points.

After the operation is complete is possible to save or discharge all the changes in the "Persist Changes" box.

Create Boxes Tool

MOHID used the concept of boxes in several ways, for example: (i) to initialize properties, (ii) to monitor average concentrations over time or (iii) to release lagrangian particles. MOHID Studio integrates a tool to create boxes from "Named Polygons"

The create box tool allows creating 2D boxes from polygons. This tool can be easily accessed by pressing "Create Box" in the Grid Data Tools group from the "Tool" menu (see Figure 26 1). The tool to operate grid data appears docked on the right side of the main window as shown in Figure 26 13.

Polygons can be drawn directly over the map, using the "Draw" button. After all polygons have been drawn, the boxes file can be saved be selecting the "Save" button, in the "Generate Boxes File".

MOHID Studio - User Guide 103.png
Figure 2 6 13: Creating a boxes file from a set of polygons.

Watershed Tools

Watershed tools allow preparing data files for MOHID Land. These tools include: (i) depression removal, (ii) watershed delineation, (iii) soil depth and (iv) cross section definition.

Depression Removal

MOHID Land requires a depression free digital terrain model in order to run[9]. After constructing a digital terrain model (topography), the depression removal tool can be used to remove depression from it. Depression can be removed by sink filling or by artifact removal.

The depression removal tool can be accessed by pressing the "Remove Depressions" on Watershed Tools group from the "Tool" menu (see Figure 26 1). The tool to remove depressions appears docked on the right side of the main window as shown in see Figure 26 14.

MOHID Studio - User Guide 104.png
Figure 2 6 14: Depression Removal Tool.

The depressions removal process involves several steps. First, the digital terrain (Grid Data) from which the depressions are to be removed must be selected and the existing depressions must be found by using the "Analyze" button. If depressions are found, they are highlighted on the map and listed in the "List of depressions" (an example is represented in Figure 26 14).

Depressions listed, in the "List of Depressions", can be individually removed by selecting the up (remove by sink filling) and down (remove by artifact removal) buttons. Since the removal of a single depression may create new depressions, the list of existing depressions is automatically one individual depression has been removed.

Since the number of depressions can be very high, MOHID Studio includes an algorithm to remove depressions through an iterative process. To execute this, press the "Remove depressions by iterations" button. MOHID Studio will loop through all depressions for the value of "Max. Iteration" (by default the value is 50 times). Depressions containing less than value displayed on the "Max cell filling" (the default value is 5) will be removed by sink filling, others by artifact removal.

NOTE: For very narrow values or very flat areas the depression removal algorithm may not work very well. It may be required to preprocess the digital terrain model first (for instance with the Modify Grid Data tool).

When all depressions have been removed, the depression free Digital Terrain Model can be saved in the "Persist Changes" box.

Watershed Delineation

Watershed delineation has two proposes: (i) specifying which grid cells drain to the outlet (and as consequence distinguishing between compute points and non-compute points) and (ii) creates the drainage network.

The watershed delineation tool can be accessed by pressing the button "Delineate Basin" on Watershed Tools group from the "Tool" menu (see Figure 26 1). The tool to will appear docked on the right side of the main window as shown in see Figure 26 15. This tool, to be opened, requires a depression free Digital Terrain Model.

MOHID Studio - User Guide 105.png
Figure 2 6 15: Watershed Delineation Tool.

The watershed delineation process involves several steps. First the Digital Terrain Model must be selected from the "Select DTM" box.

NOTE: In this box appear all Grid Data layer currently loaded into MOHID Studio’s GIS engine, so it is the user that select the right (depression free) Digital Terrain Model.

The second step is to define the threshold area value, by default is 1000000 m2 (100 ha). This area indicates from which drained upstream area the river channel are formed. The coordinates of the outlet must also be set. They can be obtained using the "Pick" button on the map.

NOTE: Watershed delineation is required in order to run MOHID Land, since MOHID Land can only run with one single outlet. This option is optional, because it can be useful, in a first step, to generate a drainage network for the entire Digital Terrain Model and only in a second step delineate the watershed, since it is easier to locate the outlet over the entire drainage network.

In the "Output Options" box, the desired output of the delineation process is specified. To run MOHID Land, only the drainage network is required. Information about options used during the delineation process should also be stored, since they are required for the Basin Geometry module (Basin Geometry check box). All the other outputs are not required, but may be useful for graphical visualization (namely the "Delineation" – polygon which defines the watershed).

Soil Depth

The Soil Depth tool allows creating additional files for MOHID Land: (i) soil depth, (ii) bottom digital terrain model, (iii) slope and (iv) initial ground water level. This tool can be accessed by pressing the button "Porus Media" on Watershed Tools group from the "Tool" menu (see Figure 26 1). The tool to will appear docked on the right side of the main window as shown in see Figure 26 16.

The Soil Depth tool requires a depression free Digital Terrain Model, which should be selected in the "Select Digital Terrain" box. The parameter to construct soil depth can be set in the "Select Parameter" box. The "Min Depth" and "Max Depth" parameter indicate the minimum and maximum soil depths, respectively. The "Max Slope" parameter indicates the maximum slope which the tool should consider. From these parameters the soil depth is linearly interpolated considering. Grid cells with zero slopes will have maximum soil depth and grid cell with slope greater or equal to the maximum slope will have minimum soil depth.

MOHID Studio - User Guide 106.png
Figure 2 6 16: Soil Depth Tool.

The water table parameter indicates the percentage of the initial water depth, in function to the total soil depth. A value of 0% indicates that the initial water table is close to the bottom, a value of 50% indicates that the initial water table is at half soil depth and a value of 100% indicates that the initial water table is closed to the top (fully saturated soil).

In the "Persist Changes" box the target files can be selected and saved by pressing the "Save" button.

Cross Section Definition

After watershed delineation, the nodes of the drainage network do not contain cross sections. MOHID Land needs to have the cross sections defined, in order to be executed. The Cross Section Definition tool allows defining cross sections for all nodes in a drainage network in a simple way. This tool can be accessed by pressing the button "Cross Sections" on Watershed Tools group from the "Tool" menu (see Figure 26 1). The tool to will appear docked on the right side of the main window, as represented in the Figure 26 17.

Cross section definition involves several steps. In first place it is necessary to define the drainage network, in the "Network" box, for which the cross section will be created. Then the typical cross sections must be defined for one of each Strahler order. Cross sections are defined as trapezoidal ones (top width, bottom width and high). It is possible to define triangular sections by setting the bottom width to zero.

After defining cross sections for all the Strahler orders, of the drainage network, the drainage network file can be saved, by selecting the "Save" button.

MOHID Studio - User Guide 107.png
Figure 2 6 17: Cross Section Definition Tool.

Time Series Tools

Time series tools have two functions: (i) create files which indicate to MOHID model the location of time series and (ii) create files which contain time series.

Grid Time Series Location

The Grid Time Series Location tool allows creating files which contains the grid location of time series points. This tool can be easily accessed by pressing "Grid Location" on Time Series group from the "Tool" menu (see Figure 26 1). The tool to will appear docked on the right side of the main window, as represented in the Figure 26 18.

MOHID Studio - User Guide 108.png
Figure 2 6 18: Grid Time Series Location Tool.

Creating a grid time series location file involves several steps. The first one is to select the grid data which will be used as base. The second one is to specify the locations of the grid points. This can either be done by adding data from a Named Points layer or by selecting the points interactively over the map. The grid data location is generated by clicking on the "Save" button. This tool allows saving, optionally, a XML Geometry file with the point locations. This is useful for display proposes and for later editing of the grid time series location.

Network Time Series Location

The Node Time Series Location tool allows creating files which contains the node location of time series points. This tool can be easily accessed by pressing "Network Location" on Time Series group from the "Tool" menu (see Figure 26 1). This tool works in a similar way as the Grid Time Series Location tool (for more information read the subsection 6.6.1).

Time Series from Database

The Time Series from Database tool allows extracting time series from MOHID Studio’s database, in order to generate boundary conditions from MOHID models. This tool can be accessed by pressing "From Database" on Time Series group from the "Tool" menu (see Figure 26 1). The tool to will appear docked on the right side of the main window, as represented in the Figure 26 19.

MOHID Studio - User Guide 109.png
Figure 2 6 19: Creating a time series from the database.

This tool requires that there has been previously data imported into the database (there are several ways to import values to database, check subsections: 7.4, 7.5 and/or 7.8).

First select the monitoring station and the time series, from the "Select Source Data" box. The start and end date can be defined as well as the default value. After all the parameters are field, MOHID Time Series ASCII file can be generated by clicking the "Save" button.

HDF File Tools

HDF File tools are related to polygon based in HDF Files.

Interpolate HDF Files

The Interpolate HDF File tool allows interpolating one HDF file to a new grid. This tool can be accessed by pressing "Interpolate" on HDF Files group from the "Tool" menu (see Figure 26 1). The tool to will appear docked on the right side of the main window, as represented in the see Figure 26 20.

MOHID Studio - User Guide 110.png
Figure 2 6 20: Interpolating a HDF File to a new grid.

The interpolation/extrapolation method is defined in the second box. The file is being processed by clicking the "Process" button.

NOTE: This tool requires a Digital Terrain Model and a HDF File to be loaded ("Select DTM and Source HDF" box).

Vertical Cuts

The vertical cut tool is allows creating vertical cuts from 3D polygon based HDF File layers. This tool can be accessed by selecting Vertical Cuts on HDF Files from the "Tool" menu (see Figure 26 1). The tool to will appear docked on the right side of the main window, as represented in the see Figure 26 21.

This tool requires a HDF File to be loaded. By using the function draw, by pressing the button "Draw", the "Cut line" can be drawn on the map. The vertical cut is generated by pressing the "Create" button.

After the vertical cut is created it will be displayed in a new tab. The vertical cut will be represented with the same style that is used for the map.

MOHID Studio - User Guide 111.png
Figure 2 6 21: Creating a vertical cut from 3D HDF File.

Environmental Monitoring

Introduction

MOHID Studio contains a set of utilities that allow creating, managing and analyzing Time Series. All utilities related with Time Series (Monitoring Stations, Parameters, etc.) are available through the Environmental Monitoring[10] menu (see Figure 27 1).

MOHID Studio - User Guide 112.png
Figure 2 7 1: Environmental Monitoring.

All Time Series are composed by a Parameter, Monitoring Station, date and a list of values measured or modeled.

Parameters

The Parameter Manager, represented in Figure 27 2, displays the list of all existent parameters. To open this window, press the button "Parameter" on the Base Entities group from the Environment Monitoring menu (see Figure 27 1). In this window is possible to create new parameters, edit or remove existent parameters. The parameters that are associated to existent Time Series cannot be removed. To remove them, the Time Series must be removed first.

The Parameters properties window, represented in Figure 27 3, allows create new parameters or editing existent parameters. The property "Name" is the complete name of the parameter and the "Display name" is the name that will be displayed in all windows and reports of MOHID Studio. The "Display name" field cannot be empty.

MOHID Studio - User Guide 113.png
Figure 2 7 2: Parameters manager.
MOHID Studio - User Guide 114.png
Figure 2 7 3: Parameters properties window.

The property "Units" refers to the units of the parameter. This field is very useful, to know the units of the parameter, but the filling of the field is not mandatory. The numeric format of parameter value can be changed in the property "Display numeric format", by default has the value "N2". Possible numerical displays formats are represented on Table 12 (For example, to show how the numeric formats are displayed is used the number: 123.456789. For percentage format the number used is: 23.45).


Type Format Example
Exponential notation E 1,234568E+002
  E2 1,23E+002
Fixed-point F 123,46
  F3 123,457
General G 123,456789
  G4 123,5
Number N 123,46
  N3 123,457
Percentage P 23,45%
  P1 23,5%

Table 2 2: Display Numerical Formats Examples.

Monitoring Station

The Monitoring Station manager (represented in Figure 27 4) can be accessed by pressing the button "Stations" on the Base Entities group from the Environment Monitoring menu (see Figure 27 1).

MOHID Studio - User Guide 115.png
Figure 2 7 4: Monitoring Station manager.

A Monitoring Station is the place where all parameters are measured or modeled. The Monitoring Station properties window (represented in Figure 27 5) allow to create or editing monitoring station details. The property "Name" refers to the monitoring station name. This name will be the displayed name for the station in all reports and menus from MOHID Studio. There are several station types available, such as: Air Quality, Hydrological, Meteorological, Tide, Water Quality, Waves and Others. The Longitude and Latitude refers to the monitoring station geographical location. It is also possible to add a photo of the monitoring station by clicking in the "Change" button. When the photo is empty, the button label will be "Add…". To remove the photo, press the remove button next to the photo.

MOHID Studio - User Guide 116.png
Figure 2 7 5: Monitoring Station properties window.

Bellow the properties of monitoring station is the list of all-time series that were measured or modeled in this monitoring station. It is possible to add more time series (read more about the Time Series in the subsection 7.4) to this monitoring station and to modify or delete the existent time series.

Time Series

The Time Series Manager (represented in Figure 27 6) displays the list of all the Time Series that exists in the MOHID Studio’s database. It is possible to create new time series and edit or remove the listed time series. To access to this window press the button "Time Series" on the Base Entities group from the Environment Monitoring menu (see Figure 27 1). It is also possible to create a Time Series from the Monitoring Station Properties window, represented in Figure 27 5.

MOHID Studio - User Guide 117.png
Figure 2 7 6: Time Series manager.

To create a new time series or modify to modify an existing one, use the Time Series Manager window (represented in Figure 27 6) and pressing the "Add…" button or the "Edit" button in the Time Series Manager.

The Time Series properties are: Parameter (to add new parameters check the subsection 7.2), Monitoring Station (to add new monitoring stations check the subsection 7.3) and monitoring location (ticket the check box to use the same location as the monitoring station), Modeled Domain and Time Series Type (the types available are: surface, middle, bottom, composed, not defined or unknown).

The Time Series Values are the values that are obtained (by a measured or a modeled result) for a specific instance of time. These values can be created, modified, removed or imported (for more information, see subsection 7.5). To edit any value from the time series value list (date or value) double click, on the selected row, above the selected value to edit.

MOHID Studio - User Guide 118.png
Figure 2 7 7: Time Series Properties window.

Importing and Exporting Time Series

The Import Time Series Files windows (represented in Figure 27 8) allow to importing MOHID ASCII Time Series Files (more information about this file type on the subsection 10.1) to MOHID Studio. To open this window, press the button "Import" on the Base Entities group from the Environment Monitoring menu (see Figure 27 1). It is also possible to import time series from the Time Series Properties window, represented in Figure 27 7.

The easiest way to import time series file, to MOHID Studio, is following the next steps:

1) Choose one MOHID ASCII Time Series Files through the browse button;

2) Select the time series from file to import (if the file only has one time series, it will appear one Time Series);

3) Choose to add to an existent Station / Time Series or Create a new station;

4) Click "import".

To import one or more time series from the same file:

5) Choose the time series;

6) Choose the monitoring station (if a new one was created);

7) Click "import".

MOHID Studio - User Guide 119.png
Figure 2 7 8: Import Time Series window.

If the window before the Import Time Series window was the Time Series properties window (see Figure 27 7), when importing one MOHID ASCII Time Series Files only the first two steps above are requested, followed by pressing the "import" button.

The Export Time Series (to ASCII) window (represented in Figure 27 9) displays all-time series that belongs to MOHID Studio. To export one time series, to MOHID ASCII Time Series Files, press the button "Export" on the Base Entities group from the Environment Monitoring menu (see Figure 27 1). Then select the time series to export, choose the destination path and then press the "Export" button. To learn more about MOHID ASCII Time Series Files check subsection 10.1.

MOHID Studio - User Guide 120.png
Figure 2 7 9: Export Time Series window.

Moving Time Series

Moving Time Series are Time Series that the geographic measured point may change along the time in any direction (Latitude, Longitude and/or Depth). Each measure refers to a specific monitoring station, although the geographic coordinates may vary.

The Moving Time Series windows (represented in Figure 27 10) can be opened by pressing the button "Moving TS" on the Base Entities group from the Environment Monitoring menu (see Figure 27 1). This window display the list of all moving times series that are included in MOHID Studio’s database. Is possible to create, edit or delete moving time series in this window.

The Moving Time Series properties window (represented in Figure 27 11) display all the information about a determine Moving Time Series. All the information may be added or changed in this window, just like in Time Series properties window (see Figure 27 7). In this window is also possible to add a description about the moving time series (for example: "Demo Moving Time Series"). It is also possible to add a short description to the values (for example: "estimated value", "average value", "Error – no value") helping to understand the values latter, if anything goes wrong. To edit the values double click on the value to edit.

MOHID Studio - User Guide 121.png
Figure 2 7 10: Moving Time Series window.
MOHID Studio - User Guide 122.png
Figure 2 7 11: Moving Time Series properties window.

Instead of filling the Moving Time Series properties window, is possible to import a batch of moving time series values, through an XLS File (for more information, please read the subsection 7.8).

Field Campaigns and Visited Points

All the data and files from the field campaigns (photos, sheets, etc.) can be easily organized and stored on a special feature from MOHID Studio. The Field Campaign manager window (represented in Figure 27 12) allows adding, editing or removing field campaigns objects. To open the Fields Campaign window press the button "Field Campaigns" on the Campaigns group from the Environment Monitoring menu (see Figure 27 1).

MOHID Studio - User Guide 123.png
Figure 2 7 12: Field Campaign manager window.

The Field Campaign properties window (represented in Figure 27 13) displays all information about one Field Campaign. The properties of a Field Campaign are the name, the dates where the campaign took place and some description about the campaign. It is possible to attach any type of file to this field campaign (for example: authorization sheets, the field campaigns schedule, itinerary, etc.). All the files attached can be viewed (opened by the system default application) or removed. The files are attached to the MOHID Studio database, so the path to file can be modified or the file can be removed from disk.

MOHID Studio - User Guide 124.png
Figure 2 7 13: Field Campaign properties window.

The Field Campaign properties windows also include the list of all visited points in this field campaign. With this list is easier to keep the history of all visited points in every field campaigns.

The Visited Points can be created by clicking in button "Add…" on the Field Campaign properties window (represented in Figure 27 13) and a new window will be open, Visited Point manager window (represented in Figure 27 14). In this window is possible do add some information about the weather conditions and some more useful information. The weather conditions are very important to analyze the results measured on a distant future.

The Visited Point properties window also allows attach files to the visited points, such as sheets, photos and other documents. These documents are attached to each visited point and not to the field campaign, so is possible to have different files attach to each visited point. The files are also stored in the MOHID Studio database, so the file location is possible and do not interfere with MOHID Studio.

MOHID Studio - User Guide 125.png
Figure 2 7 14: Visited Point manager window.

The Visited Points can also be created, editing or removing from Visited Point manager windows (see Figure 27 15). Visited Points are created or editing through the Visited Point properties window (Figure 7 14).

The Visited Points (represented in Figure 27 14) can also be open by pressing the button "Visited Point" on the Campaigns group from the Environment Monitoring menu (see Figure 27 1).

MOHID Studio - User Guide 126.png
Figure 2 7 15: Visited Point properties window.

Import from XLS Files

Time Series

The import feature of XLS files to MOHID Studio is very useful and simple to use. There are three different types of importation files: simple time series, moving time series (profile) and boat cruise. Each importation file has a different format and there is a demo file, of each type, that is installed along with your MOHID Studio. The demo files are located on: My Documents\Mohid Studio\Templates\Data Import.

To import time series use the template "Import – TimeSeries.xlsx" and fill the values to import. The time series template is only used for time series: date, time and parameter value (see an example represented in Figure 27 16). After filling the template file, save the file with a different name, keeping the template as is. The XLS file should be like the example on the Figure 27 16. If there is a missing field in the line, all the line will be ignored. If the first field is empty or missing or if the line is empty, all the values above will be ignored.

MOHID Studio - User Guide 127.png
Figure 2 7 16: Import Time Series Template.

To import the time series values from XLS file to MOHID Studio use the Import Time Series window (represented in Figure 27 17). To open this window just press the button "Time Series" on the Import from XLS group from Environmental Monitoring (see Figure 27 1). First choose the parameter, monitoring station and time series type fields for the time series that will be imported and browse for the source XLS file. After the file is selected MOHID Studio will display all-time series values found on the imported file. This process may take a while, depending on the quantity of values to import. The press "Import" button to complete the importation process. This process also may take a while, depending on the quantity of values to import.

If the file has some errors or does not follow the template file, represented in Figure 27 16, MOHID Studio will display the error. If the message is "No values found in file" please check if the file is correct or if the template file is the correct type for the import window in use.

MOHID Studio - User Guide 128.png
Figure 2 7 17: Import Time Series window.

Profile

When the time series results from a profile measure, and the depth field is required, the right template to use is "Import – Profile.xlsx". This file is very similar with the time series import file (represented Figure 27 16) with an extra coordinate field: depth. To import this file, press the button "Profile" on the Import from XLS group from Environmental Monitoring (see Figure 27 1). Then a window, similar to the one represented in Figure 27 17 will appear and follow the same procedure as the importation of a single Time Series.

Boat Cruise

The "Import – BoatCruise.xlsx" file is used for boat cruise measures or measures that required coordinates tracking. This template file is also similar with the others but has two extra coordinate fields: Longitude and Latitude (see Figure 27 18). To import this file, press the button "Boat Cruise" on the Import from XLS group from Environmental Monitoring (see Figure 27 1).

The values imported from "Profile" and "Boat Cruise" file types will be available on the Moving Time Series manager window (represented in Figure 27 10). To edit the imported values use the Moving Time Series properties window (see Figure 27 11).

MOHID Studio - User Guide 129.png
Figure 2 7 18: Import Boat Cruise window.

Reports

The Reports[11] is one of the best ways to analyze and check all values from time series results. There are several reports available (represented in Figure 27 1): by Parameter, by Time Series, by Monitoring Station, by Min/Max values, by Monitoring Station. The reports are configured through the Report Window (represented in Figure 27 19) and are all fully described on the next sub-sections.

MOHID Studio - User Guide 130.png
Figure 2 7 19: Report Window – Parameter.

The Report Window is composed by two main sections: the report settings content (located on the left side of the window) and the generated report content (located on the right of the windows) as represented in the Figure 27 19. The left side of the window is also composed the settings of the selected report and by an additional two sections: "Time Interval" and the "Output" (represented in Figure 27 20).

MOHID Studio - User Guide 131.png
Figure 2 7 20: Report Window – Settings.

The settings of the selected report change in every report type and will be described on the next subsections.

The "Time Interval" (represented in Figure 27 20) allows the user to limit the results to a certain time interval (for example: one day, one month, one year, etc.). If the box "Apply Time Filter" is not checked, all the values in MOHID Studio’s database will be displayed.

The "Output" (represented in Figure 27 20) is the way to configure how the report will be displayed. There are three possible output formats: show in report window format, PDF format or XLS format. For the last two formats, a location file and name file are required. After pressing "Generate" button the report will be displayed on window or saved in a file.

When a generated report is displaying on the Report window, the top bar (represented in Figure 27 21) of the generated report content allows several features, such as: navigate through the generated file report, print the report, save the report file as XLS format or/and PDF format, zoom it and setting the page layout.

MOHID Studio - User Guide 132.png
Figure 2 7 21: Report Navigation bar.

Report by Parameter

Reports by parameter, as the name says, are reports based on parameter’s values. This type of reports will show all values from a determine parameter, from all monitoring stations. As an example, on the Figure 27 22 is represented a sample of a time series values report by parameter, for the parameter "Temperature" with the Time Interval from 01-01-2010 to 01-10-2010. The values are displayed alphabetical by monitoring station name and by chronological date.

MOHID Studio - User Guide 133.png
Figure 2 7 22: Report by Parameter.

Report by Time Series

Reports by Time Series display all values for a parameter obtained (measured or modeled) from one monitoring station. The list of parameters is displayed on the field "Parameter". After the "Parameter" is chosen, the list of time series displays all the time series available in MOHID Studio’s database for that parameter. Choose the times series for the report, by selecting the name. If there are measured and modeled parameters, it is possible to choose between the two different types. To generate the report press the "Generate" button.

The values from Report by Time Series are displayed in chronological time, as represented in Figure 27 23.

MOHID Studio - User Guide 134.png
Figure 2 7 23: Report Window – Time Series.

Report by Monitoring Station

The reports by Monitoring Station display all results from all parameters measured or modeled for one monitoring station. To generate a report by Monitoring Station, select the monitoring station on the settings panel and press "Generate". The generated report will displayed the parameter, date and time, value and parameter units, all order by chronological date. An example of this process is represented in Figure 27 24.

MOHID Studio - User Guide 135.png
Figure 2 7 24: Report Window – Monitoring Station.

Report by Min/Max Values

The Reports by Min/Max Values generate reports displaying the minimum and maximum values obtained (measured/modeled) from a specific Monitoring Station. These values are separated by types of time series (surface, middle, bottom, etc.), being displayed the minimum and maximum for each other.

To generate the Reports by Min/Max Values choose one parameter from the drop down box, select the monitoring station from the monitoring station list and press "Generate" button. An example of this process is represented in Figure 27 25.

MOHID Studio - User Guide 136.png
Figure 2 7 25: Report Window – Min/Max Values.

Report by Moving Time Series

The Moving Time Series reports list all the values from the profiles measured on a specific monitoring station. To generate this report, chose a parameter, a monitoring station and then the date and of the first measure from that station. The Moving Time Series Report window (represented in Figure 27 26) is only available when are moving time series in MOHID Studio’s database. The only parameters and monitoring stations displayed are the ones that have values for moving time series.

The moving time series has as header the information about the station and the parameter and the body contains the date, the depth and the value, order chronological.

MOHID Studio - User Guide 137.png
Figure 2 7 26: Report Window – Moving Time Series.

The moving time series imported by XLS files from "Profile" import and "Boat Cruise" import may be displayed by the Moving Time Series Reports.


File Export / Conversions

Introduction

MOHID Studio contains a set of utilities which permit to convert (and/or export) data from one format to another format. All utilities address the MOHID Specific Formats (ASCII Files, HDF Files and XML Geometries), ESRI Shapefiles and KML Files. MOHID Studio Export / Conversion Utilities[12] can be accessed from the "Export/Conversion" menu (represented in Figure 28 1).

MOHID Studio - User Guide 138.png
Figure 2 8 1: Export / Conversions menu.

All Export / Conversion Utilities are explained in detail next.

Export to KML

Export to KML utility allows exporting data to KML format. Formats which are possible to export to KML, from MOHID Studio, are: HDF Polygon Files, MOHID ASCII Grid Data Files, MOHID ASCII Drainage Network Files and Named Geometry Files. Before exporting any data to KML, the data must be loaded as layer into MOHID Studio’s map engine. Exported KML files can be loaded into applications like Google Earth[13].

Export HDF Polygon to KML

To export data from an HDF Polygon based layer to KML file, press "HDF Polygon" in MOHID to KML group from the "Export/Conversion" menu (see Figure 28 1). A window, like the one represented in Figure 28 2, will appear. On the upper left side of the window, the instants to be exported must be selected, on the "Fields to Export" box. On the upper right side of the window is possible to choose how the Z coordinate will be handled. On the bottom it is possible to choose where the exported files will be saved. Note that this toll will create one KML file for each instant which will be exported. The export process is started by clicking on the "Export" button.

MOHID Studio - User Guide 139.png
Figure 2 8 2: Export HDF to KML.

Export Grid Data to KML

To export a Grid Data layer to a KML file, press "Grid Data" in MOHID to KML group from the "Export/Conversion" menu (see Figure 28 1). A window like the one represented in Figure 28 3 will appear. After choosing the Layer to export and the destination of the exported file, click on "Export" button to generate the KML file.

MOHID Studio - User Guide 140.png
Figure 2 8 3: Export Grid Data to KML.

Export Drainage Network to KML

To export a Drainage Network layer to a KML file, press the button "Drainage Network" in MOHID to KML group from the "Export/Conversion" menu (see Figure 28 1). Then the "Export Drainage Network to KML" window will be opened, represented in Figure 28 4). After choosing the Layer to export and the destination of the exported file, click on "Export" button to generate the KML file.

MOHID Studio - User Guide 141.png
Figure 2 8 4: Export Drainage Network to KML.

Export Named Geometry to KML

To export a Named Geometry layer to KML, press the button "XML Geometry" in MOHID to KML group from the "Export/Conversion" menu (see Figure 28 1). The window "Export Named Geometry to KML" will be opened (represented in Figure 28 5). After choosing the Layer to export and the destination of the exported file, click on "Export" button to generate the KML file.

MOHID Studio - User Guide 142.png
Figure 2 8 5: Export Named Geometry to KML.

Export to ESRI Shapefile

Export to Shapefile utility allows exporting data to ESRI Shapefile format. Formats which are possible to export to ESRI Shapefiles are: HDF Polygon Files, MOHID ASCII Grid Data Files, MOHID ASCII Drainage Network Files and Named Geometry Files. Before exporting any data to ESRI Shapefiles, data must be loaded as layer into MOHID Studio’s map engine. Exported ESRI Shapefiles files can be loaded into applications like Arc GIS.

Export HDF Polygon to Shapefile

To export data from an HDF Polygon based layer to Shapefile, press the button "HDF Polygon" in MOHID to Shapefile group from the "Export/Conversion" menu (see Figure 28 1). A window like the one represented in Figure 28 2 will appear. The process of exporting data is the same as exporting to KML (more information in subsection 8.2.1), with the only difference that no Z coordinate can be set.

Export Grid Data to Shapefile

To export a Grid Data layer to Shapefile, press the button "Grid Data" in MOHID to Shapefile group from the "Export/Conversion" menu (see Figure 28 1). A window like the one shown in Figure 28 3 will appear. The process of exporting data is the similar to process of exporting to KML (more information in subsection 8.2.2).

Export Drainage Network to Shapefile

To export a Drainage Network layer to Shapefile, press the button "Drainage Network" in MOHID to Shapefile group from the "Export/Conversion" menu (see Figure 28 1). A window like shown Figure 28 4 in will appear. The process of exporting data is the similar to process of exporting to KML (more information in subsection 8.2.3).

Export Named Geometry to Shapefile

To export a Named Geometry layer to Shapefile, press the button "XML Geometry" in MOHID to Shapefile group from the "Export/Conversion" menu (see Figure 28 1). A window like shown Figure 28 5 in will appear. The process of exporting data is the similar to process of exporting to KML (more information in subsection 8.2.4).

XYZ Points to Shapefile

To export a Named Geometry layer to Shapefile, press the button "XML Geometry" in MOHID to Shapefile group from the "Export/Conversion" menu (see Figure 28 1). The window "Export XYZ to Shapefile KML" will be opened (represented in Figure 28 6Figure 8 5). After choosing the Layer to export and the destination of the exported file, click on "Export" button to generate the Shapefile with the exported layer.

MOHID Studio - User Guide 143.png
Figure 2 8 6: Export XYZ to Shapefile window.

Convert MOHID ASCII Geometries to XML Geometries

Conversion of MOHID ASCII Geometries to XML Geometries can be done by pressing one of the three buttons (Points, Line and Polygons) in ASCII –> XML group from the "Export/Conversions" menu (see Figure 28 1). A window like the one represented in Figure 28 7 will appear. With this feature it is possible to convert "old" MOHID ASCII point, line and polygon files to the "new" MOHID XML Geometry files. The process of converting points, lines, and polygons is very simple. First select the file to import and then the destination path and filename. To start the file conversion, press the "Convert" button.

MOHID Studio - User Guide 144.png
Figure 2 8 7: Convert MOHID ASCII to XML.

Convert XML Geometries to MOHID ASCII Geometries

Conversion of XML Geometries to MOHID ASCII Geometries can be done by pressing one of the three buttons (Points, Line and Polygons) in XML –> ASCII group from the "Export/Conversions" menu (see Figure 28 1). A window like the one represented in Figure 28 8 will appear. With this feature is possible to convert from the "new" MOHID XML Geometry files to "old" MOHID ASCII point, line and polygon files. The process of converting points, lines, and polygons is very simple. First select the file to import and then the destination path and filename. To start the file conversion, press the "Convert" button.

MOHID Studio - User Guide 145.png
Figure 2 8 8: Convert XML to MOHID ASCII.

Administration

Introduction

The Administration menu (see Figure 29 1) is the place where it is possible to change all types of MOHID Studio configurations. On the "License Manager" group it is possible to register, request and validate your MOHID Studio license (for more information read subsection 9.2).

MOHID Studio - User Guide 146.png
Figure 29 1: Administration Tab.

The "MOHID Studio Settings" contains several buttons to configure the basic settings of your MOHID Studio. On the button "General", on MOHID Studio Setting group from the Administration menu (see Figure 29 1), is possible to change the paths of MOHID Studio’s executable files, the output directories and some of MOHID Studio interface options. The "Reset Database" button resets the MOHID Studio database. All the data will be erased from your MOHID Studio database (example: monitoring stations, time series, parameters, etc.). After reset the database, it is not possible to restore/recover the previous database and all the data will be lost.

Through the "MOHID Studio Help" is possible to get information about your MOHID Studio version, get help from your MOHID Studio manual and it is also possible to request professional help for your MOHID Studio version. Help can be also found on the internet or in our site – check "Links" group at the menu "Home" (Figure 2 5).

License Management

Introduction

This subsection describes detailed all types of MOHID Studio licenses (see subsection 9.2.1), how to register and request your license of MOHID Studio (see subsection 9.2.3) and how to validate it (see subsection 9.2.4).

After installing MOHID Studio it will work for 30 days for an evaluation period. Evaluation versions have restricted usage. In order to work with a licensed version of MOHID Studio, the user needs to register and request a license (for more information read MOHID Studio – Installation Guide[14]).

For more information, please contact sales@actionmodulers.com

License Manager

The License Manager allows the user to request or/and validate the license for MOHID Studio. There are two different ways to access the License Manager: through the Administration tab (see Figure 29 1) or through the Orb button (see Figure 29 2).

MOHID Studio - User Guide 147.png
Figure 2 9 1: Administration Tab – License Manager.
MOHID Studio - User Guide 148.png
Figure 2 9 2: Orb button – License Manager.

The License Manager window displays the type of license of your MOHID Studio version and, if there exists, the limitations that your version has (see Figure 29 3).

MOHID Studio - User Guide 149.png
Figure 2 9 3: License Manager – Evaluation Edition.

To register and request a MOHID Studio license check subsection 9.2.3. To validate your MOHID Studio license check subsection 9.2.4.

License Request

To request a license go to the License Manager (seeFigure 9 3) and click on "License Request to open the Registration form (see Figure 29 4).

MOHID Studio - User Guide 150.png
Figure 2 9 4: License Request Form.

The fields marked with "*" are mandatory for request a license. After filling all the fields, click on the "Request" button. The preview of the license request window will appear, represented as an example in Figure 29 5.

MOHID Studio - User Guide 151.png
Figure 2 9 5: License Request Info.

In order to complete your license request, you must send the information contained in the large text box to sales@actionmodulers.com. You can use the "copy" button to copy the content of the textbox to the clipboard.

License Validation

After receiving the e-mail with MOHID Studio’s license go to the License Manager window (represented in Figure 29 3) and press "License Validation". The License Validation is an easy process and can be made by two different ways (represented in Figure 29 6).

MOHID Studio - User Guide 152.png
Figure 2 9 6: License Validation.
License Data File

This is the easiest way to validate your MOHID Studio license. The user needs to select the option "I received the authorization file by e-mail and have saved it to disk" and then click on the browse button (see Figure 29 6). Browse for the file that was attached to the mail with the license, "MOHIDStudioLicense.dat". Your MOHID Studio is now licensed. It is necessary to restart MOHID Studio to validate the license file.

Validation Key

The user should choose the option "I received the authorization key by fax or phone and need to validate manually" and then type the Validation Key (represented in Figure 29 7). Press the "OK" button to validate the MOHID Studio License and then browse for a place to save the validation file "MOHIDStudioLicense.dat" (which contains the Validation Key). Finish the validation process by restarting the MOHID Studio to apply your MOHID Studio license.

MOHID Studio - User Guide 153.png
Figure 2 9 7: License Validation – Validation Key.

File Formats

MOHID ASCII Files

Introduction

MOHID ASCII files are ASCII files which follow special formatting rules. These files are used to provide all input information to the FORTRAN based numerical MOHID models (MOHID Water, MOHID Land and MOHID River). Some outputs of these models are also written in this format.

MOHID ASCII files are organized by keywords and information blocks, which can pile up to three hierarchical levels and aggregate groups of keywords. This format can be seen likewise to a simple Mark-Up Language. File generation can be made manually, using a text editor (like MOHID Studio’s Text Editor) or by tools (like MOHID Studio Tools).

The maximum number of characters per line is restricted to 256. As each line contains only one instruction, this restriction does not represent any practical limitation to the user. Files can have blank lines and keywords do not have to follow any specific order. This reduces the effort of preparing input data files in a rigid format and reduces input data errors. With exception to some cases, all the reading (keywords, keyword values, blocks definition tags) are case sensitive. So, caution is advised in the preparation of the files because recognition is only achieved by full correspondence of characters in the code and in the data files. In Figure 210 1 is represented an example of a MOHID ASCII file, with keyword, keyword values and blocks.

MOHID Studio - User Guide 154.png
Figure 2 10 1: Example of a MOHID ASCII file.

XYZ Files

XYZ Files are used to define a set of points with x, y and z coordinates. These files are typically used to store information from bathymetric or topographic surveys.

XYZ Files are ASCII text file which extension should be *.xyz. XYZ Files contain a set of blocks, each containing a set of point values. One block is delimited by the following case sensitive keywords: <begin_xyz> and <end_xyz>.

A fourth column can be optionally included and it is handled as a character string which can also be used as a legend for each point.

In Figure 210 2 is represented a simple example of a three column XYZ MOHID ASCII File.

MOHID Studio - User Guide 155.png
Figure 2 10 2: Example of MOHID ASCII XYZ file.

Line Files

MOHID ASCII Line files are used to store simple lines. The default extension for MOHID ASCII Line files is *.lin. These files are organized in blocks, each containing the vertices for a determined line. One block is defined by the following keywords: <begin_line> and <end_line>. Note that these keywords are case sensitive.

One file can contain an infinite number of blocks. Inside each block there are 2 columns and at least 2 rows, one for each vertex of the line. The left column relates to the XX coordinates of a point and the right one to the YY coordinates. In Figure 210 3 represents an example of an MOHID ASCII Line file.

MOHID Studio - User Guide 156.png
Figure 2 10 3: Example of a MOHID ASCII Line file.

Polygon Files

MOHID ASCII Polygon files are used to store polygons. The default extension for Polygons files is *.xy. These files are organized in blocks, each containing the vertices for a certain polygon. One block is defined by the following keywords: <beginpolygon> and <endpolygon>. Note that these keywords are case sensitive. One file can contain an infinite number of blocks. Inside each block there are 2 columns: the left relates to the XX coordinates of the polygon vertices and the right one to the YY coordinates of the polygon vertices. Figure 210 4 shows an example of one MOHID ASCII Polygon file.

MOHID Studio - User Guide 157.png
Figure 2 10 4: Example of a MOHID ASCII Polygon file.

Grid Files

MOHID ASCII Grid files are used to stores grid. The organization of these files is divided into a header section and a grid spacing section. MOHID supports orthogonal horizontal grids, which can be rectangular or curvilinear. The default extension for Grid files is *.grd. In Figure 210 5 are represented examples of grids that are supported by MOHID Studio: regular equally spaced, regular not-equally spaced, rotated, and curvilinear).

Note that in MOHID the i index refers to the YY axis and the j index to the XX axis. As an example grid cell (5, 2) is the fifth grid cell in the YY axis and the second in the XX axis.

MOHID Studio - User Guide 158.png
Figure 2 10 5: Example Grids supported by MOHID.

The header section contains information related to the grid global definitions, such as the number of cells, the type of coordinates used, the origin coordinates of the grid, etc. Below are shown the keywords supported by the header section of a Grid file.

  • ILB_IUB - Two integer numbers defining the minimum and maximum I values along the Y-axis of the grid.
  • JLB_JUB - Two integer numbers defining the minimum and maximum J values along the X-axis of the grid.
  • COORD_TIP - A flag which indicates the used coordinates type.
  • ORIGIN - Two real values, which indicate the origin of the lower left corner of the grid.
  • ZONE - Integer values defining the UTM Zone where the bathymetry is located.
  • GRID_ANGLE - Counter-clock mesh rotation relative to the north. The base point is the origin of the grid.
  • LATITUDE - Average latitude value used to compute Coriolis frequency and solar radiation when metric coordinates cannot be converted to WGS84 geographic coordinates.
  • LONGITUDE - Average longitude value used to compute Coriolis frequency and solar radiation when metric coordinates cannot be converted to WGS84 geographic coordinates.
  • CONSTANT_SPACING_X - Boolean defining if the spacing in the X axis is constant
  • CONSTANT_SPACING_Y - Boolean defining if the spacing in the Y axis is constant
  • DX - Constant spacing distance in XX axis
  • DY - Constant spacing distance in YY axis

If the spacing is not constant, the grid spacing section contains information about the grid spacing in the XX and YY axis namely through defining the grid cells corners coordinates. This information is stored in blocks, one for each direction. The data is stored inside a block defined by the following keywords: <BeginXX> and <EndXX> for the XX axis and <BeginYY> and <EndYY> for the YY axis. Note that the keywords of these block definition tags are case sensitive. Each value must be stored in a single line. The values are read from left to right in the XX axis and from bottom to top in the YY axis. The first value is always zero in both directions, being the following values cumulative. Figure 210 6 shows an example of an MOHID ASCII Grid file.

NOTE: For more information about MOHID Grid files can be found here check the following link:

http://www.mohid.com/wiki/index.php?title=Grid

MOHID Studio - User Guide 159.png
Figure 2 10 6: Example of a MOHID ASCII Grid file.

Grid Data Files

MOHID ASCII Grid Data files relate 2D or 3D information to a grid. Grid data is stored in an ASCII text file and has multiple and flexible formatting options. Grid Data files are used to store one value per grid cell (as for bathymetry, topography). MOHID ASCII Grid Data Files contain the same sections as Grid files (header section and grid spacing section) plus an additional data section.

The data section contains the values of the Grid Data. The data is stored inside a block defined by the following keywords: <BeginGridData2D> and <EndGridData2D>. Note that these keywords are case sensitive. It is possible to specify the values by giving a list of all values of all the grid cells. Each value must be stored in a single line. The values are read from the lower left corner to the upper right corner of the grid by row-column order. Therefore, the first grid data values are read in the following order: (ILB, JLB), (ILB, JLB+1), … (ILB, JUB), (ILB+1, JLB), …, (IUB, JUB-1), (IUB, JUB). Note that the index "i" refers to the Y-axis and the "j" index to the X-Axis. In this case, if you have a (IUB x JUB) grid then the list must have (IUB x JUB) values.

NOTE: More information about MOHID Grid Data files can be found on the following link: http://www.mohid.com/wiki/index.php?title=Grid_Data

Drainage Network Files

MOHID ASCII Drainage Network Files are used to stores information about drainage network. The organization of this file is divided into blocks defining single nodes and blocks of defining links between nodes.

Single node blocks contain information related to each node which makes part of the drainage network. Single nodes blocks are delimited by the <BeginNode> and <EndNode> blocks. An example of a node block is represented in Figure 210 7.

MOHID Studio - User Guide 160.png
Figure 2 10 7: Example Node Definition.

Links between nodes are defined by blocks delimited by <BeginReach> and <EndReach> blocks. An example of a node block is represented in Figure 210 8.

MOHID Studio - User Guide 161.png
Figure 2 10 8: Example Reach Definition.

Due to the complexity of these files, it is recommended to generate these files with MOHID Studio’s Watershed delineation tool.

NOTE: More information about MOHID Drainage Network files can be found on the following link: http://www.mohid.com/wiki/index.php?title=Mohid_Land.

Time Series Files

MOHID ASCII Time series files are used to store information varying in time. These files serve as input and as output for the MOHID numerical programs. MOHID ASCII Time Series files should contains have an extension *.sr* (e.g. *.srh, *.srm, etc).

Time Series files have a header section containing general definition about the series (location, time units, and name) and data section.</center>

The header section must define the following keywords:

  • NAME – Name of the Station to which the series belong;
  • COORD_X – X Coordinate of the station;
  • COORD_Y – Y Coordinate of the station;
  • SERIES_INITIAL_DATA - definition of the series initial data;
  • TIME_UNITS – Time units in which the data is given;

The data section is defined inside a block defined by the tags <BeginTimeSerie> and <EndTimeSerie>. Inside the block data is formatted into columns separated by blank spaces. The leftmost column defines the accumulated time, in the time units defined in the header section and starting from the time series initial date, also defined in the header section. The number of columns is limited by the default number of characters allowed in one single line, which are 256. In order to read the properties (e.g. temperature, salinity, wind speed, etc.) associated to a certain column, a header line must be present on the line just above the <BeginTimeSerie> tag. The number of properties names in this header line must be equal to the number of columns in the data section including the accumulated time column. The names must be separated by blank spaces, thus properties names with blank spaces are not allowed. Blank spaces of properties must be replaced by an underscore. The Figure 210 9 shows an example of a simple time series file with one column and in the Figure 210 10 it is possible to see an advanced example.

MOHID Studio - User Guide 162.png
Figure 2 10 9: Example MOHID ASCII Time Series file (simple).
MOHID Studio - User Guide 163.png
Figure 2 10 10: Example MOHID ASCII Time Series File (advanced).

XML Files

Introduction

MOHID Studio uses XML files to store data of many kinds. Many of these files are for internal use only and are not described here. XML Files suitable to be edited are XML files which contain geometry information. These are described along the next subsections.

XML Named Points Files

XML named points files are used to store "named points" and can be generated with MOHID Studio’s tools. An example of a XML Named point file is represented in Figure 210 11.

MOHID Studio - User Guide 164.png
Figure 2 10 11: A XML Named Point File.

XML Named Lines Files

XML named lines files are used to store "named lines" and can be generated with MOHID Studio’s tools.

XML Named Polygon Files

XML named polygon files are used to store "named polygons" and can be generated with MOHID Studio’s tools.

Other Formats

HDF Files

HDF5 is a general purpose library and file format for storing scientific data. It is the standard input/output format of spatial and/or temporal data sets in MOHID. Through MOHID Studio’s integrated map engine it is possible to visualize data contained in HDF files. Besides this, MOHID Studio includes tools to manipulate HDF Files and export data from HDF files to other formats.

HDF5 itself does not define a standard of how to georeference data sets, nor how to time reference data sets. In order to overcome this lack of definition, MOHID defines some special rules how data inside a HDF file should be organized, in order to be MOHID-HDF. For more information about this subject can be found at the following link: http://www.mohid.com/wiki/index.php?title=HDF_file.

MOHID’s modules produce HDF files which contain: (i) polygon (grid data) based data sets, (ii) drainage network based information and (iii) lagrangian (particle) based data sets.

ESRI Shapefiles

The ESRI Shapefile is a popular geospatial vector data format for geographic information systems software. It is developed and regulated by ESRI as a (mostly) open specification for data interoperability among ESRI and other software products. MOHID Studio is able to disable data contained in ESRI Shapefiles. Some MOHID Studio tools are based on ESRI Shapefiles and through file conversion it is possible to convert between ERSI Shapefiles and other file formats.


  1. This feature requires MOHID Studio Professional.
  2. Domains are geographical regions simulated by one specific model. A solution groups one or more domains together.
  3. MOHID GUI had a similar structure. The correspondence from MOHID GUI to MOHID Studio is: Project = Solution; Simulation = Domain and Run = Simulation
  4. Importing of MOHID GUI Projects only works for versions 4.9.2
  5. http://www.unearthedoutdoors.net/global_data/true_marble/download
  6. This feature requires MOHID Studio Professional.
  7. This feature requires MOHID Studio Professional.
  8. This tool is only available in MOHID Studio Professional Version.
  9. This applies only if the river network is to be simulated. You can run MOHID Land also in a special mode without drainage network. In this case, the DTM may contain depressions.
  10. The Environmental Monitoring menu comes with the Environmental Monitoring Plugin is only available for the MOHID Studio Professional Version.
  11. Requires Microsoft Report Viewer 2008 or later.
  12. The File Conversion menu comes with the MOHID Studio Export / Conversion Utilities Plugin is only available for the MOHID Studio Professional Version.
  13. Download link: http://earth.google.com/download-earth.html
  14. Installed with MOHID Studio (Start -> Action Modulers -> Mohid Studio -> Installation Guide.pdf) or download it from our website: http://mohidstudio.actionmodulers.com