What are the system requirements?

pathpy is pure python code. It has no platform-specific dependencies and should thus run without problems on any operating system. pathpy requires python 3.x. Since the end of life of python 2.x is scheduled for January 1st 2020, we will not offer a backport of pathpy for python 2. If you have dependencies on python 2.x, please consider using 2to3.

pathpy builds on the data science packages numpy and scipy, which will be set up automaticaly if you install pathpy using the package manager pip. Even though any python 3.x installation is fine, we recommend using the latest Anaconda distribution, an OpenSource python distribution that is pre-configured for data science and machine learning tasks.

How can I install pathpy?

The latest release version of pathpy can be installed via the python package index pypi. Just open a terminal and type:

> pip install pathpy2

If you have both a python 2 and a python 3 setup, you may have to use the command pip3 to specifically refer to your python 3 installation. Also, make sure to use the pyPI name pathpy2, since the pyPI package name pathpy has been namesquatted. We are currently working on a solution to this issue.

If you want to install the latest development version, you can directly download and install it from our github repository. In this version, some issues of the last release version may already be fixed, but please be aware that this code may be in flow. You can use pip to install the development version as follows:

> pip install git+git://github.com/uzhdag/pathpy.git

You can check your installation to make sure that everything is working fine. In the terminal, run the python interpreter and import the package as follows: 

> python
Python 3.6.6 |Anaconda, Inc.| (default) [...]
Type "help", "copyright", "credits" or "license" for more information.
>>> import pathpy as pp
>>> help(pp)
Help on package pathpy:

NAME
    pathpy

DESCRIPTION
    An OpenSource python package to analyze and
    visualize time series data on complex networks.
[...]

If you see the help message above, pathpy has been set up successfully and you are ready to take your first steps.