Installation Guide¶
Installing Python¶
simbench is tested with Python 3.4, 3.5, 3.6 and 3.7. We recommend the Anaconda Distribution, which provides a Python distribution that already includes a lot of modules for scientific computing that are needed. Simply download and install the newest version of Anaconda and you are all set to run simbench.
Of course it is also possible to use simbench with other distributions besides Anaconda. It is however important that the following package is included:
pandapower
Installing simbench through pip¶
The easiest way to install simbench is through pip:
Open a command prompt (e.g. start–>cmd on windows systems)
Install simbench by running:
pip install simbench
Installing simbench without pip¶
If you don’t have internet access on your system or don’t want to use pip for some other reason, simbench can also be installed without using pip:
Download and unzip the current simbench distribution from PyPi under “Download files”.
Open a command prompt (e.g. Start–>cmd on Windows) and navigate to the folder that contains the setup.py file with the command cd <folder> :
cd %path_to_simbench%\simbench-x.x.x\
Install simbench by running :
python setup.py install
Development Version¶
To install the latest development version of simbench from github, simply follow these steps:
Download and install git.
Open a git shell and navigate to the directory where you want to keep your simbench files.
Run the following git command:
git clone https://github.com/e2nIEE/simbench.git
Navigate inside the repository and check out the develop branch:
cd simbench
git checkout develop
Open a command prompt (cmd or anaconda command prompt) and navigate to the folder where the simbench files are located. Run:
pip install -e .
This registers your local simbench installation with pip.
Test your installation¶
A first basic way to test your installation is to import simbench to see if all dependencies are available:
import simbench
If you want to be really sure that everything works fine, run the simbench test suite:
Install pytest if it is not yet installed on your system:
pip install pytest
Run the simbench test suite:
import simbench.test
simbench.test.run_all_tests()
If everything is installed correctly, all tests should pass or xfail (expected to fail).