Ribbon Bar

The Data provider tab allows the user to select and set the solar and wind weather provider to retrieve data useful to develop an electric network model. For each data provider, the user can specify — if needed — login credentials, server URL, and search criteria (e.g., year, geographic location, time granularity, etc.). Data providers and criteria can be updated or modified at any time by the user. See the section "Integrating Weather Resource Data" for details on the data provider or go to the How-To guide "Connect to Weather Resource Data Providers".

The Color legend tab allows the user to edit and customize the legends used to display branches and nodes properties in the map window.

In the case of branches, Figure 5 shows how the legend can be customized per network, parameter, and unit of measure. The options Color, Value From, and To Value allow to obtain a categorized legend, where each class is defined in terms of the range of the values of the parameter, and color. The number of classes can be changed using the option "Add new row". In the example of the figure, the base voltage magnitude, in kilovolts at the branch level, is categorized into 5 classes. Ranges for each class are automatically define as the option Automatic is checked (by default). The blue class starts at minimum value. The red class ends at the maximum value. The remaining breaks are defined by calculating four equally spaced intervals.

The user can customize the following options of the branch legend settings:

In the case of nodes, Figure 6 shows how the legend can be customized per network, parameter, and unit of measure. The fill color of the nodes can be personalized for results divided into the negative region (i.e., the minimum value and zero excluded), and the positive region (from zero excluded to the maximum). Values equal to zero are represented in a white. If both extreme are in the same region, only one color is visible. The size of the nodes is personalized using a user defined number of classes with their own ranges. The number of classes can be changed. In the example of the figure, only the color is active. No sizing of the nodes is selected as the sliding bar on the right of the "Size Values" entry is not active.

As in the case of the branch legend, the user can customize the following options of the node legend settings:

The Default Chart tab allows the user to customize the "default charts" produced by SAInt for the different network objects. Figure 8 shows an example of electric externals in a DCUCOPF scenario of an electric network. Please, note that only a parent object can be customized in terms of properties, units, axis, color, and so on in the chart. A child object inherits the graphical properties from its parent object, and so its own chart’s properties cannot be modified. A customized default charts configuration file can be saved for future use or loaded from a previous project. After customization, the user can also reset all specified properties to the installation defaults. The plot commands section displays the function used to generate the default plot.

The user can select the following options of the default chart settings:

The Units tab allows the user to specify the currency and the units of measure for all properties of parameters and quantities estimated in SAInt. As shown in the example of Figure 9, objects' properties are listed along with their SAInt code, and the unit of measure, which is accessible from a drop-down list ▼. Properties can be grouped to facilitate management operations. The settings can be saved to an external units file, or loaded from an external units file. SAInt centralizes the management of units of measure in the units tab, but it allows to use of alternative units in charts or simulation scenarios, and it takes care of a correct units conversion. For a step-by-step explanation of the use of the unit settings go to the How-To guide "Change Units of Measure and Currency".

Once the units of measure are set, they are valid for all projects, till the next change. Unit settings are a property of the software installation and not of a SAInt project or model. The user should pay attention when moving a project from one computer to another, because the local machine settings for the units may be different, and SAInt will automatically perform all necessary conversions.

The user can select the following options from the units settings:

Templates for the most common settings for the units of measure complying with the International System and the Imperial system are available in the directory Units under .\encoord\SAInt-v3\Settings.

The Fonts tab allows to personalize font properties for all parts of the GUI. As showed in Figure 10, the user can change fonts in the Command Window, the Map Window, the Log Window, the Project and Model Explorer, Workspace, tables, charts, and globally.

The font dialog box is accessible via …​ on the right side of the font column. The dialog box allows customizing the font family, the font style, the font size, effects, color, and script. A preview is shown in the sample section. The font color is used only to modify the Command Window.

The miscellaneous tab allows editing the properties related to the node bar, imported polylines from a shapefile, solver iterations, solver residual tolerance, and other properties, as shown in Figure 12.

The user can modify the following options of the miscellaneous tab:

