Reference

Welcome to the reference guide of SAInt. The reference aims at describing the components. It is only information based and does not explain how to use the software. The reference guide covers all SAInt modules (electricity, gas, etc.). Therefore the images used should be seen as interchangeable between modules. The reference describes the software layers, graphical user interface, objects, properties, scenarios, functions, and scenarios. In addition, the glossary lists the commonly used terms, unit types available, abbreviations, and acronyms.

The reference guide does not require internet access. However, the documentation is dynamic and continuously updated. When opening the documentation, if an internet connection is available, a message will inform the user that there are changes that can be downloaded.

The documentation is accessible by pressing F1 in any SAInt window. This will redirect the user to the specific topic inside the reference guide.

List of typographical conventions used in SAInt’s documents:

  • A function used in the command line or an IronPython script is formatted as plot(FGEN.NAME.P).

  • Properties of SAInt’s objects or classes of any model is indicated as PSETDEF.

  • An action performed using the keyboard is → Ctrl+F.

  • An action performed using buttons in SAInt’s graphical user interface is formatted as Add New Row.

  • A list of actions performed using buttons in SAInt’s graphical user interface is formatted as Import  Network  Gas Network (GNET).

  • For any gas related material the style used is → GDEM.

  • For any electric related material the style used is → WIND.

  • For any thermal related material the style used is → HSUP.

  • For any hub related material the style used is → HSUP.

  • The abbreviations have a hover text as shown here → SAInt.

Please contact us at support@encoord.com if you have any suggestion or request.

SAInt uses multiple open-source libraries with different license requirements, including varying requirements for source code availability for modifications.

The user can find the complete list of third-party open-source libraries in the file "third-party-notices.txt" available from the SAInt installation folder (typically C:\Program Files\encoord\SAInt-v3) along with details on the package name, the version, the project URL, the description of the package, the license type and URL, copyright, and link to the public repository of the modified source code (when required).

Full license texts for the open-source licenses are provided in separate files in the folder LicenseTexts in the installation directory. The following licenses are available:

  • Apache-2.0.txt

  • BSD-3-Clause.txt

  • GDAL-LICENSE.TXT

  • LGPL-2.1.txt

  • LGPL-3.0.txt

  • MIT.txt

  • Python-License.txt