MIKE SHE TOOLBOX

User Guide

MIKE by DHI 2009

Please Note
Copyright This document refers to proprietary computer software which is protected by copyright. All rights are reserved. Copying or other reproduction of this manual or the related programs is prohibited without prior written consent of DHI. For details please refer to your 'DHI Software Licence Agreement'. Limited Liability The liability of DHI is limited as specified in Section III of your 'DHI Software Licence Agreement': 'IN NO EVENT SHALL DHI OR ITS REPRESENTATIVES (AGENTS AND SUPPLIERS) BE LIABLE FOR ANY DAMAGES WHATSOEVER INCLUDING, WITHOUT LIMITATION, SPECIAL, INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES OR DAMAGES FOR LOSS OF BUSINESS PROFITS OR SAVINGS, BUSINESS INTERRUPTION, LOSS OF BUSINESS INFORMATION OR OTHER PECUNIARY LOSS ARISING OUT OF THE USE OF OR THE INABILITY TO USE THIS DHI SOFTWARE PRODUCT, EVEN IF DHI HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. THIS LIMITATION SHALL APPLY TO CLAIMS OF PERSONAL INJURY TO THE EXTENT PERMITTED BY LAW. SOME COUNTRIES OR STATES DO NOT ALLOW THE EXCLUSION OR LIMITATION OF LIABILITY FOR CONSEQUENTIAL, SPECIAL, INDIRECT, INCIDENTAL DAMAGES AND, ACCORDINGLY, SOME PORTIONS OF THESE LIMITATIONS MAY NOT APPLY TO YOU. BY YOUR OPENING OF THIS SEALED PACKAGE OR INSTALLING OR USING THE SOFTWARE, YOU HAVE ACCEPTED THAT THE ABOVE LIMITATIONS OR THE MAXIMUM LEGALLY APPLICABLE SUBSET OF THESE LIMITATIONS APPLY TO YOUR PURCHASE OF THIS SOFTWARE.' Printing History January 2009

MIKE SHE

CONTENTS

MSHE Tools: DATA ANALYSIS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

1 GRID SERIES FILE COMPARE . . . . 1.1 Setup name . . . . . . . . . . . . 1.2 Enter parameters for comparing 1.3 Status . . . . . . . . . . . . . . . . PROBABILITY CURVES . . . 2.1 Setup Name . . . . . . . 2.2 Time series file selection 2.3 Output Settings . . . . . 2.4 Output file selection . . . 2.5 Status . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . 9 . . . . . . . . . . . . . . . . . . . . . . . . 9 . . . . . . . . . . . . . . . . . . . . . . . . 9 . . . . . . . . . . . . . . . . . . . . . . . 11 13 13 13 13 14 14

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

MSHE Tools: FILE CONVERTER . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

3 DFS2+DFS0 TO DFS2 . 3.1 Setup Name . . . 3.2 Files . . . . . . . . 3.3 Status . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 17 17 17

MSHE Tools: UTIL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

4 GRID CALCULATOR . 4.1 Setup Name . . . 4.2 Calculation Setup 4.3 Status . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 21 21 22

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

MIKE SHE

M S H E TO O L S : D ATA A N A LY S I S

The Data Analysis Tools in the MSHE Toolbox include the facilities:
z z

Grid Series File Compare Probability Curves

MIKE SHE

Setup name

GRID SERIES FILE COMPARE

This tool is used to calculate comparitive statistics on dfs2 and dfs3 gridded files. At each time step, the tool calculates, for example, the minimum value from all the cells and adds the value to a dfs0 time series file. Thus, the final result is a time series of the mininum parameter value at each time step. The processing can be done globally (for all cells in the grid) or locally based on user-defined zones. The zones can be defined by an integer grid code dfs2 file, with each cell in the zone identified by a common integer ID value. In this case, the output dfs0 file contains one item for each zone.

1.1

Setup name
On this page you define the name of your tool. The tool will be saved with this name and appear as a new item in the Tool Explorer tree. This allows you to save and reuse tool setups. The actual tool setup is saved in the .txp file

1.2

Enter parameters for comparing

Reference/Scenario grid series files These are the two files that will be evaluated and compared. Define zones If you check this checkbox on, then you must add a dfs2 grid file containing integer grid code values. Each area with a unique grid code will be processed seperately and a seperate item will be added to the output dfs0 file. Grid series comparison method This is the action that will happen to each individual cell in the two dfs2 files. There are five options available. Min - the minimum of the reference or scenario value at each cell will be taken Max - the maximum of the reference or scenario value at each cell will be taken

Grid Series File Compare

Mean - the mean of the reference and scenario value at each cell will be taken Diff - the reference value is subtracted from the scenario value at each cell Sum - the reference value and scenario value are added at each cell Zone output type For each zone, all of the values in the grid will be condensed into one value for each time step in the files. There are again five options: Sum - all of the values in the combined grid above are summed together and written to the dfs0 file. Min - the minimum value from the combined grid above will be written to the dfs0 file. For example, if Max is used for the Grid comparison method and Min is used for the Zone output, then the value in the dfs0 file will be the minimum of all the maximums at each time step. Max - the maximum value from the combined grid above will be written to the dfs0 file. For example, if Max is used for the Grid comparison method and Max is used for the Zone output, then the value in the dfs0 file will be the maximum of all the maximums at each time step. Average - the average value of the combined grid above will be written to the dfs0 file. Average*ZoneArea - the average value of the combined grid above will be multiplied by the area of the zone and then written to the dfs0 file. Multiplier value The output from the comparison will be multiplied by this value before being written to the dfs0 file. If you want to specify a distributed multiplier, then you can check the checkbox on. In this case, you must specify a dfs2 file containing the multiplier values. Output time series file This is the name of the dfs0 file that will be created. It will be created in a subdirectory under the directory specified for the Log/pfs file location on the next page.