The File panel of the Network tab allows the user to create, open, save, copy, and close any network file available in the active project. Table 4 describes in detail the options available in the File panel.

The Data panel of the Network tab allows to import and export of data from and to SAInt. The user can include available data in SAInt format in the loaded network, import external data in different formats, or export SAInt data and networks to native or exchange formats. Table 5 describes in detail the options available in the Data panel.

The "include" option is designed so that the user can append or incorporate data, already in SAInt native format, in the active project. The data don’t need any transformation and are immediately available. Include allows to:

The "import" option is designed so that the user can transfer data into the active project from an external data source. The data need to be properly prepared and transformed. Templates are provided to support the user in the preparation phase and to reduce possible sources of errors. Import allows to:

The Export option is designed so that the user can transfer data from SAint to other SAInt users in a native format or to other users if an external format. SAInt uses the same templates or formats used for importing or including data. Export allows to:

The "convert" option is designed so that the user can convert the coordinate reference system (CRS) of the active network in a Cartesian map view to SAInt’s default CRS. The conversion procedure opens the network on a new geographic map view and closes the Cartesian one.

By selecting Convert CRS the user can choose among the available active networks. Figure 16 shows the window where the user can choose the CRS of the active network (i.e., the CRS of the displayed network in the Cartesian map view). The coordinates will be transformed to the CRS EPSG:4326 (i.e., WGS84). The user can select the desired CRS from the available list or filter and select by entering a string or the EPSG code in the "Filter CRS Type" field.

The "editor panel" of the Network tab gives access to the property editor for the networks available in a project in the GUI. The network property editor contains input and output properties such as the number of nodes, type of network, etc. The available items in the editor panel depend on the type of networks in the active project (e.g., the *.gnet editor is not visible if no gas network is loaded). Table 6 describes in detail the options available in the editor panel.

The "Sub" panel of the network tab allows the user to create new sub-system in any network of the active project in the GUI, or to open a table in the dock panel describing sub-systems. The available items in the "Sub" panel depends of the type of networks in the active project (e.g., the *.GSUB table is not visible if no gas network is loaded). Table 7 describes in detail the options available in the "Sub" panel.

The "New" option is designed so that the user can create a new sub-system in a network by using polygons or properties of the network (Figure 17). The New option allows the user to:

The Zone panel of the Network tab allows the user accessing tables with a list of zones and their corresponding properties. The type of options shown in the panel depends on the type of networks in the active project (e.g., a *.GZN table is not visible if no gas network is loaded). Table 8 describes in detail the options available in the Zone panel.

The Group panel of the Network tab allows the user accessing tables with a list of groups and their corresponding properties. The type of options shown in the panel depends on the type of networks in the active project (e.g., a *.EGRP table is not visible if no electric network is loaded). Table 9 describes in detail the options available in the Group panel.

The File panel of the Scenario tab, similarly to the File panel of the Network tab, allows the user to create, open, save, copy, and close any scenario file available in the active project. Table 10 describes in detail the options available in the File panel.

The Dialog window of the Scenario tab allows the user to define all necessary scenario properties or to select an existing scenario from the ones available in the active project. Figure 19 shows an example of a Scenario Dialog window for an electric DCUCOPF scenario (top) and an example of the scenario properties section for a dynamic gas scenario (bottom). In the example of the electric DCUCOPF scenario, it is possible to see that a SteadyACPF scenario has been already created, and it is available in the scenario list section. The scenario properties change according to the scenario type.

The Scenario Dialog window is designed so that the user can define or review the main properties of a simulation scenario. The list of options is the following:

The Data panel of the Scenario tab contains buttons to include, import, or export scenario events, profile, result, and network state to and from SAInt. The user can include available data in SAInt format in the active model, import external data in different formats, or export SAInt data and scenario-related information to native or exchange formats. Table 11 describes in detail the options available in the Data panel.

The Include button provides the following options:

The Import button provides the following options:

The Export button provides the following options:

