Skip to content

project_running_guide.md

Latest commit

 

History

History
412 lines (311 loc) · 10.7 KB

project_running_guide.md

File metadata and controls

412 lines (311 loc) · 10.7 KB

🚀 META MINDS - Project Running Guide

This guide provides comprehensive instructions for running the Meta Minds AI-powered data analysis platform with hybrid input system, offline fallback mode, and context-aware question generation.

📋 Prerequisites

Before running Meta Minds, ensure you have:

  • Python 3.13+ installed on your system
  • OpenAI API key (optional - offline mode available)
  • CSV/Excel/JSON datasets to analyze
  • Internet connection (optional - offline fallback mode available)
  • Input system setup (optional but recommended for better quality)

🎯 Option 1: Standard Command Line Execution (Recommended)

Step 1: Setup Environment

# Navigate to project directory
cd "C:\Users\Jatin\Documents\Automation - DS [INDIVIDUAL]\1. META_MINDS"

# Create virtual environment (if not exists)
python -m venv venv
.\venv\Scripts\Activate.ps1

# Install dependencies
pip install -r requirements.txt

# Create .env file with your API key (optional)
echo "OPENAI_API_KEY=your_openai_api_key_here" > .env

Step 2: Setup Input System (Recommended)

# Create input folder for context-aware analysis
mkdir input

# Add business background (copy from examples)
# Create Business_Background.txt with project context

# Add senior stakeholder message (copy from examples)  
# Create message.txt with executive instructions

Step 3: Run the Platform

# Standard execution with new architecture
py src\core\main.py

What Happens:

  1. ✅ System Check: Validates Python version, API key, dependencies
  2. 📝 Hybrid Context Collection: Reads from input/ folder + interactive prompts
  3. 🔢 Question Configuration: Set question counts (15 individual + 10 comparison)
  4. 📁 Dataset Input: Provide paths to your data files
  5. 🚀 AI Processing: Generates context-aware analytical questions
  6. 🔄 Offline Fallback: Automatic fallback if API limits reached
  7. 📊 Report Generation: Creates professional reports in /Output folder

🎯 Option 2: Virtual Environment Execution

Step 1: Activate Virtual Environment

# Navigate to project directory
cd "C:\Users\Jatin\Documents\Automation - DS [INDIVIDUAL]\1. META_MINDS"

# Activate virtual environment (Windows)
venv\Scripts\activate

# For PowerShell
venv\Scripts\Activate.ps1

# For Command Prompt
venv\Scripts\activate.bat

Step 2: Run with Virtual Environment

# After activation, run with new architecture
py src\core\main.py

Step 3: Deactivate (After Use)

# Deactivate virtual environment
deactivate

💡 Note: If virtual environment is corrupted, use Option 1 with system Python. The system will automatically handle offline mode if API issues occur.

🎯 Option 3: Direct Python Version Execution

Method 3A: Python Launcher (Windows)

# Use Python launcher to specify version
py -3.13 src\core\main.py

# Alternative version specification
py -3 src\core\main.py

# Check available Python versions
py -0

Method 3B: Full Python Path

# If Python is in PATH
python3.13 src\core\main.py

# With full path (adjust path as needed)
"C:\Python313\python.exe" src\core\main.py

Method 3C: Alternative System Python

# Try different Python commands
python src\core\main.py
python3 src\core\main.py
py src\core\main.py

🎯 Option 4: IDE/Editor Execution

Visual Studio Code

  1. Open project folder in VS Code
  2. Open src\core\main.py
  3. Select Python interpreter (3.13+)
  4. Press F5 or click Run Python File
  5. Use integrated terminal for input

PyCharm

  1. Open project in PyCharm
  2. Configure Python interpreter (3.13+)
  3. Right-click src\core\main.py → Run 'main'
  4. Use console for interactive input

Jupyter Notebook/Lab

# In a new notebook cell
%cd "C:\Users\Jatin\Documents\Automation - DS [INDIVIDUAL]\1. META_MINDS"
%run src\core\main.py

🎯 Option 5: Batch File Execution (Windows)

Create Run Script

Create run_meta_minds.bat:

@echo off
cd /d "C:\Users\Jatin\Documents\Automation - DS [INDIVIDUAL]\1. META_MINDS"
py -3.13 src\core\main.py
pause

Execute Script

# Double-click the .bat file or run from command line
run_meta_minds.bat

🎯 Option 6: PowerShell Script Execution

Create PowerShell Script

Create run_meta_minds.ps1:

# Set execution policy (run once as administrator)
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

# Navigate and run
Set-Location "C:\Users\Jatin\Documents\Automation - DS [INDIVIDUAL]\1. META_MINDS"
py -3.13 src\core\main.py

Execute Script

# Run PowerShell script
.\run_meta_minds.ps1

🎯 Option 7: Scheduled/Automated Execution

Task Scheduler (Windows)

  1. Open Task Scheduler
  2. Create Basic Task
  3. Set Trigger (daily, weekly, etc.)
  4. Set Action: Start a program
  5. Program: py
  6. Arguments: -3.13 main.py
  7. Start in: Project directory path

Command Line Scheduling

# Schedule daily execution at 9 AM
schtasks /create /tn "MetaMinds" /tr "py -3.13 main.py" /sc daily /st 09:00 /sd "C:\Users\Jatin\Documents\Automations - DS\META_MINDS_INDIVIDUAL"

