pytrnsys-gui 0.9a14

A GUI for Trnsys

Graphical user interface for pytrnsys

Documentation

You can find the documentation under https://spf-ost.github.io/pytrnsys_gui/

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: replace [version] in the following command with the version you want to install (typically, you'd choose the latest stable version, i.e. the latest version not ending in aXX) and hit enter.

   pip install -r https://raw.githubusercontent.com/SPF-OST/pytrnsys_gui/master/requirements/releases/[version]/requirements.txt
   

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

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\examples directory.

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
   pip install -r requirements\dev\requirements.txt
   

4. Run pytrnsys-gui!

   cd trnsysGUI
   python GUI.py
   

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 active the environment (step 2. above).