Skip to content

Installation Guide

Follow this guide to install and set up TigerGraphX in your environment.

Requirements

This project requires Python 3.10, 3.11 or 3.12 and TigerGraph. Ensure you meet the following prerequisites before proceeding:

1. Python

  • Please ensure Python 3.10, 3.11 or 3.12 is installed on your system.
  • You can download and install it from the official Python website.

2. TigerGraph

TigerGraph is required for this project and can be set up in one of the following ways:

  • TigerGraph DB: Install and configure a local instance of TigerGraph.
  • TigerGraph Cloud: Use a cloud-hosted instance of TigerGraph.
  • TigerGraph Docker: Use a Docker container to run TigerGraph.

It is recommended to use TigerGraph LTS (Long-Term Support) Versions, which can be downloaded from the TigerGraph Downloads page. To enable support for TigerVector and leverage advanced features like hybrid retrieval, ensure you are using TigerGraph 4.2 or above.

Refer to the official TigerGraph Documentation for detailed installation and configuration instructions.

Installation Steps

Option 1: Install from PyPI

The simplest way to get started with TigerGraphX is by installing it directly from PyPI. Using a virtual environment is recommended to ensure a clean and isolated setup.

To install TigerGraphX, run: 

pip install tigergraphx

This allows you to quickly start using the library without needing the source code.

Verify Installation

After installing, verify that TigerGraphX is installed correctly by running: 

python -c 'import tigergraphx; print("TigerGraphX installed successfully!")'

If the installation was successful, you will see: 

TigerGraphX installed successfully!

This ensures that the library is properly installed and ready for use.

Option 2: Build from Source Code

If you want to modify or explore the source code, you can install TigerGraphX from its GitHub repository. The source code is available here: TigerGraphX on GitHub.

This project uses Poetry to manage dependencies. If you don’t have Poetry installed, follow the instructions on the Poetry website.

Once Poetry is installed, clone the repository, navigate to the project’s root directory, and use one of the following commands to install dependencies based on your needs:

Core Installation

If you need only the core functionality of TigerGraphX (without running application examples like GraphRAG, unit tests, or integration tests), run: 

poetry install --without dev

This command will:

  • Install only the dependencies required for the core features of TigerGraphX.

Development Installation

If you’re contributing to the project or want to use advanced features like running the GraphRAG examples or test cases, run: 

poetry install --with dev

This command will:

  • Install all core dependencies.
  • Include development dependencies defined under [tool.poetry.group.dev.dependencies] in pyproject.toml.

Verify Your Installation

After installing dependencies, verify your setup by listing the installed packages: 

poetry show --with dev

This ensures all required dependencies (including optional ones) are successfully installed.

Next Steps

Start unlocking the power of graphs with TigerGraphX today!