thisisdev commited on
Commit
1423b8e
·
verified ·
1 Parent(s): ae88496

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +81 -0
README.md CHANGED
@@ -12,3 +12,84 @@ short_description: ' Air quality monitoring and health recommendation tool power
12
  ---
13
 
14
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
12
  ---
13
 
14
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
15
+ # AQI Tracking and Analysis Agent
16
+
17
+ The AQI Analysis Agent is a powerful air quality monitoring and health recommendation tool powered by Firecrawl and Agno's AI Agent framework. This app helps users make informed decisions about outdoor activities by analyzing real-time air quality data and providing personalized health recommendations.
18
+
19
+ ## Features
20
+
21
+ - **Multi-Agent System**
22
+ - **AQI Analyzer**: Fetches and processes real-time air quality data
23
+ - **Health Recommendation Agent**: Generates personalized health advice
24
+
25
+ - **Air Quality Metrics**:
26
+ - Overall Air Quality Index (AQI)
27
+ - Particulate Matter (PM2.5 and PM10)
28
+ - Carbon Monoxide (CO) levels
29
+ - Temperature
30
+ - Humidity
31
+ - Wind Speed
32
+
33
+ - **Comprehensive Analysis**:
34
+ - Real-time data visualization
35
+ - Health impact assessment
36
+ - Activity safety recommendations
37
+ - Best time suggestions for outdoor activities
38
+ - Weather condition correlations
39
+
40
+ - **Interactive Features**:
41
+ - Location-based analysis
42
+ - Medical condition considerations
43
+ - Activity-specific recommendations
44
+ - Downloadable reports
45
+ - Example queries for quick testing
46
+
47
+ ## How to Run
48
+
49
+ Follow these steps to set up and run the application:
50
+
51
+ 1. **Clone the Repository**:
52
+ ```bash
53
+ cd AQI_Tracking
54
+ ```
55
+
56
+ 2. **Install the dependencies**:
57
+ ```bash
58
+ pip install -r requirements.txt
59
+ ```
60
+
61
+ 3. **Set up your API keys**:
62
+ - Get an OpenAI API key from: https://platform.openai.com/api-keys
63
+ - Get a Firecrawl API key from: [Firecrawl website](https://www.firecrawl.dev/app/api-keys)
64
+
65
+ 4. **Run the Gradio app**:
66
+ ```bash
67
+ python ai_aqi_analysis_agent.py
68
+ ```
69
+
70
+ 5. **Access the Web Interface**:
71
+ - The terminal will display two URLs:
72
+ - Local URL: `http://127.0.0.1:7860` (for local access)
73
+ - Public URL: `https://xxx-xxx-xxx.gradio.live` (for temporary public access)
74
+ - Click on either URL to open the web interface in your browser
75
+
76
+ ## Usage
77
+
78
+ 1. Enter your API keys in the API Configuration section
79
+ 2. Input location details:
80
+ - City name
81
+ - State (optional for Union Territories/US cities)
82
+ - Country
83
+ 3. Provide personal information:
84
+ - Medical conditions (optional)
85
+ - Planned outdoor activity
86
+ 4. Click "Analyze & Get Recommendations" to receive:
87
+ - Current air quality data
88
+ - Health impact analysis
89
+ - Activity safety recommendations
90
+ 5. Try the example queries for quick testing
91
+
92
+ ## Note
93
+
94
+ The air quality data is fetched using Firecrawl's web scraping capabilities. Due to caching and rate limiting, the data might not always match real-time values on the website. For the most accurate real-time data, consider checking the source website directly.
95
+