Installation#

Raphtory is a library for Python and Rust. Installation is as simple as invoking the package manager of the corresponding programming language.

Python Rust

pip install raphtory

cargo add raphtory

# Or Cargo.toml
[dependencies]
raphtory = { version = "x"}

Importing#

To use the library import it into your project:

Python Rust

import raphtory as rp

use raphtory::prelude::*;

Docker image#

Both the Python and Rust packages are available as official Docker images from the Pometry Docker Hub page.

To download these using the docker CLI run:

Python Rust

docker pull pometry/raphtory:latest-python

docker pull pometry/raphtory

Running either container will start a Raphtory server by default, if this is all you need then the Rust image is sufficient.

However, the Python image contains the Raphtory Python package and all the required dependencies. You should use this image if you want to develop using the Python APIs in a containerised environment.

You can run a Raphtory container with the following Docker command:

docker run --rm -p 1736:1736 -v "$(pwd):/home/raphtory_server" pometry/raphtory:latest-python

For more information about running and configuring containers see the Docker documentation.