The Editor panel of the Scenario tab allows the user to access the property editor for the active scenario in the GUI. The user can use the property editor to modify all aspects of a steady state or dynamic scenario such as simulation start and end time, time step, initial state, solver type, look ahead, etc. The type of buttons shown on the panel depends on the type of active network. Table 12 describes in detail the options available in the scenario Editor panel.

The Event panel of the Scenario tab allows the suer to access the scenario events table in the GUI. The user can use the table to manage all events of the active scenario. Table 13 describes in detail the options available in the scenario Event panel.

See the How-To guide Create a scenario event in SAInt-GUI for a step-by-step description on managing events.

The Profile panel of the Scenario tab allows the user to access the scenario profiles window in the SAInt-GUI. The user can use the profile window to manage profiles saved in the active network. The type of buttons shown on the panel depends on the type of active networks. Table 14 describes in detail the options available in the Scenario Profile panel.

See the How-To guide "Create a Profile in SAInt-GUI" and the guide "Assign a Profile to an Existing Event" for a step-by-step description on creating and assigning profiles.

The Execute panel of the Simulation tab contains functions for launching the execution of the different types of active scenarios available. The type of available buttons depends on the type of active networks. Table 15 provides details on the options. Please, note that a combined simulation can only be run when the time windows of the scenarios (e.g., electric and gas) have the same start and end time.

The Solver Interaction panel of the Simulation tab allows the user to interact with the solver by pausing, stopping or continuing a simulation. Table 16 provides details on the available options. When stopped, a simulation cannot be continued anymore. When paused, a simulation can be restarted by using the Continue. Note that for a paused simulation the displayed time in the map window indicates the latest timestep solved.

When the user stops a (quasi-)dynamic simulation or an optimization using Stop, SAInt aborts the execution and reports the status of the execution as "failed". Results computed till the moment of stopping are saved. The remaining period of the simulation or optimization is set to "NA" (not available).

Results are correctly saved only if the process is stopped in the SAInt-GUI. Results are not correctly saved if the user aborts the process in the API or by killing the SAInt process from the Task Manager of the operating system.

The Log panel of the Simulation tab allows the user to save the log file to a text file, to clear the information displayed in the window or to show a more detailed log file in the GUI. Table 17 provides details on the available options. Every new simulation automatically deletes the previous log files. Warnings are highlighted in yellow, orange, and red, according to the level of severity. The information related to loading and saving files are visible with a white background. The log file can be used to debug an infeasibility.

The Animation panel of the Simulation tab allows the user to navigate through the timesteps of the solved (quasi-)dynamic scenario and see the results in the active map window or charts. Table 18 provides details on the available options. By selecting the shift time using the ▼, the user can visualize inputs or outputs with different time granularity. By pressing Play, the animation starts and repeats until the user clicks again the button to stop it.

When executing a simulation, the user can change the active window to something different from a map. In case a table is selected, an active animation locks the refresh, and the values are not updated dynamically based on the timestep displayed.

The size and color of the arrows in an animation can be changed by modifying the property AnimationArrowSize and ArrowColor in "Branches Layer Setting" of the layer window.

The Electric, Gas, thermal, and Hub System panels of the Table tab allow to access properties and results in tabular form for all network objects in the active project. Use ▼ and ▲ to navigate through the section. Figure 22 shows the expanded form of the three panels after clicking on the drop-down button. By selecting an object in the list, a new table is available in the dock panel of the GUI.

Figure 23 shows, as an example, the result of selecting the FGEN object from the Electric panel. All generators in the active electric network are displayed along with user selected input and output properties. Properties are color coded following this convention:

The user can navigate the tabular form of results and properties using three main context menus:

The options of the global context menu options are shown in Figure 24.

The global context menu allows to:

The Column context menu is the same for all column header cells in a table (Figure 25). It provides access to the following set of options:

Conditional formatting allows the user to selectively format and style the content of rows and cells based on specific conditions and expressions (Figure 26). Multiple rules can be defined or removed from a table. Each rule must have a unique name, and must apply to a certain column. Rules must be developed based on predefined conditions (e.g., equal, greater, between value one and value two) or user defined expressions and involved up to two reference values. The user can format multiple aspects like the font used in cells and rows, the text alignment, the font color or the background color.

