Installation:

1. Setup for this guide is Python 3.6 (not Anaconda) and PyCharm
2. After cloning / downloading the Repository to PyCharm set src Folder and test Folder as Rightclick → Mark Directory as → Sources Root.
   This is necessary to enable imports in the test Folder.
3. pySimmToolbox uses Treelib which can be installed with pip install treelib
4. pySimmToolbox uses the java open source simm library by acadiasoft. pySimmToolbox includes a precompiled jar of simm version 2.1 found at src →simmLib
5. To call simmLib from Python Pyjnius is used. Follow the installation instructions found here. It is recommended to use Java 8. Using Java 11 will as of Feb 2019 crash the installation of Pyjnius. (Note: Make sure that a Folder called 'JRE' can be found in your JDK. If not download the JRE and copy the JRE installation in the JDK folder. Rename the folder to just jre.)
6. Run Unittests by rightclicking on Directories in test root folder and selecting Run Unittests in ... where ... may be Calculation, CRIF, ResultTrees etc.

Usage:

If you want to import the Library and use it please check the usage examples found in sampleCode.py

Alternatively you can use the Frontend of the tool by starting src/Frontend/pySimmToolbox_v3.py and opening the html link displayed in the console.