h2phy / README.md
laichai's picture
Update README.md
b32c8b7 verified
metadata
title: H2 Physics Feynman Bot
emoji: ⚛️
colorFrom: blue
colorTo: purple
sdk: docker
app_file: app.py
pinned: false
license: mit

⚛️ H2 Physics Feynman Bot

An AI physics tutor using Groq API with Richard Feynman's teaching style, designed for Singapore H2 Physics students.

🚀 Quick Start

  1. Get a FREE Groq API key from console.groq.com
  2. Enter your API key in the sidebar
  3. Select a physics topic from the dropdown
  4. Start chatting with Feynman!

🎯 Features

  • 🎓 Feynman-style tutoring - Teaches like the Nobel laureate
  • 📊 Graph plotting - Generates physics graphs with Python
  • 🖼️ Diagram search - Finds relevant physics diagrams
  • 🗣️ Text-to-speech - Reads responses aloud
  • Fast responses - Powered by Groq's LPU technology
  • 🆓 Free tier - 10,000 requests/month

🛠️ Setup on Hugging Face

Method 1: Quick Deploy

  1. Fork this Space (click Fork button)
  2. Add your Groq API key in Settings → Secrets:
  3. Wait for build (2-5 minutes)

Method 2: Manual Setup

  1. Create new Space on Hugging Face
  2. Select "Docker" as SDK
  3. Upload files:
  • app.py
  • Dockerfile
  • requirements.txt
  • README.md (this file)
  1. Add API key as Secret Add Secrets (in Space settings → Settings → Secrets):
    DEEPSEEK_API_KEY: "your-deepseek-api-key-here"
    # Optional for image search:
    GOOGLE_SEARCH_KEY: "your-google-search-key"
    GOOGLE_CX: "your-google-cx"
    GOOGLE_SEARCH_KEY_2: "your-google-search-key-2"  # optional backup
    
  2. Wait for build

📚 Topics Covered

Based on Singapore H2 Physics (9478) Syllabus) Based on Singapore H2 Physics (9478) Syllabus:

Measurement & Uncertainty

Kinematics & Dynamics

Forces & Turning Effects

Work, Energy, Power

Circular Motion

Gravitational Fields

Thermal Physics

Oscillations & Waves

Electricity & DC Circuits

Electromagnetism (EMI/AC)

Modern Physics (Quantum/Nuclear)

Paper 4: Practical Skills