Page History

{excerpt:hidden=true}{excerpt}

{panel: borderStyle=dashed| borderColor=#ccc| titleBGColor=#F7D6C1| bgColor= #D5EFFF}
This tutorial provides a general overview of the application files as well as brief introduction intoof the most common user operations, which canare be doneavailable in the program.
{panel}

h2. How DelftShell files are organized?

The DelftShell application consists of the 2 main parts, *Main Application* and a set of the *Plugins*.

!Step1_Files.png!

{tip:title=Tip:}In order to start the application go to the DelftShell-1.0.5546\bin\Release folder (a folder you get after downloading and uncompressing the program) and then start *DelftShell.Loader.exe*.{tip}

ItThis will start an application and will show a screen like the one below.

The mailmain graphical user interface is organized as a set of tool windows and document windows. A main difference between those two is that the tool windows are always shown on athe screen and the document windows -are only used to visualize or edit a specific data type.

A typicalTypical examples of the Tool Windows are:
* Project Explorer - athe main navigation window showing all data contained in the current project in a tree-like form.
* Message Window - logging windows, messages sent from models or different parts of the system are placed here.
* Property Grid - shows properties for an active selection of the graphical user interface.
* Toolbox - user-specific data shared between different projects (not fully implemented yet).
* Maps - tree-like window showing the list of the GIS layers in the currently opened map.
* Time Series Navigator - allows to navigate through times of any time-dependent data.
* Network - allows to view / edit structure of the currently opened (hydro) network.

!Step2_Start.png!
      
When application is started - it automatically creates a default empty project so thatan user can immediately start filling it in with a various data, models, etc. A Projectproject can be seen as a currently opened user work document. An Currentlyactive project can be stored in SQLite database file format. Eventually DelftShell may store a model input / output data in a set of NetCDF files located next to the project file. So in total there are two non-proprietary file formats used to store project data.

{tip:title=Tip:}Use F2 in Project Explorer in order to edit the name of the project, folder, model or any other item contained.{tip}

Generally speaking in default configuration DelftShell can store the following data types in thea project:

* Folder
* Model / Composite Model - working activities which the user can start in order to perform a computations
* Data - any data type registered in the system, default contain e.g. Time Series, Regular Grid Coverage or more specific data types such as Network.
* <specific application documents such as Map or Chart> - these are non-data objects but more views configured in order to view those objects.

h2. How do Ito add a new Time Series or any other data type to the project.

Use a menu command shown on the screen below.

!Step3_AddNewTimeSeries.png!

After that a dialog will appear showingappears, a list of a data types currently supported by the application are shown.

!Step4_AddNewTimeSereies_2.png!

Note that Network (hydro network) is also considered as one of the supported data types. Actually an architecture of the system allows easy implementation of the user-specific data types, but this is a more advanced topic and will be covered in a [Developers Guide].
      
h2. How do Ito add a new computational model, e.g. Delft Flow Model 1D, to thea project

Adding models to the project works prettyalmost the same as with a data. The Useruser has to select a model type via *Project (right-click) > Add > New Model ...*.

This is how it looks after demo 1D flow model is added to the project:

!Step5_AddNewFlowModel1D.png!

All model input and output data can be navigated via the Project Explorer tree view.

{tip:title=Tip:}When model is selected in the project explorer you can define run time parameters of the model via [Property Grid]:
!Step6_EditModelRunParameters.png!
{tip}

Actually many parameters, not only for model, can be viewed or edited via the Property Grid when they are selected in the different windows.

h2. How data, added to the project, can be edited?

GraphicalThe graphical user interface supports different data types and most of them currently have a default editor. Usually the editor opens automatically when data / model is added to the project. But when it is closed - the user may re-open it with aby double clickclicking.

In some specific cases there may be more than two editors / viewers registered for one data type - in this case the gui will show a selection dialog where user maycan select a default type of the editor. The Viewview type selection dialog can maybebe reactivatedactivated by right-clicking on selected item in the Project Explorer and then selecting *Open With ...*.

!Step7_OpenDataWith.png!

{tip:title=Tip:}When anyone of the Tool Windows is closed, init ordercan tobe bringreopened itwith back usethe View menu, e.g. *View > Project Explorer*. This will re-add it back in the main gui.{tip}

{tip:title=Tip:}When gui exits - it automatically saves all its settings data, including all tool windows layotlayout, into the user custom settings file which is usually located in a directory: *C:\Document and Settings\<user name>\Local Settings\Application Data\Deltares\DelftShell\*. Check this itdirectory to see which files are saved there. YouIt canis also possible to remove the whole Deltares\DelftShell directory e.g., if you'd likewant to reset all user-specific settings{tip}

h2. How getto myimport data imported into thea project or export data exportedto intoan external file format?

When you need to get a specific data type imported into the project one of the options is to use one of the existing Data Import plugins. The Defaultdefault installation includes some of them, for example importers make it allowingpossible to import a network from the older versions of the SOBEK or to import a set of a grid files as a single time-dependent grid. Go to *File - > Import Data* to open the Import Data window.

Current API of the DelftShell allows very easy implementation of the custom importers / exporters requiring very minimum knowledge of the whole system architecture. In some cases it can be extended by the team on request.

!Step8_Import.png!