Installing pyTigerGraph

This page walks you through installing pyTigerGraph on your machine.

Prerequisites

  • Python 3.0 or higher.

  • If you are installing pyTigerGraph[gds], make sure torch is installed in your Python environment.

Install pyTigerGraph

To download pyTigerGraph, run the following command in the command line or use the appropriate tool of your development environment (anaconda, PyCharm, etc.).:

pip3 install pyTigerGraph

Install pyTigerGraph[gds]

To utilize pyTigerGraph’s Graph Data Science (GDS) functionality, run the following command to install pyTigerGraph[gds].

pip3 install 'pyTigerGraph[gds]'

Certain GDS classes, such as data loaders, can produce output in PyTorch Geometric (PyG) or Deep Graph Library (DGL) formats. To support those formats, you need to have installed the respective packages in your Python environment:

It is optional to install either of the aforementioned packages. If you don’t install either of the packages, you can still use the GDS functions, and output results in panda frames.

Import pyTigerGraph

Once the package is installed, you can import it like any other Python package:

import pyTigerGraph as tg