​

Quickstart Guide

​

Prerequisites

• Python 3.8 or higher
• pip (Python package installer)
• Git

​

Installation

​

1. Clone the Repository

git clone https://github.com/muhajirdev/quran-labs.git
cd quran-knowledge-graph

​

2. Install Dependencies

pip install -r requirements.txt

• Kuzu (graph database)
• Pandas and NumPy (data processing)
• Transformers and PyTorch (for embeddings)
• Other utilities and visualization libraries

​

Setting Up the Database

​

1. Initialize the Database

python -m quran_graph.scripts.init_db

• Create the database directory
• Define the schema (nodes and relationships)
• Set up indices for efficient queries

​

2. Import Data

python -m quran_graph.scripts.import_data

• Download data from qul.tarteel.ai (if not already present)
• Process and transform the data
• Import it into the Kuzu graph database
• Generate embeddings for verses, words, and topics

​

Running Your First Queries

from quran_graph.scripts.query_utils import QuranGraphQuery

# Initialize the query utility
query = QuranGraphQuery()

# Get information about the first chapter (Al-Fatiha)
chapters = query.get_chapters(limit=1)
print(chapters)

# Get verses from the first chapter
verses = query.get_verses_by_chapter(1)
print(verses)

# Perform a semantic search
results = query.semantic_search("mercy and forgiveness")
print(results)

​

Next Steps