10

MIKE SHE

Status

1.3

Status
The Status page presents you with a summary of all the input parameters you have specified. Check that the parameters are correct. If not go back and change them. Log/pfs file location This is the directory where the output will be sent. A subdirectory will be created here based on the name of the setup. Running the Tool Finally, on the Status page, you can Execute the setup, which will run the Tool with the current parameters, or Finish the setup, which will save your setup definition in the current toolbox file.

11

Grid Series File Compare

12

MIKE SHE

Setup Name

PROBABILITY CURVES
The MIKE SHE Probability Curves Tool calculates the mean value, as well as the probablity and duration curves for the specified period in a dfs0 file.

2.1

Setup Name
Specify a name for the setup. This allows you to save and retrieve the setup, either later, or from a batch file.

2.2

Time series file selection

Select the dfs0 file for which you want the probablity and duration curves.

2.3

Output Settings

The output settings dialog allows you to define the period and interval for the statistic calculation. If you select Specified for the Interval, then you can define the number of periods and the start and end months.

13

Probability Curves

The sub-sets option allows you to further refine the statistical breakdown.

2.4

Output file selection

Type in the name of the ASCII file where want the probablity and duration curves written to.

2.5

Status
The Status page presents you with a summary of all the input parameters you have specified. Check that the parameters are correct. If not go back and change them. Log/pfs file location This is the directory where the output will be sent. A subdirectory will be created here based on the name of the setup. Running the Tool Finally, on the Status page, you can Execute the setup, which will run the Tool with the current parameters, or Finish the setup, which will save your setup definition in the current toolbox file. The tool runs silently. If there are any errors, then the tool will simply not run.

14

MIKE SHE

MSHE TOOLS: FILE CONVERTER

15

The File Converter Tools in the MSHE Toolbox include the facility:
z

dfs2+dfs0 to dfs2

16

MIKE SHE

Setup Name

DFS2+DFS0 TO DFS2
This tool is used to build a time varying dfs2 file from a dfs2 grid code file and one or more dfs0 time series files. The time varying dfs2 file can be used for time varying gridded data items, including Precipitation Rate and Evapotranspiration.

3.1

Setup Name
Specify a name for the setup. This allows you to save and retrieve the setup, either later, or from a batch file.

3.2

Files
This dialog contains the file name for the two input files and the output file. The input file is a dfs0 file, usually with multiple data items. All the data items are expected to have the same units, but this is not checked. The input dfs2 file is a grid file with grid codes corresponding to the item numbers in the dfs0 file. The dfs2 file must have an EUM type of Grid Codes with a unit of Integers. If you are creating a distributed precipitation rate file, then the dfs0 items must be of type Mean Step Accumulated, with a EUM Type of Precipitation Rate and any valid unit, such as [inches/hour] or [mm/day]. The output file will be a dfs2 file with one grid for each time step in the dfs0 file. and the values in each grid point equal to the value in the dfs0 file at that time step.

3.3

Status
The Status page presents you with a summary of all the input parameters you have specified. Check that the parameters are correct. If not go back and change them. Log/pfs file location This is the directory where the output will be sent. A subdirectory will be created here based on the name of the setup.

17

dfs2+dfs0 to dfs2

Running the Tool Finally, on the Status page, you can Execute the setup, which will run the Tool with the current parameters, or Finish the setup, which will save your setup definition in the current toolbox file. The tool runs silently. If there are any errors, then the tool will simply not run.

18

MIKE SHE

MSHE TOOLS: UTIL

19

The Util Tools in the MSHE Toolbox include the facility

z

Grid calculator

20

MIKE SHE

Setup Name

GRID CALCULATOR
The MIKE SHE Grid Calculator tool allows you to perform complex operations on .dfs2 grid files. However, the grid files must have the same grid dimensions and they may not have multiple time steps or multiple items. Thus, this tool is much more restrictive than the grid operations available in the Grid Editor. However, you can make complex chains of operations and save the setup, which can save you a lot of time if you are doing the same operation many times or after each simulation.

4.1

Setup Name
Specify a name for the setup. This allows you to save and retrieve the setup, either later, or from a batch file.

4.2

Calculation Setup

In the first part of this dialogue, you need to specify the files and variable names used in the mathematical operation. These will be the variables used in the subsequent operation. The variable names are case sensitive.

21

Grid calculator

Output Specification In the second part, you must specify the output file name (including the .dfs2 file extension), as well as the EUM unit type and units for the resulting file. Although the EUM list is alphabetical, the list of EUM data types is very long, as it includes all of the available EUM types for all of the MIKE Zero products. If you are trying to create a particular input type for MIKE SHE, then you should look in the MIKE SHE Setup dialogue, to find out first what EUM data type is required and then find this type in the list. Expression The last part of the dialogue is the mathematical expression you wish to evaluate. Many common mathematical operations are available, including LOG and LOG10. If the operation is not recognized, then an error will be generated when you try to run the expression. The standard order of operations is followed, including the use of nested brackets. Note all fields must be filled in.

4.3

Status
The Status page presents you with a summary of all the input parameters you have specified. Check that the parameters are correct. If not go back and change them. Log/pfs file location This is the directory where the output will be sent. A subdirectory will be created here based on the name of the setup. Running the Tool Finally, on the Status page, you can Execute the setup, which will run the Tool with the current parameters, or Finish the setup, which will save your setup definition in the current toolbox file. The tool runs silently. If there are any errors, then the tool will simply not run.

22

MIKE SHE

INDEX

23

Index

24

MIKE SHE