Installation - sanitaravel/starship_analyzer GitHub Wiki

Installation Guide

This guide will help you set up Starship Analyzer on your system.

Prerequisites

  • Python 3.8 or higher
  • NVIDIA GPU with CUDA support (recommended but optional)
  • 8GB+ RAM recommended for processing high-resolution videos

Quick Start

  1. Clone the repository

    git clone https://github.com/sanitaravel/starship_analyzer.git
    cd starship_analyzer
    
  2. Run the setup script

    python setup.py
    

    This will:

    • Create a Python virtual environment
    • Detect CUDA availability for GPU acceleration
    • Install the right PyTorch version for your system
    • Set up all dependencies automatically
  3. Activate the virtual environment

    • Windows: venv\Scripts\activate
    • macOS/Linux: source venv/bin/activate

Manual Installation

If you prefer to set up the environment manually:

  1. Create a virtual environment:

    python -m venv venv
    
  2. Activate the virtual environment:

    • Windows: venv\Scripts\activate
    • macOS/Linux: source venv/bin/activate
  3. Install dependencies:

    pip install -r requirements.txt
    

Updating the Application

To update Starship Analyzer to the latest version without recreating your environment:

  1. Pull the latest code

    git pull
    
  2. Run the update command

    python setup.py --update
    

    This will:

    • Keep your existing virtual environment
    • Check your CUDA configuration
    • Update all dependencies to their required versions
    • Verify installations are working correctly
  3. When to update

    • After pulling changes from the repository
    • When new dependencies have been added
    • If you're experiencing compatibility issues
    • When new SpaceX webcast formats require updated analysis capabilities

Additional update options:

# Force CPU-only installation even if CUDA is available
python setup.py --update --force-cpu

# Run update without user interaction
python setup.py --update --unattended

System Requirements

Component Minimum Recommended
CPU Dual-core 2.0 GHz Quad-core 3.0+ GHz
RAM 4 GB 8+ GB
GPU Not required NVIDIA with CUDA support
Storage 500 MB + video space 1 GB + video space
Python 3.8 3.9+
OS Windows 10, macOS 10.15+, Linux Latest versions

Key Dependencies

  • OpenCV: For video processing and computer vision tasks
  • EasyOCR: For optical character recognition
  • PyTorch: Backend for OCR operations (GPU acceleration when available)
  • Matplotlib/Plotly: For visualization and data plotting
  • NumPy/Pandas: For data handling and analysis
  • yt-dlp: For downloading Starship webcasts

Troubleshooting Installation

If you encounter issues during installation, please check the Troubleshooting page.