This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Quick Start Guide

Get started quickly with NodeRAG This guide will help you set up and run your first NoteRAG project in minutes.

1 - Install from PyPI

Learn how to install NodeRAG using pip. This guide provides simple instructions for installing NodeRAG from PyPI.

Conda Setup

Create and activate a virtual environment for NodeRAG:

conda create -n NodeRAG python=3.10
conda activate NodeRAG

Install uv (Optional: Faster Package Installation)

To speed up package installation, use uv:

pip install uv

Install NodeRAG

Install NodeRAG using uv for optimized performance:

uv pip install NodeRAG

For the next step, see the build documentation to index your corpus.

2 - Install from Source

Learn how to install NodeRAG from source code. This guide provides step-by-step instructions for developers who want to build from source.

Prerequisites

Before installing NodeRAG from source, ensure you have the following requirements:

  • Python 3.10 or higher
  • Git
  • Miniconda
  • Additional dependencies listed in:
    • requirements.txt - Core dependencies
    • requirements.in - Development dependencies

Start

Environment

Clone from source

git clone https://github.com/Terry-Xu-666/NodeRAG.git
cd NodeRAG

Conda

conda create -n NodeRAG python=3.10
conda activate NodeRAG

Install

pip install uv
uv pip install requirements.txt
pip install requirements.txt

For the next step, see the build documentation to index your corpus.