# 🚀 Deployment Instructions for Hugging Face Spaces

## Quick Deployment

### Option 1: Use Simplified Version (Recommended)

1. **Create a new Hugging Face Space**:
   - Go to https://huggingface.co/new-space
   - Choose "Gradio" as the SDK
   - Set the space name: `scientific-idea-verifier`
   - Make it public or private as desired

2. **Upload the following files**:
   ```
   app.py                 (rename app_simple.py to app.py)
   requirements.txt       (use requirements_simple.txt)
   README.md
   ```

3. **File Contents**:
   - **app.py**: Use the content from `app_simple.py`
   - **requirements.txt**: Use the content from `requirements_simple.txt`
   - **README.md**: Use the existing README.md

4. **Configure Secrets** (Optional):
   - In your Space settings, add a secret named `OPENAI_API_KEY`
   - Set the value to: `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`

### Option 2: Full System Deployment (Advanced)

If you want to deploy the complete multi-agent system:

1. **Upload all files** from the project directory
2. **Use the full requirements.txt**
3. **Set app.py** to import from the full system
4. **Configure additional secrets** if needed

## File Structure for Deployment

```
scientific-idea-verifier/
├── app.py                 # Main application file
├── requirements.txt       # Dependencies
├── README.md             # Documentation
└── .gitignore           # Git ignore file
```

## Environment Variables / Secrets

### Required Secrets:
- `OPENAI_API_KEY`: Your OpenAI API key for LLM functionality

### Optional Secrets:
- `HUGGINGFACE_TOKEN`: For enhanced features (already configured)

## Testing the Deployment

1. **Local Testing**:
   ```bash
   cd scientific_idea_verifier
   pip install -r requirements_simple.txt
   python app_simple.py
   ```

2. **Access the interface** at `http://localhost:7860`

3. **Test with sample idea**:
   - Enter a research idea
   - Provide your OpenAI API key
   - Click "Verify Research Idea"

## Features Available in Deployed Version

### ✅ Core Features:
- Research idea input and analysis
- OpenAlex integration for literature search
- Novelty scoring based on similar works
- AI-powered detailed analysis and recommendations
- Interactive metrics visualization
- Multiple OpenAI model support (GPT-3.5, GPT-4o, GPT-4o-mini)

### ✅ User Interface:
- Clean, professional Gradio interface
- Real-time progress updates
- Tabbed results display
- Responsive design for mobile and desktop

### ✅ Security:
- API key input protection (password field)
- No data storage or logging
- Client-side processing

## Limitations of Simplified Version

- Single-agent analysis (vs. multi-agent in full version)
- Simplified novelty detection algorithm
- Basic keyword extraction
- No advanced caching or rate limiting

## Troubleshooting

### Common Issues:

1. **"Invalid API key" error**:
   - Ensure your OpenAI API key is correct
   - Check that you have sufficient credits

2. **"No similar works found"**:
   - This is normal for very novel ideas
   - OpenAlex may not have coverage in all fields

3. **Slow response times**:
   - Depends on OpenAI API response time
   - GPT-4o may be slower than GPT-3.5-turbo

### Performance Optimization:

1. **Use GPT-3.5-turbo** for faster responses
2. **Keep research ideas concise** (under 500 words)
3. **Avoid special characters** in research ideas

## Support and Updates

- **Documentation**: See README.md for detailed usage instructions
- **Issues**: Report bugs or feature requests in the Space discussions
- **Updates**: The system will be updated periodically with new features

## API Usage Costs

The system uses OpenAI's API, which has usage-based pricing:
- **GPT-3.5-turbo**: ~$0.002 per verification
- **GPT-4o**: ~$0.01-0.03 per verification
- **GPT-4o-mini**: ~$0.001 per verification

Users provide their own API keys, so costs are borne by the user.

---

## Quick Start Commands

```bash
# Clone or download the files
# Upload to Hugging Face Spaces
# Or run locally:

pip install gradio openai requests plotly
python app_simple.py
```

🎉 **Your Scientific Idea Verification System is now ready for deployment!**