A GUI for Trnsys
Project description
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
Getting started
A video guiding through the following steps can be found on YouTube.
-
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.
-
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 calledfoo
thenpytrnsys-gui
will be installed tofoo\pytrnsys-gui
. -
Create a virtual environment:
py -3.9 -m venv pytrnsys-gui
-
Activate it:
pytrnsys-gui\Scripts\activate
-
Install the
wheel
package:pip install wheel
-
Install
pytrnsys-gui
and its requirements:pip install -r https://raw.githubusercontent.com/SPF-OST/pytrnsys_gui/master/requirements/releases/v0.9.1/requirements.txt
(Note: In the YouTube video the version is replaced manually, this is not necessary anymore, when copying the command line above.)
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\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:
- Activate your virtual environment:
pytrnsys-gui\Scripts\activate
- 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
-
Local clones of the following GIT repositories:
https://github.com/SPF-OST/pytrnsys.git
https://github.com/SPF-OST/pytrnsys_gui.git
They should be next to each other and be called
pytrnsys
andpytrnsys_gui
like so:parent/ pytrnsys/ pytrnsys_gui/
Recommended
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.
- Create a virtual environment:
py -3.9 -m venv venv
- Activate it:
venv\Scripts\activate
- Install the requirements:
pip install wheel pip install -r requirements\dev\requirements.txt
- 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 activate the environment (step 2. above).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pytrnsys_gui-0.9.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1292b321feb588046d87a765cdd3daf40ee2313fc46b58c4e6290ca639cf4f37 |
|
MD5 | 73bf956a16263364417613f0050b5916 |
|
BLAKE2b-256 | 612fbcc06708d43ffe91881395367e532bde0b2b259e722ec456542097025ecb |