Skip to content

Installation

Prerequisites

  • Python 3.12+
  • Docker (optional but recommended for FalkorDB and microservices)

Install uv

We recommend using uv for dependency management. See astral.sh/uv for installation instructions.

Clone and Setup

  1. Clone the Repository

    bash git clone https://github.com/jultou-raa/GraphMDO.git cd GraphMDO

  2. Install Dependencies

    bash uv sync

    This will create a virtual environment and install all dependencies specified in pyproject.toml.

Setup FalkorDB

FalkorDB is required for graph storage. The easiest way to run it is via Docker.

docker run -p 6379:6379 -it falkordb/falkordb

Alternatively, you can use the provided docker-compose.yml to spin up the entire stack.

docker compose up -d

This will launch: - FalkorDB (Port 6379) - Graph Service (Port 8001) - Execution Service (Port 8002) - Optimization Service (Port 8003)

Note: in the current Compose file, the optimization service does not receive GRAPH_SERVICE_URL. To use /optimize from the containerized optimization service, add GRAPH_SERVICE_URL=http://graph-service:8001 to the optimization-service environment in docker-compose.yml, or run the optimization service locally.