Skip to content

Graphical interface

Tim Peterson edited this page Mar 28, 2023 · 14 revisions

Overview

The graphical user interface (GUI) for HydroSight provides an efficient means to build a wide range of groundwater time-series models without knowledge of Matlab programming or a copy of Matlab. It comprises of two independent components:

  • Outlier Removal: a data analysis and outlier detection module for detecting and removing erroneous water level observations prior to time-series modelling.
  • Time-series Modelling: a time-series modelling module for simulating hydrographs and, for example, decomposition of the hydrographs to drivers.

A HydroSight project can contain both types of components and the number models within a project is limited only by the computer RAM and hard-disk capacity. However, only one HydroSight project can be loaded at a time.

Project Tools

To assist in managing your project, the GUI contains a number of project wide tools. The tools are listed in the menu and each items is detailed below:

File menu options:

  • New Project: Close the current project and create a new HydroSight project.
  • Set Project Folder: Define the folder for the HydroSight project. This must be done bore a time-series model is built and all input data file must be listed within this folder, or a sub-folder.
  • Open Project: Close the current project and open an existing HydroSight project file.
  • Import Model(s): Import user selected time-series models from another HydroSight project file into the current project. Currently, this feature does not allow importing of Outlier Removal models. When a time-series model is imported, if a duplicate model exists within the current project then the model label is renamed with an extension denoting that it has been imported.
  • Save Project as: Save the current project to a new file name.
  • Save Project: Save the current project to the prior defined file name.
  • Move models from RAM to HDD: Move all project time-series models off RAM storage to the HDD. All built, calibrated and simulated time-series models are moved to the hard disk. This allows significantly more models to be analysed within one project. However, any operation requiring access to the models may be very slow. Such operations include changing settings or plot and exporting results. Hence, it is highly advisable to store the project file on a local hard-drive, and not a network location. Importantly, changes made to a model (e.g. rebuilting, calibrating or simulating) will be automatically saved to the project file. The project data tables within each tab will however not be automatically saved.
  • Move models from HDD to RAM: Move all project time-series models stored on the HDD back to RAM. If the project has a large number of models, then the project may require all available RAM.
  • Exit: Close HydroSight.

Examples menu options:

  • TFN model - Landuse change: Load a project demonstrating the modelling of climate forcing and climate plus land cover change forcing using transfer function noise time-series models.
  • TFN model - Pumping and climate: Load a project demonstrating the modelling of pumping and climate forcing using transfer function noise time-series models.
  • Online examples: Open the HydroSight_ wiki page of additional example models.

Help menu:

  • Online Help: Open the online wiki help.
  • Algorithm Documentation: Open the algorithm documentation within the source code.
  • Publications: Access HydroSight related publications.
  • Check for updates at GitHub: Check for new HydroSight releases.
  • Submit bug report to GitHub: Submit a bug or feature request to the project site.
  • License and Disclaimer: View the software end user license and disclaimer.
  • Version: View the version of the release being used.
  • About: View the HydroSight splash screen.

In-built Help

The GUI also has built in help. Aspects of this help are summarised below and shown within the following figure.

  • tool-tips are provided within most sections of the GUI.
  • selected time-series models and functions show a summary pane describing the function (eg bottom-right of screenshot).

HydroSight Modules

The GUI consists of the following modules, each shown as a tab within the main interface. Depending upon what you want to do, only some of the modules may be required:

  • Project Description: optional step to record the project title and description.
  • Outlier Removal: a data analysis and outlier detection module for detecting and removing erroneous water level observation. This analysis can be undertaken independent of the following modules.
  • Time-series Model Construction: the time-series module for inputting data and defining the model structure.
  • Time-series Model Calibration: the time-series module for calibrating the constructed models.
  • Time-series Model Simulation: the time-series module to use a calibrated model for scenario investigations or hydrograph interpolation or extrapolation.

Keystroke Shortcuts

Keyboard shortcuts were added to version 1.4.1.4. The current keystroke shortcuts are:

Clone this wiki locally