Introduction

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

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 1).

MOHID Studio - User Guide v2 09.png
Figure 1 : Project menu.

Data associated with projects is displayed in the "Explorer" window (see Figure 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 : Explorer window.

The Project Tree shows the hierarchical structure of projects. In Figure 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 3).

MOHID Studio - User Guide 14.png
Figure 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 1). The window to create solutions is represented on Figure 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 1). The window to open existent solutions is very similar to the one that is represented on Figure 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 4 : Creating a new solution.

Closing solutions

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

Managing solutions

There are several tasks which can be performed with solutions: (i) rename, (ii) delete, (iii) import and (iv) export (see Figure 5). All these tasks can be performed by selecting "Manage" on Solution group, from the "Project" menu (see Figure 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 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 Domain section below).

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 5). A window like the one represented in Figure 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 6 : Exporting solutions.

Importing solutions

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

MOHID Studio - User Guide 18.png
Figure 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 MOHID file of the MOHID Project[2].

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 1). A window like in Figure 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 is not mandatory to 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 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 9.

MOHID Studio - User Guide 20.png
Figure 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).

Open domains

Hello od

Domain-Open.png

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 1). The window similar to the one that is showed in Figure 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.

Domain-Properties.png

Removing domains

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

Managing domains

It is possible to manage domains by selecting the "Manage" button on the Domain’s group from the "Project" menu (see Figure 1). In the Figure 12 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 (see Figure 13).

MOHID Studio - User Guide 21.png
Figure 12 : 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 13 : 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 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 14).

MOHID Studio - User Guide 23.png
Figure 14 : Insert nested domain.

When creating a nested domain, MOHID Studio sets the root directory for the nested domain automatically. In Figure 15 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 15 : 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 1). A window like the one represented in Figure 16 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 16 : 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 1). An identical window to the one showed in Figure 16 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 17 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 17 : 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 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 18 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 18 : Files associated to simulations.

Data files can be easily modified and saved by MOHID Studio.

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 1). A window like the one represented on Figure 19 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 19 : 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 20) press "Compare" on the Simulation group from the "Project" menu (see Figure 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 20 : 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 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 21):

  • 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 21 : 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 22). 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 22 : 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) 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 23 : 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 24).

MOHID Studio - User Guide 33.png
Figure 24 : 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 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 25 will appear.

MOHID Studio - User Guide 34.png
Figure 25 : 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 26.

MOHID Studio - User Guide 35.png
Figure 26 : Scheduling (for nested domains.

Simulation progress

Feedback on simulation progress appears below the Project Tree, in the "Model Controller" window (represented on the Figure 27). 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 28 appears.

MOHID Studio - User Guide 36.png
Figure 27 : Model Controller Window.


MOHID Studio - User Guide 37.png
Figure 28 : 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 27).

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 21).



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.

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 (see Figure 29).

MOHID Studio - User Guide 38.png
Figure 29 : 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 (see Figure 30).

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



  1. MOHID GUI had a similar structure. The correspondence from MOHID GUI to MOHID Studio is: Project = Solution; Simulation = Domain and Run = Simulation
  2. Importing of MOHID GUI Projects only works for versions 4.9.2

Links

Go back to MOHID Studio User Guide

User Guides