Finally, the Row context menu is accessed by right-clicking on any cell of a table (Figure 27). This context menu might slightly vary according to the cell selected.

In general, Row context menu provides the following options, and have other object related entries:

The very last element available in the Table tab is the button PLG, which gives access to a table describing the polygons available in the active project with their properties. It allows the user to personalize each polygon for the name, visibility, color, and other geographic aspects (e.g., Figure 28).

Polygons are cosmetic entities available only in Cartesian maps. As graphical objects in the map view, polygons help provide the user with background elements that support and enrich the understanding of the network.

The easiest way to incorporate polygons in a SAInt model is to import them from an external source. SAInt offers the possibility of importing polygons in shapefile format or from a Synergi project.

SAInt saves polygons in a dedicated file with extension *.plg along with possible attributes (stored in the Info property) and graphical properties like fill color, line color, and width, or line style.

By default, SAInt does not load polygons available in the project or network folders. The user must explicitly load polygons and save the project to restore them later. To load polygons from a *.plg file, select Network>Data>Include  Polygon File.

To remove polygons from the project, select the entry "Polygons" in the model explorer, and from the context menu, select "Unload Polygon(s)". This option does not delete the polygons but removes them from the active project.

Finally, polygons can be exchanged between projects. Either you share a copy of the *.plg file or from the context menu of the entry "Polygons" select the option "Export Polygon(s)" to save to a new polygon file.

SAInt has limited editing capabilities for polygons. But if the user needs to modify the geometry and the position of the vertices of a polygon, the coordinates and the list of vertices can be edited from the property editor after selecting the polygon and accessing the "Collection Editor" from the "Polygons" entry.

For more details on how to change the graphical properties of polygons, go to the How-To guide Edit Properties of Polygons.

The Window panel of the view tab allows the user to open previously closed windows of the GUI. A window is reopened in its default position. Two exceptions are the map window and the script window. A map window is simply added to the available map windows in the dock panel. More than one map view (of the same type) can be available at the same time. The button Script allows to create a brand-new IronPython script or to open an existing script. The full list of options is available in Table 19.

The Layout panel of the View tab provides options to dock and open all windows in the dock panel, to close all floating windows in the dock panel, or hide all windows in the dock panel. The full list of options is available in Table 20.

The Documentation panel collects functions related to the local copy of SAInt documentation. The learn more menu option may not be yet available in this release. In general, the documentation is quickly accessible by pressing the keyboard key F1 in any SAInt window or over any SAInt graphical element. This action will redirect the user to the specific topic for that element inside the reference guide. The full list of options is available in Table 21.

The community panel allows access to the online forum, where the users meet to discuss SAInt and of how to use SAInt to solve their challenges. The community can also take advantage of open-source model-ready datasets to speed up research and problem-solving in integrated planning and energy system modelling. Some video guides are also accessible to complement SAInt’s documentation. Table 22 summarizes the available functionalities.

The Support panel allows the user to contact the encoord’s support team. The full list of options is available in Table 23.

The license panel of the Help tab allows to check and read all necessary information and terms of the license of SAInt. Through this panel is also possible to request the renewal of an existing license. The full list of options is available in Table 24.

The about panel of the help tab shows the version of SAInt in use, and provides the link to encoord website. The full list of options is available in Table 25.

SAInt offers the user the option to share technical data directly with the "Customer Support Service" of encoord by means of the "Exception!" window, a pop-up window triggered whenever an action is throwing an error in the expected behavior of SAInt-GUI. The "Exception!" window asks the user to provide a valid e-mail and optionally to specify the name and a short description of the event leading to the exception (Figure 31). The technical details of the exception are available for inspection and are shared with the "Customer Support Service".

An error triggered by a Python script using the API or by an IronPython script in the GUI is handled by SAInt respectively by logging the Python exception messages to an external log file or by using a pop-up window with information of the IronPython script problem.