........

DEPLOYMENT.md

@@ -1,181 +0,0 @@
-# Hugging Face Spaces Deployment Guide
-
-## Prerequisites
-
-1. **Hugging Face Account**: Create an account at [huggingface.co](https://huggingface.co)
-2. **Git**: Ensure Git is installed on your system
-3. **Git LFS**: Install Git Large File Storage for handling large files
-
-## Step-by-Step Deployment
-
-### 1. Create a New Space
-
-1. Go to [Hugging Face Spaces](https://huggingface.co/spaces)
-2. Click "Create new Space"
-3. Fill in the details:
-   - **Space name**: `rainwater-harvesting-calculator` (or your preferred name)
-   - **License**: MIT
-   - **SDK**: Docker
-   - **Hardware**: CPU basic (free tier)
-   - **Visibility**: Public (or Private if you prefer)
-
-### 2. Clone the Repository
-
-```bash
-git clone https://huggingface.co/spaces/YOUR_USERNAME/rainwater-harvesting-calculator
-cd rainwater-harvesting-calculator
-```
-
-### 3. Copy Your Application Files
-
-Copy all the files from your current project to the cloned repository:
-
-```bash
-# Copy all files except .git directory
-cp -r /path/to/your/sihmicro/* ./
-```
-
-Files to include:
-- `app.py`
-- `RoofTopCalculation.py`
-- `RainFallModel.py`
-- `requirements.txt`
-- `Dockerfile`
-- `README.md`
-- `.gitignore`
-
-### 4. Commit and Push
-
-```bash
-git add .
-git commit -m "Initial deployment of Rainwater Harvesting Calculator"
-git push
-```
-
-### 5. Monitor Deployment
-
-1. Go to your Space page on Hugging Face
-2. Check the "Build logs" tab to monitor the deployment process
-3. Wait for the build to complete (usually 5-10 minutes)
-
-## Alternative: Direct Upload
-
-If you prefer not to use Git:
-
-1. Create the Space as described above
-2. Use the web interface to upload files:
-   - Click "Files" tab in your Space
-   - Drag and drop or upload each file
-   - Commit changes with a meaningful message
-
-## Configuration Details
-
-### README.md Front Matter
-The YAML front matter in README.md configures your Space:
-
-```yaml
----
-title: Rainwater Harvesting Calculator
-emoji: 💧
-colorFrom: blue
-colorTo: green
-sdk: docker
-pinned: false
-license: mit
-app_port: 7860
----
-```
-
-### Key Configuration Points
-
-- **SDK**: Set to `docker` (not `gradio` or `streamlit`)
-- **app_port**: Must be `7860` for Hugging Face Spaces
-- **Docker**: Uses your custom Dockerfile for deployment
-
-## Testing Your Deployment
-
-Once deployed, test your API endpoints:
-
-### Health Check
-```bash
-curl https://YOUR_USERNAME-rainwater-harvesting-calculator.hf.space/health
-```
-
-### API Test
-```bash
-curl -X POST https://YOUR_USERNAME-rainwater-harvesting-calculator.hf.space/api/roofTopCalculation \
-  -H "Content-Type: application/json" \
-  -d '{
-    "location": "Chennai",
-    "roof_area": 150,
-    "open_space": 100,
-    "roof_type": "concrete",
-    "dwellers": 4
-  }'
-```
-
-## Troubleshooting
-
-### Common Issues
-
-1. **Build Failure**: Check build logs for missing dependencies
-2. **Permission Errors**: Ensure cache directories have proper permissions
-3. **Port Issues**: Verify app runs on port 7860
-4. **Memory Issues**: Consider upgrading to CPU upgrade if needed
-
-### Debug Steps
-
-1. Check build logs in the Space interface
-2. Verify all required files are present
-3. Test locally with Docker before deploying
-4. Review requirements.txt for missing packages
-
-### Local Testing Before Deployment
-
-```bash
-# Build and test locally
-docker build -t rainwater-app .
-docker run -p 7860:7860 rainwater-app
-
-# Test the endpoints
-curl http://localhost:7860/health
-```
-
-## Optimization Tips
-
-1. **Dependencies**: Keep requirements.txt minimal
-2. **Caching**: Utilize Hugging Face Hub caching effectively
-3. **Error Handling**: Ensure robust fallback mechanisms
-4. **Logging**: Use appropriate logging levels for production
-
-## Monitoring and Maintenance
-
-1. **Usage Analytics**: Monitor via Hugging Face Space analytics
-2. **Error Logs**: Check application logs in the Space interface
-3. **Updates**: Use Git to push updates and trigger rebuilds
-4. **Performance**: Monitor response times and consider hardware upgrades
-
-## Security Considerations
-
-1. **API Keys**: Use Hugging Face Secrets for sensitive data
-2. **Input Validation**: Ensure proper input sanitization
-3. **Rate Limiting**: Consider implementing rate limiting for production use
-4. **HTTPS**: Hugging Face Spaces automatically provide HTTPS
-
-## Next Steps
-
-After successful deployment:
-
-1. Share your Space URL with users
-2. Add usage examples to your README
-3. Consider adding a simple web interface using FastAPI's automatic docs
-4. Monitor usage and optimize based on user feedback
-
-## Support
-
-- [Hugging Face Spaces Documentation](https://huggingface.co/docs/hub/spaces)
-- [Docker SDK Guide](https://huggingface.co/docs/hub/spaces-sdks-docker)
-- [Community Forum](https://discuss.huggingface.co/)
-
-Your Rainwater Harvesting Calculator will be available at:
-`https://YOUR_USERNAME-rainwater-harvesting-calculator.hf.space`

README.md

@@ -1,10 +1,15 @@
 ---
-
+title: Rainwater Harvesting Calculator
+colorFrom: blue
+colorTo: green
+sdk: docker
+app_file: app.py
+pinned: false
 license: mit
 app_port: 7860
 ---
 
-# Rainwater Harvesting Calculator 💧
+# Rainwater Harvesting Calculator
 
 A comprehensive API for calculating rainwater harvesting potential, structure recommendations, and cost analysis based on location, roof area, and other parameters.