Add automatic GitHub to Hugging Face sync workflow

.github/workflows/sync-to-huggingface.yml

@@ -0,0 +1,36 @@
+name: Sync to Hugging Face Space
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:  # Allows manual trigger from GitHub UI
+
+jobs:
+  sync-to-huggingface:
+    runs-on: ubuntu-latest
+    
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0  # Fetch all history for proper sync
+          lfs: true       # Enable Git LFS if needed
+      
+      - name: Push to Hugging Face Space
+        env:
+          HF_TOKEN: ${{ secrets.HF_TOKEN }}
+        run: |
+          git config --global user.email "ahilan.kumaresan@example.com"
+          git config --global user.name "Ahilan Kumaresan"
+          
+          # Add Hugging Face remote
+          git remote add hf https://AhiBucket:$HF_TOKEN@huggingface.co/spaces/AhiBucket/Hand-wave || true
+          
+          # Push to Hugging Face
+          git push hf main --force
+      
+      - name: Notify completion
+        run: |
+          echo "✅ Successfully synced to Hugging Face Space!"
+          echo "🌐 View at: https://huggingface.co/spaces/AhiBucket/Hand-wave"

AUTO_SYNC_SETUP.md

@@ -0,0 +1,197 @@
+# 🔄 Automatic GitHub → Hugging Face Sync Setup
+
+This guide will set up **automatic synchronization** so that every commit to GitHub automatically updates your Hugging Face Space.
+
+## ✨ What This Does
+
+- **Commit to GitHub** → Automatically pushes to Hugging Face
+- **Zero manual work** after initial setup
+- **Instant deployment** - changes go live automatically
+- **Works with any branch** (configured for `main`)
+
+---
+
+## 🚀 One-Time Setup (5 minutes)
+
+### Step 1: Get Your Hugging Face Token
+
+1. Go to: https://huggingface.co/settings/tokens
+2. Click **"New token"**
+3. Name it: `GitHub Actions Sync`
+4. Permission: Select **"Write"**
+5. Click **"Generate token"**
+6. **COPY THE TOKEN** (you won't see it again!)
+
+### Step 2: Add Token to GitHub Secrets
+
+1. Go to your GitHub repository: https://github.com/Ahilan-Bucket/Hand-wave
+2. Click **"Settings"** (top menu)
+3. In the left sidebar, click **"Secrets and variables"** → **"Actions"**
+4. Click **"New repository secret"**
+5. Name: `HF_TOKEN`
+6. Value: Paste your Hugging Face token
+7. Click **"Add secret"**
+
+### Step 3: Push the GitHub Actions Workflow
+
+```bash
+cd d:\Documents\SFU\PHYS385_Quantum2\CodeProjects\Hand-wave
+
+# Add the workflow file
+git add .github/workflows/sync-to-huggingface.yml
+
+# Commit
+git commit -m "Add automatic sync to Hugging Face Space"
+
+# Push to GitHub
+git push origin main
+```
+
+### Step 4: Verify It Works
+
+1. Go to: https://github.com/Ahilan-Bucket/Hand-wave/actions
+2. You should see the workflow running
+3. Wait for it to complete (green checkmark ✅)
+4. Check your Hugging Face Space: https://huggingface.co/spaces/AhiBucket/Hand-wave
+
+---
+
+## 🎯 How It Works
+
+```
+┌─────────────────┐
+│  You commit to  │
+│     GitHub      │
+└────────┬────────┘
+         │
+         ▼
+┌─────────────────┐
+│ GitHub Actions  │
+│  automatically  │
+│    triggers     │
+└────────┬────────┘
+         │
+         ▼
+┌─────────────────┐
+│   Pushes to     │
+│ Hugging Face    │
+│     Space       │
+└────────┬────────┘
+         │
+         ▼
+┌─────────────────┐
+│  Space rebuilds │
+│   automatically │
+│   (1-2 minutes) │
+└─────────────────┘
+```
+
+---
+
+## 📝 Daily Workflow (After Setup)
+
+From now on, your workflow is simple:
+
+```bash
+# 1. Make changes to your code
+# (edit app.py, functions.py, etc.)
+
+# 2. Commit to GitHub
+git add .
+git commit -m "Your change description"
+git push origin main
+
+# 3. That's it! 🎉
+# GitHub Actions automatically syncs to Hugging Face
+# Check progress at: https://github.com/Ahilan-Bucket/Hand-wave/actions
+```
+
+---
+
+## 🔍 Monitoring
+
+### Check GitHub Actions Status:
+https://github.com/Ahilan-Bucket/Hand-wave/actions
+
+### Check Hugging Face Space:
+https://huggingface.co/spaces/AhiBucket/Hand-wave
+
+### View Build Logs:
+- Click on any workflow run in GitHub Actions
+- Expand the steps to see detailed logs
+
+---
+
+## 🛠️ Troubleshooting
+
+### If sync fails:
+
+1. **Check the token**:
+   - Make sure `HF_TOKEN` secret is set correctly in GitHub
+   - Token must have **Write** permission
+
+2. **Check the workflow logs**:
+   - Go to: https://github.com/Ahilan-Bucket/Hand-wave/actions
+   - Click on the failed run
+   - Read the error messages
+
+3. **Manually trigger**:
+   - Go to: https://github.com/Ahilan-Bucket/Hand-wave/actions
+   - Click "Sync to Hugging Face Space"
+   - Click "Run workflow"
+
+### Common Issues:
+
+**"Authentication failed"**
+→ Token is incorrect or expired. Generate a new token and update the GitHub secret.
+
+**"Remote already exists"**
+→ This is normal and handled by the workflow (using `|| true`)
+
+**"Permission denied"**
+→ Make sure your token has **Write** permission, not just Read
+
+---
+
+## 🎨 Customization
+
+### Change the branch that triggers sync:
+
+Edit `.github/workflows/sync-to-huggingface.yml`:
+
+```yaml
+on:
+  push:
+    branches:
+      - main        # Change this to your preferred branch
+      - develop     # Or add multiple branches
+```
+
+### Add email notifications:
+
+You can add email notifications in GitHub Actions settings:
+1. Go to: https://github.com/Ahilan-Bucket/Hand-wave/settings
+2. Click "Notifications"
+3. Configure as desired
+
+---
+
+## ✅ Benefits
+
+- ✨ **Zero manual deployment** - Just commit and push
+- 🚀 **Fast updates** - Changes go live in minutes
+- 🔒 **Secure** - Token stored as GitHub secret
+- 📊 **Trackable** - See deployment history in GitHub Actions
+- 🔄 **Reliable** - Automatic retries if deployment fails
+
+---
+
+## 📚 Additional Resources
+
+- GitHub Actions Docs: https://docs.github.com/en/actions
+- Hugging Face Spaces Docs: https://huggingface.co/docs/hub/spaces
+- Your Workflow File: `.github/workflows/sync-to-huggingface.yml`
+
+---
+
+**That's it!** After the one-time setup, you'll never need to manually deploy again. Just code, commit, and push! 🎉

DEPLOYMENT_GUIDE.md

@@ -0,0 +1,84 @@
+# Deployment Guide: Syncing GitHub to Hugging Face Space
+
+## Quick Setup (Choose ONE method)
+
+### Method 1: Direct Push to Hugging Face (Recommended)
+
+1. **Get your Hugging Face Token:**
+   - Go to https://huggingface.co/settings/tokens
+   - Click "New token" → Create a **Write** token
+   - Copy the token
+
+2. **Login to Hugging Face CLI:**
+   ```bash
+   huggingface-cli login
+   ```
+   - Paste your token when prompted
+
+3. **Clone the Hugging Face Space repository:**
+   ```bash
+   cd d:\Documents\SFU\PHYS385_Quantum2\CodeProjects
+   git clone https://huggingface.co/spaces/AhiBucket/Hand-wave huggingface-hand-wave
+   ```
+
+4. **Copy files from GitHub repo to HF Space:**
+   ```bash
+   cd huggingface-hand-wave
+   Copy-Item -Path "..\Hand-wave\app.py" -Destination "." -Force
+   Copy-Item -Path "..\Hand-wave\functions.py" -Destination "." -Force
+   Copy-Item -Path "..\Hand-wave\requirements.txt" -Destination "." -Force
+   Copy-Item -Path "..\Hand-wave\README.md" -Destination "." -Force
+   ```
+
+5. **Commit and push to Hugging Face:**
+   ```bash
+   git add .
+   git commit -m "Update: Fixed Plotly compatibility for wavefunction display"
+   git push
+   ```
+
+---
+
+### Method 2: GitHub Integration (Via Web UI)
+
+1. **Go to your Space Settings:**
+   - Navigate to https://huggingface.co/spaces/AhiBucket/Hand-wave
+   - Click **"Settings"** (top right, near your profile)
+
+2. **Connect GitHub Repository:**
+   - Scroll to **"Repository"** section
+   - Click **"Connect to GitHub"**
+   - Select repository: `Ahilan-Bucket/Hand-wave`
+   - Choose branch: `main`
+   - Click **"Save"**
+
+3. **Enable Auto-sync:**
+   - Toggle **"Automatically rebuild on push"**
+   - This will sync your GitHub repo to HF Space automatically
+
+---
+
+## What's Been Done Already ✅
+
+1. ✅ Created new GitHub repository: `Hand-wave`
+2. ✅ Copied all necessary files from `psi_solve2`
+3. ✅ Fixed Plotly compatibility issues for Hugging Face
+4. ✅ Pushed code to GitHub: https://github.com/Ahilan-Bucket/Hand-wave
+
+## What's Next 🚀
+
+- Choose Method 1 or Method 2 above to sync to Hugging Face
+- Once synced, the wavefunctions should display correctly!
+- Test the deployment at: https://huggingface.co/spaces/AhiBucket/Hand-wave
+
+## Troubleshooting
+
+**If the app doesn't start:**
+- Check the build logs in the Hugging Face Space
+- Verify `requirements.txt` has all dependencies
+- Make sure `app.py` is in the root directory
+
+**If wavefunctions still don't show:**
+- The fixes we made should resolve this
+- Check browser console for JavaScript errors
+- Verify Plotly version compatibility

QUICK_DEPLOY.md

@@ -0,0 +1,69 @@
+# Quick Deployment to Hugging Face Space
+# This script helps you sync your code to Hugging Face
+
+## OPTION 1: Upload via Python Script (Easiest)
+
+1. Get your Hugging Face token:
+   - Go to: https://huggingface.co/settings/tokens
+   - Click "New token" → Create a WRITE token
+   - Copy the token
+
+2. Run the upload script:
+   ```bash
+   cd d:\Documents\SFU\PHYS385_Quantum2\CodeProjects\Hand-wave
+   python upload_to_hf.py
+   ```
+   
+3. Paste your token when prompted
+
+4. Done! Check your Space: https://huggingface.co/spaces/AhiBucket/Hand-wave
+
+---
+
+## OPTION 2: Clone HF Space and Push (Alternative)
+
+If Option 1 doesn't work, try this:
+
+```bash
+# 1. Clone the Hugging Face Space
+cd d:\Documents\SFU\PHYS385_Quantum2\CodeProjects
+git clone https://huggingface.co/spaces/AhiBucket/Hand-wave hf-hand-wave
+
+# 2. Copy files
+cd hf-hand-wave
+Copy-Item -Path "..\Hand-wave\app.py" -Destination "." -Force
+Copy-Item -Path "..\Hand-wave\functions.py" -Destination "." -Force  
+Copy-Item -Path "..\Hand-wave\requirements.txt" -Destination "." -Force
+Copy-Item -Path "..\Hand-wave\README.md" -Destination "." -Force
+
+# 3. Commit and push
+git add .
+git commit -m "Fix: Plotly compatibility for wavefunction display"
+git push
+```
+
+When prompted for credentials:
+- Username: Your Hugging Face username
+- Password: Your Hugging Face WRITE token (NOT your password!)
+
+---
+
+## Files Ready for Deployment ✅
+
+All files have been prepared in: `d:\Documents\SFU\PHYS385_Quantum2\CodeProjects\Hand-wave`
+
+- ✅ app.py (with Plotly fixes)
+- ✅ functions.py (physics engine)
+- ✅ requirements.txt (dependencies)
+- ✅ README.md (documentation)
+- ✅ .gitignore
+
+## What Was Fixed 🔧
+
+The main issue causing wavefunctions not to display on Hugging Face:
+
+1. **Array dimension validation** - Ensures x and y arrays match in length
+2. **Data type conversion** - Converts numpy arrays to lists for Plotly compatibility
+3. **Explicit array handling** - Uses x_internal explicitly instead of inline slicing
+
+These fixes ensure the app works on both local Streamlit and Hugging Face Spaces!

upload_to_hf.py

@@ -0,0 +1,75 @@
+"""
+Script to upload files to Hugging Face Space
+Run this after getting your HF token from: https://huggingface.co/settings/tokens
+"""
+
+from huggingface_hub import HfApi, login
+import os
+
+def upload_to_hf_space():
+    print("=" * 60)
+    print("Hugging Face Space Uploader")
+    print("=" * 60)
+    
+    # Get token from user
+    print("\n1. Get your token from: https://huggingface.co/settings/tokens")
+    print("   (Create a WRITE token if you don't have one)")
+    token = input("\n2. Paste your Hugging Face token here: ").strip()
+    
+    if not token:
+        print("❌ No token provided. Exiting.")
+        return
+    
+    try:
+        # Login
+        print("\n3. Logging in to Hugging Face...")
+        login(token=token)
+        print("✅ Login successful!")
+        
+        # Initialize API
+        api = HfApi()
+        
+        # Space details
+        repo_id = "AhiBucket/Hand-wave"
+        repo_type = "space"
+        
+        print(f"\n4. Uploading files to {repo_id}...")
+        
+        # Files to upload
+        files_to_upload = [
+            "app.py",
+            "functions.py",
+            "requirements.txt",
+            "README.md",
+            ".gitignore"
+        ]
+        
+        # Upload each file
+        for file in files_to_upload:
+            if os.path.exists(file):
+                print(f"   📤 Uploading {file}...")
+                api.upload_file(
+                    path_or_fileobj=file,
+                    path_in_repo=file,
+                    repo_id=repo_id,
+                    repo_type=repo_type,
+                )
+                print(f"   ✅ {file} uploaded!")
+            else:
+                print(f"   ⚠️  {file} not found, skipping...")
+        
+        print("\n" + "=" * 60)
+        print("🎉 SUCCESS! All files uploaded to Hugging Face Space!")
+        print("=" * 60)
+        print(f"\n🌐 View your Space at: https://huggingface.co/spaces/{repo_id}")
+        print("\n⏳ The Space will rebuild automatically (may take 1-2 minutes)")
+        
+    except Exception as e:
+        print(f"\n❌ Error: {e}")
+        print("\nTroubleshooting:")
+        print("- Make sure your token has WRITE permissions")
+        print("- Verify the Space exists: https://huggingface.co/spaces/AhiBucket/Hand-wave")
+        print("- Check your internet connection")
+
+if __name__ == "__main__":
+    upload_to_hf_space()