Getting Started¶
The following will guide you through the installation of the package and the first steps to use it.
Prerequisites¶
PathpyG is available for Python versions 3.10 and above. It is not recommended to install it on your system Python. Instead, we recommend using a virtual environment such as conda or virtualenv. You can also set up a Docker image as described in the next section.
Installation¶
Once you have an environment up and running, you can install the package simply via pip. But first make sure that you installed the necessary dependencies.
Dependencies¶
This package is based on PyTorch and PyTorch Geometric. Please install both libraries before installing PathpyG. You can follow the installation instructions in their respective documentation ( PyTorch and PyG).
Warning
We currently only support PyG version 2.5.0 and above.
Install Stable Release¶
You can install the latest stable release of PathpyG via pip:
TODO
This is not yet available. We will release the first stable version soon.
Install Latest Development Version¶
If you want to install the latest development version, you can do so via pip directly from the GitHub repository: