General organisation

The window shown below appears when BaRatinAGE v3 starts up:

In addition to the classic menu and tool bars (the operation of which will be described in more detail later), this window has several main areas:

• On the left, the component explorer which allows you to navigate through the various components created in BaRatinAGE: hydraulic configurations, sets of gaugings, structural error models, rating curves, stage series and discharge series.
• On the right, from top to bottom:
  • the descriptive panel of the component selected in the explorer;
  • the thematic tabs of the component;
  • the input, computation and chart area corresponding to the selected thematic tab.

When BaRatinAGE starts up, a component of each type pre-exists, with fields that are either blank or filled in by default.

To illustrate how BaRatinAGE works more effectively, we are going to open a pre-registered study. To do this, click on the Open project… tool or in the File…Open project… menu (Ctrl+O), and open the file named Aisne_Verrieres_Example.bam in the example directory (this directory is located in the folder where you installed BaRatinAGE).

Navigating the graphical interface

The main window should now contain several components as shown in the figure below. The rationale of the GUI is to use the component explorer to navigate through BaRatinAGE. Left-click to select a component, which automatically updates the panels to the right. Right-clicking gives access to a number of tools (described in more detail later).

Note also that tooltips are omnipresent in the application. Don’t hesitate to consult them, as they often provide more detailed information than the names of fields, buttons, etc.

The descriptive panel of the component shows the type of component selected (icon and name), its name and its description (free text). It also includes the buttons Duplicate and Delete the component.

The thematic tabs of the component are specific to the component in question: they will be described in the following pages of this documentation, which detail these components one by one.

The same applies to the associated input, computation and chart area. The following functions can be found in the chart area itself:

• You can zoom in with the mouse by holding down the left click and drawing a rectangle from the top left-hand corner to the bottom right-hand corner. To return to the original axes, follow a similar procedure, but draw the rectangle from the bottom right-hand corner to the top left-hand corner;
• Right-click on the graph to access a menu with the following actions (also available via buttons above the figure):
  • Draw the figure in an external window;
  • Export the image in SVG vector format;
  • Export the image in PNG format;
  • Copy to clipboard.

Menus and actions on the components