🎯 Option 8: Network/Remote Execution

Remote Desktop

  1. Connect to remote machine via RDP
  2. Follow any standard execution method
  3. Transfer datasets and retrieve reports

SSH (if applicable)

# Connect via SSH (if SSH server enabled)
ssh user@remote-machine
cd "/path/to/META_MINDS_INDIVIDUAL"
python3.13 main.py

🔧 Troubleshooting Different Execution Methods

Issue 1: Python Not Found

# Check Python installation
py --version
python --version
python3 --version

# Install Python 3.13 if missing
# Download from: https://python.org/downloads/

Issue 2: Virtual Environment Issues

# Bypass virtual environment
py -3.13 main.py

# Recreate virtual environment
python -m venv new_venv
new_venv\Scripts\activate
pip install -r requirements.txt

Issue 3: Permission Errors

# Run as administrator (if needed)
# Right-click PowerShell → "Run as administrator"

# Or use different user permissions
runas /user:administrator "py -3.13 main.py"

Issue 4: Path Issues

# Use absolute paths
cd "C:\Users\Jatin\Documents\Automations - DS\META_MINDS_INDIVIDUAL"

# Check current directory
pwd   # Linux/Mac
cd    # Windows

Issue 5: API Key Issues

# Check .env file exists
dir .env
ls .env

# Verify API key format
type .env
cat .env

# Recreate .env file
echo "OPENAI_API_KEY=sk-..." > .env

📊 Execution Method Comparison

Method Pros Cons Best For
Standard CLI Simple, reliable, system Python None Most users
Virtual Environment Isolated dependencies Setup complexity, can break Development
Python Launcher Version control, flexible Windows only Multiple Python versions
IDE Execution Debugging, integrated tools IDE overhead Development/debugging
Batch Script One-click execution, automation Windows only Regular users
PowerShell Advanced scripting, automation Permission issues Power users
Scheduled Automated execution Setup complexity Regular reports
Remote Server execution, scaling Network dependency Enterprise use

🎯 Quick Start Commands by System

Windows (Recommended)

cd "C:\Users\Jatin\Documents\Automation - DS [INDIVIDUAL]\1. META_MINDS"
py src\core\main.py

Windows (Alternative)

cd "C:\Users\Jatin\Documents\Automation - DS [INDIVIDUAL]\1. META_MINDS"
python src\core\main.py

Windows (Virtual Environment)

cd "C:\Users\Jatin\Documents\Automation - DS [INDIVIDUAL]\1. META_MINDS"
venv\Scripts\activate
py src\core\main.py

Linux/Mac (If Applicable)

cd "/path/to/1. META_MINDS"
python3.13 src/core/main.py

📋 Pre-Execution Checklist

Before running Meta Minds, verify:

  • Python 3.13+ installed and accessible
  • OpenAI API key in .env file (optional - offline mode available)
  • Project directory is correct (1. META_MINDS)
  • Input system setup (optional but recommended)
  • Datasets ready (CSV/Excel/JSON files)
  • Internet connection (optional - offline fallback available)
  • Terminal/Command Prompt open in project directory

🎯 Expected Output Structure

After successful execution, you'll find:

Output/
├── Individual_[Focus]_[Objective]_[Audience]_[DateTime].txt
└── Cross-Dataset_[Focus]_[Objective]_[Audience]_[DateTime].txt

user_context.json (updated with preferences)

Example Files:

  • Individual_Financialanalysis_Riskassessmentriskas_Executives_2025-09-10_21-05.txt
  • Cross-Dataset_Financialanalysis_Riskassessmentriskas_Executives_2025-09-10_21-05.txt

Features:

  • ✅ Context-aware questions with business background integration
  • ✅ Executive-focused language and strategic orientation
  • ✅ Industry-specific terminology and risk assessment focus
  • ✅ Offline mode capability with 100% reliability

💡 Best Practices

  1. Use Option 1 (Standard CLI) for most reliable execution
  2. Set up input system for better question quality (+150% improvement)
  3. Keep datasets organized in accessible folders
  4. Use consistent API keys across sessions (optional - offline mode available)
  5. Check Output folder for generated reports
  6. Review user_context.json for saved preferences
  7. Use meaningful dataset names for easier identification
  8. Test offline mode for 100% reliability
  9. Monitor rate limiting - system handles automatically

🆘 Emergency Execution (If Nothing Works)

If all methods fail, try this minimal approach:

# 1. Download fresh Python 3.13
# 2. Install manually from python.org
# 3. Open Command Prompt as Administrator
# 4. Navigate to project folder
cd "C:\Users\Jatin\Documents\Automation - DS [INDIVIDUAL]\1. META_MINDS"

# 5. Install dependencies manually
pip install openai crewai pandas langchain-openai

# 6. Create API key file manually (optional)
echo OPENAI_API_KEY=your_key_here > .env

# 7. Run with full path
C:\Python313\python.exe src\core\main.py

# 8. System will automatically use offline mode if API issues occur

Choose the execution method that best fits your environment and expertise level. The Standard CLI method (Option 1) is recommended for most users. The system now features hybrid input system and offline fallback mode for maximum reliability and quality. 🚀