pySAInt Manual

pySAInt is a data management tool designed to help SAInt users create, organize, and/or edit their SAInt datasets using Python. It contains a lightweight “clone” of the SAInt object model including networks, objects, scenarios, profiles, and events. With pySAInt, users can easily define these components and how they relate to one another as an energy model to be used in SAInt. pySAInt users can easily export their datasets in Excel format ready to be imported into the SAInt software. pySAInt also streamlines connecting to the SAInt API from Python and there also includes some limited support for writing results from SAInt to csv files.

pySAInt is supplemental to SAInt and is not designed to replace SAInt in any way. pySAInt is intended to be a “sandbox” in which experienced users of SAInt with some Python programming experience can automate/streamline their use of SAInt. Users should always refer to information directly from SAInt - including modeling results, log files, and other messages - for confirmation that their modeling work with SAInt is implemented as they intended. Liability for understanding how pySAInt can be leveraged to use SAInt properly is the sole responsibility of the user.

Disclaimer

pySAInt is provided “as is” to help experienced users of SAInt in their workflow. Support for pySAInt may be provided on a limited basis as needed, including version updates corresponding to public releases of SAInt and bug fixes for any critical bugs users may find in the tool. pySAInt users may request additional features and provide other feedback about the tool, but encoord assumes no obligation to expand the functionality of the tool.

Please read the license agreement for further details.

1. User Installation Instructions

pySAInt is hosted in a private GitHub repository, and you will need a GitHub account with access to the repository to clone it.

1.1. Requirements

  • Git Ensure Git is installed on your machine.

  • Python: Python version 3.8 or higher is required.

  • GitHub Account: A GitHub account is needed to clone the repository.

Request access to the GitHub repository by sending an email to support@encoord.com.

1.2. Installation

  1. Clone the pySAInt repository by running the following command in your Python IDE terminal:

    $ git clone https://github.com/encoord/pySAInt
  2. Navigate to the cloned directory:

    $ cd path/to/pySAInt
  3. Install the tool with the following command:

    $ pip install .