Skip to content

QUICKSTART.md

Latest commit

 

History

History
182 lines (130 loc) · 3.55 KB

QUICKSTART.md

File metadata and controls

182 lines (130 loc) · 3.55 KB

ChatSeek Quickstart Guide

Get up and running with ChatSeek in 5 minutes!

Prerequisites

  • Python 3.8 or higher
  • Neo4j database (5.18.1+)
  • Anthropic or OpenAI API key

Step 1: Installation

# Clone the repository
cd /home/patch/PycharmProjects/chatseek

# Install in development mode
pip install -e ".[dev]"

# Or minimal installation
pip install -e .

Step 2: Configuration

# Copy example environment file
cp .env.example .env

# Edit .env with your credentials
nano .env  # or use your preferred editor

Required settings in .env:

NEO4J_URI=neo4j://localhost:7687
NEO4J_USERNAME=neo4j
NEO4J_PASSWORD=your_password

ANTHROPIC_API_KEY=your_key_here

Step 3: Validate Installation

python scripts/validate_installation.py

You should see all checks pass ✓

Step 4: Run First Example

python examples/quickstart.py

This will:

  1. Load configuration
  2. Test Neo4j connection
  3. Run a sample query
  4. Show next steps

Step 5: Try Interactive Examples

Option A: Jupyter Notebooks (Best for Learning)

# Install notebook dependencies
pip install -e ".[notebooks]"

# Start Jupyter
jupyter notebook

# Open: notebooks/01_quick_start.ipynb

Option B: Streamlit GUI (Best for Demos)

# Install demo dependencies
pip install -e ".[demos]"

# Run Streamlit app
streamlit run demos/app.py

Option C: Python Scripts (Best for Automation)

# GraphRAG queries
python examples/query_examples.py

# GEO submissions
python examples/geo_examples.py

Common Issues

"Configuration error: NEO4J_PASSWORD is required"

Make sure your .env file exists and has all required fields.

"Neo4j connection failed"

Check that:

  1. Neo4j is running: sudo systemctl status neo4j
  2. URI is correct in .env
  3. Username/password are correct
  4. Firewall allows connection on port 7687

"ModuleNotFoundError: No module named 'chatseek'"

Install the package:

pip install -e .

"ANTHROPIC_API_KEY not set"

Add your API key to .env:

ANTHROPIC_API_KEY=sk-ant-...

What's Next?

  1. Learn GraphRAG Queries: notebooks/02_graphrag_basics.ipynb
  2. Try GEO Submissions: notebooks/05_geo_submission_walkthrough.ipynb
  3. Create Custom Templates: docs/user_guide/custom_templates.md
  4. Read Full Docs: docs/index.md

Getting Help

  • Check IMPLEMENTATION_STATUS.md for current implementation status
  • See docs/ for detailed documentation
  • Open an issue on GitHub for bugs
  • Review research/claude_docs/ for original design docs

Architecture Overview

chatseek/
├── chatseek/          # Main package
│   ├── core/          # Configuration & database
│   ├── graphrag/      # Query engine
│   ├── geo/           # GEO submission
│   └── templates/     # Built-in templates
├── examples/          # Python scripts
├── notebooks/         # Jupyter notebooks
├── demos/             # Streamlit apps
└── tests/             # Test suite

Quick Command Reference

# Installation
pip install -e .                    # Minimal
pip install -e ".[dev]"             # With dev tools
pip install -e ".[all]"             # Everything

# Validation
python scripts/validate_installation.py

# Examples
python examples/quickstart.py
python examples/query_examples.py
python examples/geo_examples.py

# Demos
streamlit run demos/app.py
jupyter notebook

# Tests
pytest tests/

# CLI (once implemented)
chatseek query "Your question"
chatseek geo submit --study GBM_001

Happy querying! 🧬