Skip to content

README_STREAMLIT.md

Latest commit

 

History

History
133 lines (99 loc) · 3.86 KB

README_STREAMLIT.md

File metadata and controls

133 lines (99 loc) · 3.86 KB

QuantumMeter Pro - Streamlit Cloud Deployment

🚀 Quick Deploy to Streamlit Cloud

This version of QuantumMeter Pro is specifically designed to work on Streamlit Cloud and other cloud platforms.

📋 Prerequisites

🛠️ Deployment Steps

Option 1: Full Version (with Plotly)

  1. Fork this repository to your GitHub account

  2. Go to Streamlit Cloud and sign in with your GitHub account

  3. Click "New app"

  4. Configure your app:

    • Repository: Select your forked repository
    • Branch: main
    • Main file path: streamlit_app.py
    • Requirements file: requirements-streamlit.txt
    • App URL: Choose your preferred URL

  5. Click "Deploy"

Option 2: Simplified Version (Maximum Compatibility)

  1. Fork this repository to your GitHub account

  2. Go to Streamlit Cloud and sign in with your GitHub account

  3. Click "New app"

  4. Configure your app:

    • Repository: Select your forked repository
    • Branch: main
    • Main file path: streamlit_app_simple.py
    • Requirements file: requirements-streamlit-minimal.txt
    • App URL: Choose your preferred URL

  5. Click "Deploy"

💡 Recommendation: Use Option 2 (Simplified Version) for maximum compatibility and reliability.

📁 Required Files

Make sure these files are in your repository:

quantum-meter-pro/
├── streamlit_app.py                    # Full Streamlit application (with Plotly)
├── streamlit_app_simple.py             # Simplified Streamlit application (recommended)
├── requirements-streamlit.txt          # Full dependencies
├── requirements-streamlit-minimal.txt  # Minimal dependencies (recommended)
├── .streamlit/
│   └── config.toml                    # Streamlit configuration
└── data/
    └── sample_quantum_data.csv        # Sample data

🔧 Configuration

The .streamlit/config.toml file contains optimized settings for cloud deployment:

[global]
developmentMode = false

[server]
headless = true
enableCORS = false
enableXsrfProtection = false

[browser]
gatherUsageStats = false

[theme]
primaryColor = "#1f77b4"
backgroundColor = "#ffffff"
secondaryBackgroundColor = "#f0f2f6"
textColor = "#262730"

📊 Features Available in Streamlit Version

Full Version (with Plotly)

  • ✅ Real-time Measurement Display
  • ✅ Interactive Charts (Current, Voltage, Resistance, Temperature)
  • ✅ AI Analysis Module
  • ✅ Data Import/Export
  • ✅ Device Control Simulation
  • ✅ Responsive Design

Simplified Version (Recommended)

  • ✅ Real-time Measurement Display
  • ✅ Built-in Streamlit Charts (Current, Voltage, Resistance, Temperature)
  • ✅ AI Analysis Module
  • ✅ Data Import/Export
  • ✅ Device Control Simulation
  • ✅ Responsive Design
  • ✅ Maximum Compatibility
  • ✅ No External Dependencies

🌐 Access Your App

Once deployed, your app will be available at:

https://your-app-name-your-username.streamlit.app

🔄 Updates

To update your deployed app:

  1. Make changes to your local repository
  2. Push changes to GitHub
  3. Streamlit Cloud will automatically redeploy

🐛 Troubleshooting

Common Issues:

  1. Import Errors: Make sure all dependencies are in requirements-streamlit.txt
  2. File Not Found: Ensure data/sample_quantum_data.csv exists
  3. Memory Issues: The app is optimized for cloud deployment with limited resources

Support:

Made with ❤️ for the scientific community

QuantumMeter Pro - Advancing Quantum Measurement Technology