pytrnsys-gui 0.10.15

A GUI for Trnsys

Graphical user interface for pytrnsys

Overview

A short presentation (15 min) of pytrnsys and its features can be found in the following YouTube video.

Documentation

You can find the documentation under https://pytrnsys.readthedocs.io/

Installation

In the following all commands should be run from the pytrnsys_gui directory. The command should be run in a "Windows Command Prompt" for Windows environment. The commands should be very similar should you wish to install on Linux.

Binary installation / User installation

Prerequisites

Required

1. Python 3.9

Getting started

1. Open a command prompt (e.g., by hitting the Windows-key, then typing "cmd" into the search box and hitting enter). The following commands should be entered into the command prompt just opened.

2. Navigate to the directory which should contain the pytrnsys-gui directory:

   cd [your-directory]
   

   Replace [your-directory] (including the brackets []) with your directory of choice: if your directory is called foo then pytrnsys-gui will be installed to foo\pytrnsys-gui.

3. Create a virtual environment:

   py -3.9 -m venv pytrnsys-gui
   

4. Activate it:

   pytrnsys-gui\Scripts\activate
   

5. Install the wheel package:

   pip install wheel
   

6. Install pytrnsys-gui and its requirements:

   pip install -r https://raw.githubusercontent.com/SPF-OST/pytrnsys_gui/v0.10.1-reqs/requirements/release.txt
   

You can now close the command prompt opened in the first step.

Several original types are delivered with pytrnsys. For those you'll manually need to copy the dll-files from:

pytrnsys-gui\pytrnsys_data\ddcks\dlls

to the respective folder of your TRNSYS installation:

...\UserLib\ReleaseDLLs

The pytrnsys-gui can now be started by double-clicking on the pytrnsys-gui\Scripts\pytrnsys-gui.exe file. Example projects can be found in the pytrnsys-gui\pytrnsys_gui_data\examples directory.

Upgrading from one patch version to the next within the same minor version

There is a shortcut for upgrading from one patch version to the next within the same minor version, e.g., from 1.2.11 to 1.2.12:

1. Activate your virtual environment:

   pytrnsys-gui\Scripts\activate
   

2. Issue the following command:

   pip install --upgrade pytrnsys-gui
   

This method might not be 100% reliable. If you're experiencing problems, we recommend installing your preferred version from scratch as described above.

Installation from source / Developer installation

Prerequisites

Required

1. Python 3.9

2. Local clones of the following GIT repositories:

   1. https://github.com/SPF-OST/pytrnsys.git
   2. https://github.com/SPF-OST/pytrnsys_gui.git

   They should be next to each other and be called pytrnsys and pytrnsys_gui like so:

   parent/
     pytrnsys/
     pytrnsys_gui/
   

Recommended

• PyCharm Community IDE

Getting started

All the following commands should be run from the pytrnsys_gui directory. The commands specified are for a Windows environment. They are very similar for Linux.

1. Create a virtual environment:

   py -3.9 -m venv venv
   

2. Activate it:

   venv\Scripts\activate
   

3. Install the requirements:

   pip install wheel
   python -m pip install -r requirements\dev.txt
   

4. Generate Python files from the include Qt creator files:

   python dev-tools\generateGuiClassesFromQtCreatorStudioUiFiles.py
   

5. Tag the editable install of pytrnsys-gui

   setup.py egg_info -b dev
   

   (By adding this tag we make sure that the Qt Creator .ui files are re-generated each time the GUI is started.)
6. Now you can run pytrnsys-gui!

   cd trnsysGUI
   python GUI.py
   

Several original types are delivered with pytrnsys. For those you'll manually need to copy the dll-files from:

pytrnsys\data\ddcks\dlls

to the respective folder of your TRNSYS installation:

...\UserLib\ReleaseDLLs

Beware that the GUI can only be started from within the virtual environment you created in step 1. I.e., whenever you open a new console window from which you want to start the GUI you first need to activate the environment (step 2. above).