Finalized project cleanup before submission

docs/build/doctrees/environment.pickle

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:2bf54afe7c1051ad4d44786eac436159139c23a29404db25994644da281786d6
-size 24356
+oid sha256:c2e48924ab312ea07e3b0d3dc5fc11c6fdd3db3137657febea0d6247630ad7b8
+size 28261

docs/build/html/_sources/index.rst.txt

@@ -15,6 +15,7 @@ Welcome to Solar AI Assistant's Docs!
    api_reference
    contributing
    modules
+   use_cases
 ======================================
 About Solar AI Assistant
 ======================================
@@ -26,3 +27,16 @@ It allows users to ask questions and get responses based on advanced AI models.
 - Interactive UI using Streamlit
 - Integration with OpenRouter API
 - Simple and easy-to-use interface
+
+
+
+Future Improvements
+====================
+
+While the Solar AI Assistant is functional, there are several potential improvements:
+
+- **Enhanced Context Management**: Improve multi-turn conversations to remember past user queries.
+- **Solar Panel Recommendations**: Suggest solar panels based on location and budget.
+- **Live Energy Savings Calculator**: Estimate electricity savings dynamically.
+- **Multilingual Support**: Expand language options beyond English.
+- **Mobile App Integration**: Develop a mobile-friendly interface.

docs/build/html/_sources/use_cases.rst.txt

@@ -0,0 +1,114 @@
+======================
+Example Use Cases
+======================
+
+This section provides real-world examples of how users interact with the **Solar AI Assistant**.
+
+🏠 **Use Case 1: Homeowner Interested in Solar Energy**
+--------------------------------------------------------
+
+🧑 **User:**  
+*"How much do solar panels cost for a house?"*  
+
+🤖 **AI:**  
+*"The cost of solar panels for a house depends on several factors, including system size, location, and available incentives. On average:*  
+• A 5kW solar system costs ₹2,00,000 - ₹3,50,000 in India before incentives.  
+• Government subsidies can reduce costs by 30-40% under certain programs.  
+• The payback period is usually 5-7 years based on electricity savings."*  
+
+🧑 **User:**  
+*"How much will I save on electricity bills?"*  
+
+🤖 **AI:**  
+*"Solar savings depend on:*  
+✅ Sunlight availability in your location.  
+✅ Electricity consumption (higher bills = more savings).  
+✅ Net metering (selling extra power back to the grid).  
+
+💡 **Example Calculation:**  
+• Before Solar: ₹3,000/month electricity bill.  
+• After Solar: ₹500/month (80% savings).  
+• **Annual Savings:** ₹30,000 (₹3,000 x 12 months).  
+• **10-year Savings:** ₹3,00,000! 🎉"*  
+
+---
+
+🏢 **Use Case 2: Business Owner Exploring Commercial Solar**
+------------------------------------------------------------
+
+🧑 **User:**  
+*"Is solar energy a good investment for my business?"*  
+
+🤖 **AI:**  
+*"Yes! Here’s why commercial solar is a smart investment:*  
+🔹 Lower electricity costs: Save up to 50-80% on power bills.  
+🔹 Tax benefits: Businesses can claim depreciation & subsidies.  
+🔹 ROI in 3-5 years: With net metering, extra energy earns credits.  
+🔹 Sustainability: Green branding improves reputation & compliance."*  
+
+🧑 **User:**  
+*"What incentives are available for businesses?"*  
+
+🤖 **AI:**  
+*"Indian businesses can benefit from:*  
+💰 Accelerated Depreciation: 40% depreciation in the first year.  
+⚡ Net Metering: Sell excess power to the grid.  
+🏢 Government Subsidies: Up to 30% for some industries.  
+📜 State Incentives: Vary by region (Delhi, Maharashtra, etc.)."*  
+
+---
+
+🎓 **Use Case 3: Student Learning About Solar Energy**
+------------------------------------------------------
+
+🧑 **User:**  
+*"How do solar panels generate electricity?"*  
+
+🤖 **AI:**  
+*"Solar panels generate electricity using the **photovoltaic effect**.*  
+🔹 Step 1: Sunlight hits solar cells (made of silicon).  
+🔹 Step 2: Photons excite electrons, creating an electric flow.  
+🔹 Step 3: The inverter converts DC power to AC for home use.  
+🔹 Step 4: Power is used or sent to the grid for credits."*  
+
+🧑 **User:**  
+*"What is the efficiency of monocrystalline vs. polycrystalline panels?"*  
+
+🤖 **AI:**  
+*"🔹 **Monocrystalline Panels:**  
+• **Efficiency:** 15-22% (higher efficiency).  
+• **Cost:** More expensive but better performance.  
+• **Lifespan:** 25+ years.  
+
+🔹 **Polycrystalline Panels:**  
+• **Efficiency:** 12-18% (slightly lower).  
+• **Cost:** More affordable.  
+• **Lifespan:** 20-25 years.  
+
+💡 **Monocrystalline =** Best for limited space, maximum efficiency.  
+💡 **Polycrystalline =** Best for budget-friendly installations."*  
+
+---
+
+🌍 **Use Case 4: Environmentalist Curious About Solar's Impact**
+----------------------------------------------------------------
+
+🧑 **User:**  
+*"How does solar energy help the environment?"*  
+
+🤖 **AI:**  
+*"Solar energy helps the environment by:*  
+✅ **Reducing Carbon Footprint** – Solar energy reduces CO₂ emissions by replacing fossil fuels.  
+✅ **Saving Water** – Unlike coal power plants, solar energy does not require water cooling.  
+✅ **Preventing Air Pollution** – No harmful emissions like SO₂, NOₓ, or particulate matter.  
+✅ **Reducing Land Degradation** – Solar farms do not involve mining, unlike coal and gas."*  
+
+🧑 **User:**  
+*"Can solar panels be recycled?"*  
+
+🤖 **AI:**  
+*"Yes! Solar panels can be recycled to recover materials like:*  
+♻️ **Silicon** (95%)  
+♻️ **Glass** (90%)  
+♻️ **Aluminum** (100%)  
+🔹 Recycling plants in India & worldwide help manage end-of-life solar waste."*  

docs/build/html/app.html

@@ -44,11 +44,17 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation Guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage Guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="api_reference.html">API Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 <li class="toctree-l1 current"><a class="reference internal" href="modules.html">solar-ai-assistant1</a><ul class="current">
 <li class="toctree-l2 current"><a class="current reference internal" href="#">app module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="test_openrouter.html">test_openrouter module</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="use_cases.html">Example Use Cases</a></li>
 </ul>
 
         </div>

docs/build/html/genindex.html

@@ -47,6 +47,7 @@
 <li class="toctree-l1"><a class="reference internal" href="api_reference.html">API Reference</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="modules.html">solar-ai-assistant1</a></li>
+<li class="toctree-l1"><a class="reference internal" href="use_cases.html">Example Use Cases</a></li>
 </ul>
 
         </div>

docs/build/html/index.html

@@ -49,6 +49,7 @@
 <li class="toctree-l1"><a class="reference internal" href="api_reference.html">API Reference</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="modules.html">solar-ai-assistant1</a></li>
+<li class="toctree-l1"><a class="reference internal" href="use_cases.html">Example Use Cases</a></li>
 </ul>
 
         </div>
@@ -96,6 +97,13 @@
 <li class="toctree-l2"><a class="reference internal" href="test_openrouter.html">test_openrouter module</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="use_cases.html">Example Use Cases</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="use_cases.html#use-case-1-homeowner-interested-in-solar-energy">🏠 <strong>Use Case 1: Homeowner Interested in Solar Energy</strong></a></li>
+<li class="toctree-l2"><a class="reference internal" href="use_cases.html#use-case-2-business-owner-exploring-commercial-solar">🏢 <strong>Use Case 2: Business Owner Exploring Commercial Solar</strong></a></li>
+<li class="toctree-l2"><a class="reference internal" href="use_cases.html#use-case-3-student-learning-about-solar-energy">🎓 <strong>Use Case 3: Student Learning About Solar Energy</strong></a></li>
+<li class="toctree-l2"><a class="reference internal" href="use_cases.html#use-case-4-environmentalist-curious-about-solar-s-impact">🌍 <strong>Use Case 4: Environmentalist Curious About Solar’s Impact</strong></a></li>
+</ul>
+</li>
 </ul>
 </div>
 </section>
@@ -108,6 +116,17 @@ It allows users to ask questions and get responses based on advanced AI models.<
 - Interactive UI using Streamlit
 - Integration with OpenRouter API
 - Simple and easy-to-use interface</p>
+<section id="future-improvements">
+<h2>Future Improvements<a class="headerlink" href="#future-improvements" title="Link to this heading"></a></h2>
+<p>While the Solar AI Assistant is functional, there are several potential improvements:</p>
+<ul class="simple">
+<li><p><strong>Enhanced Context Management</strong>: Improve multi-turn conversations to remember past user queries.</p></li>
+<li><p><strong>Solar Panel Recommendations</strong>: Suggest solar panels based on location and budget.</p></li>
+<li><p><strong>Live Energy Savings Calculator</strong>: Estimate electricity savings dynamically.</p></li>
+<li><p><strong>Multilingual Support</strong>: Expand language options beyond English.</p></li>
+<li><p><strong>Mobile App Integration</strong>: Develop a mobile-friendly interface.</p></li>
+</ul>
+</section>
 </section>
 
 

docs/build/html/modules.html

@@ -20,7 +20,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="app module" href="app.html" />
-    <link rel="prev" title="Welcome to Solar AI Assistant’s Documentation!" href="index.html" /> 
+    <link rel="prev" title="Contributing" href="contributing.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -44,11 +44,17 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation Guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage Guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="api_reference.html">API Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">solar-ai-assistant1</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="app.html">app module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="test_openrouter.html">test_openrouter module</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="use_cases.html">Example Use Cases</a></li>
 </ul>
 
         </div>
@@ -89,7 +95,7 @@
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="index.html" class="btn btn-neutral float-left" title="Welcome to Solar AI Assistant’s Documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="contributing.html" class="btn btn-neutral float-left" title="Contributing" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="app.html" class="btn btn-neutral float-right" title="app module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 

docs/build/html/py-modindex.html

@@ -54,6 +54,7 @@
 <li class="toctree-l1"><a class="reference internal" href="api_reference.html">API Reference</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="modules.html">solar-ai-assistant1</a></li>
+<li class="toctree-l1"><a class="reference internal" href="use_cases.html">Example Use Cases</a></li>
 </ul>
 
         </div>

docs/build/html/search.html

@@ -50,6 +50,7 @@
 <li class="toctree-l1"><a class="reference internal" href="api_reference.html">API Reference</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="modules.html">solar-ai-assistant1</a></li>
+<li class="toctree-l1"><a class="reference internal" href="use_cases.html">Example Use Cases</a></li>
 </ul>
 
         </div>

docs/build/html/searchindex.js

@@ -1 +1 @@
-Search.setIndex({"alltitles":{"API Reference":[[0,null]],"About Solar AI Assistant":[[3,"about-solar-ai-assistant"]],"Contents:":[[3,null]],"Contributing":[[2,null]],"Fork the Repository":[[2,"fork-the-repository"]],"How to Contribute":[[2,"how-to-contribute"]],"Installation Guide":[[4,null]],"Introduction":[[5,null]],"Usage Guide":[[8,null]],"Welcome to Solar AI Assistant\u2019s Docs!":[[3,null]],"app module":[[1,null]],"solar-ai-assistant1":[[6,null]],"test_openrouter module":[[7,null]],"\ud83d\udccc Base URL":[[0,"base-url"]]},"docnames":["api_reference","app","contributing","index","installation","introduction","modules","test_openrouter","usage"],"envversion":{"sphinx":65,"sphinx.domains.c":3,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":9,"sphinx.domains.index":1,"sphinx.domains.javascript":3,"sphinx.domains.math":2,"sphinx.domains.python":4,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.todo":2,"sphinx.ext.viewcode":1},"filenames":["api_reference.rst","app.rst","contributing.rst","index.rst","installation.rst","introduction.rst","modules.rst","test_openrouter.rst","usage.rst"],"indexentries":{},"objects":{"":[[1,0,0,"-","app"],[7,0,0,"-","test_openrouter"]]},"objnames":{"0":["py","module","Python module"]},"objtypes":{"0":"py:module"},"terms":{"1":[],"10":4,"3":4,"It":[3,5],"The":0,"To":8,"ad":2,"advanc":3,"ai":[0,2,4,5,8],"allow":3,"an":5,"answer":[3,5],"api":[3,5],"app":[3,6,8],"applic":8,"appreci":2,"ar":2,"ask":3,"assist":[0,2,5,8],"assistant1":[2,3,4],"backend":5,"base":3,"bug":2,"built":[0,5],"button":2,"can":5,"cd":[2,4],"chat":5,"chatbot":5,"click":2,"clone":[2,4],"co":[2,4],"code":4,"command":4,"contribut":3,"control":4,"cover":[],"customiz":5,"describ":0,"design":3,"detail":[],"develop":[],"document":[2,5],"easi":3,"endpoint":0,"energi":[3,5],"ensur":4,"error":0,"explain":8,"explor":5,"face":[0,2],"fast":5,"fastapi":[0,5],"featur":[2,3,5],"fix":2,"folder":8,"follow":[2,4],"fork":[],"format":0,"friendli":5,"frontend":5,"gener":5,"get":3,"git":[2,4],"guid":3,"handl":0,"have":4,"host":0,"how":[3,8],"http":[2,4],"hug":[0,2],"huggingfac":[2,4],"i":[0,3,5],"improv":2,"index":[],"industri":5,"insight":[3,5],"instal":3,"integr":3,"interact":[3,5],"interest":5,"interfac":[3,5],"introduct":3,"its":[],"kei":5,"lightweight":5,"manag":4,"model":3,"modul":[3,6],"navig":8,"need":5,"new":2,"open":5,"openrout":[0,3,5],"packag":4,"page":[],"pip":4,"power":[3,5],"powershel":4,"prerequisit":4,"process":5,"profession":5,"project":8,"provid":[3,5],"py":8,"python":4,"queri":3,"question":3,"quick":5,"re":2,"refer":3,"repositori":4,"request":0,"research":5,"respons":[3,5],"run":[4,8],"search":[],"section":0,"setup":[],"sh":8,"sidd0316":4,"simpl":3,"solar":[0,2,4,5,8],"sourc":5,"space":[0,2,4],"start":8,"step":2,"streamlit":[3,5,8],"student":5,"termin":4,"test_openrout":[3,6],"thi":[0,8],"tool":3,"ui":[3,5],"url":3,"us":[0,3,5,8],"usag":3,"user":[3,5],"v":4,"version":4,"we":2,"welcom":[2,5],"what":5,"whether":2,"who":5,"you":[2,4],"your":[2,4,8],"your_usernam":2},"titles":["API Reference","app module","Contributing","Welcome to Solar AI Assistant\u2019s Docs!","Installation Guide","Introduction","solar-ai-assistant1","test_openrouter module","Usage Guide"],"titleterms":{"":3,"about":3,"ai":[3,6],"api":0,"app":1,"assist":3,"assistant1":6,"base":0,"content":3,"contribut":2,"doc":3,"document":[],"fork":2,"guid":[4,8],"how":2,"indic":[],"instal":4,"introduct":5,"modul":[1,7],"refer":0,"repositori":2,"solar":[3,6],"tabl":[],"test_openrout":7,"url":0,"usag":8,"welcom":3}})
+Search.setIndex({"alltitles":{"API Reference":[[0,null]],"About Solar AI Assistant":[[3,"about-solar-ai-assistant"]],"Contents:":[[3,null]],"Contributing":[[2,null]],"Example Use Cases":[[9,null]],"Fork the Repository":[[2,"fork-the-repository"]],"Future Improvements":[[3,"future-improvements"]],"How to Contribute":[[2,"how-to-contribute"]],"Installation Guide":[[4,null]],"Introduction":[[5,null]],"Usage Guide":[[8,null]],"Welcome to Solar AI Assistant\u2019s Docs!":[[3,null]],"app module":[[1,null]],"solar-ai-assistant1":[[6,null]],"test_openrouter module":[[7,null]],"\ud83c\udf0d Use Case 4: Environmentalist Curious About Solar\u2019s Impact":[[9,"use-case-4-environmentalist-curious-about-solar-s-impact"]],"\ud83c\udf93 Use Case 3: Student Learning About Solar Energy":[[9,"use-case-3-student-learning-about-solar-energy"]],"\ud83c\udfe0 Use Case 1: Homeowner Interested in Solar Energy":[[9,"use-case-1-homeowner-interested-in-solar-energy"]],"\ud83c\udfe2 Use Case 2: Business Owner Exploring Commercial Solar":[[9,"use-case-2-business-owner-exploring-commercial-solar"]],"\ud83d\udccc Base URL":[[0,"base-url"]]},"docnames":["api_reference","app","contributing","index","installation","introduction","modules","test_openrouter","usage","use_cases"],"envversion":{"sphinx":65,"sphinx.domains.c":3,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":9,"sphinx.domains.index":1,"sphinx.domains.javascript":3,"sphinx.domains.math":2,"sphinx.domains.python":4,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.todo":2,"sphinx.ext.viewcode":1},"filenames":["api_reference.rst","app.rst","contributing.rst","index.rst","installation.rst","introduction.rst","modules.rst","test_openrouter.rst","usage.rst","use_cases.rst"],"indexentries":{},"objects":{"":[[1,0,0,"-","app"],[7,0,0,"-","test_openrouter"]]},"objnames":{"0":["py","module","Python module"]},"objtypes":{"0":"py:module"},"terms":{"00":9,"000":9,"1":3,"10":[4,9],"100":9,"12":9,"15":9,"18":9,"2":3,"20":9,"22":9,"25":9,"3":[3,4],"30":9,"4":3,"40":9,"5":9,"50":9,"500":9,"5kw":9,"7":9,"80":9,"90":9,"95":9,"A":9,"It":[3,5],"No":9,"On":9,"The":[0,9],"To":8,"With":9,"ac":9,"acceler":9,"ad":2,"advanc":3,"afford":9,"after":9,"ai":[0,2,4,5,8,9],"air":9,"allow":3,"aluminum":9,"an":[5,9],"annual":9,"answer":[3,5],"api":[3,5],"app":[3,6,8],"applic":8,"appreci":2,"ar":[2,3,9],"ask":3,"assist":[0,2,5,8,9],"assistant1":[2,3,4],"avail":9,"averag":9,"back":9,"backend":5,"base":[3,9],"befor":9,"benefit":9,"best":9,"better":9,"beyond":3,"bill":9,"brand":9,"budget":[3,9],"bug":2,"built":[0,5],"busi":3,"button":2,"calcul":[3,9],"can":[5,9],"carbon":9,"case":3,"cd":[2,4],"cell":9,"certain":9,"chat":5,"chatbot":5,"claim":9,"click":2,"clone":[2,4],"co":[2,4],"coal":9,"code":4,"command":4,"commerci":3,"complianc":9,"consumpt":9,"context":3,"contribut":3,"control":4,"convers":3,"convert":9,"cool":9,"cost":9,"cover":[],"co\u2082":9,"creat":9,"credit":9,"curiou":3,"customiz":5,"dc":9,"degrad":9,"delhi":9,"depend":9,"depreci":9,"describ":0,"design":3,"detail":[],"develop":3,"do":9,"document":[2,5],"doe":9,"dynam":3,"earn":9,"easi":3,"effect":9,"effici":9,"electr":[3,9],"electron":9,"emiss":9,"end":9,"endpoint":0,"energi":[3,5],"english":3,"enhanc":3,"ensur":4,"environ":9,"environmentalist":3,"error":0,"estim":3,"etc":9,"exampl":3,"excess":9,"excit":9,"expand":3,"expens":9,"explain":8,"explor":[3,5],"extra":9,"face":[0,2],"factor":9,"farm":9,"fast":5,"fastapi":[0,5],"featur":[2,3,5],"first":9,"fix":2,"flow":9,"folder":8,"follow":[2,4],"footprint":9,"fork":[],"format":0,"fossil":9,"friendli":[3,5,9],"from":9,"frontend":5,"fuel":9,"function":3,"ga":9,"gener":[5,9],"get":3,"git":[2,4],"glass":9,"good":9,"govern":9,"green":9,"grid":9,"guid":3,"handl":0,"harm":9,"have":4,"help":9,"here":9,"higher":9,"hit":9,"home":9,"homeown":3,"host":0,"hous":9,"how":[3,8,9],"http":[2,4],"hug":[0,2],"huggingfac":[2,4],"i":[0,3,5,9],"impact":3,"improv":[2,9],"incent":9,"includ":9,"index":[],"india":9,"indian":9,"industri":[5,9],"insight":[3,5],"instal":[3,9],"integr":3,"interact":[3,5,9],"interest":[3,5],"interfac":[3,5],"introduct":3,"invert":9,"invest":9,"involv":9,"its":[],"kei":5,"land":9,"languag":3,"learn":3,"life":9,"lifespan":9,"lightweight":5,"like":9,"limit":9,"live":3,"locat":[3,9],"lower":9,"made":9,"maharashtra":9,"manag":[3,4,9],"materi":9,"matter":9,"maximum":9,"meter":9,"mine":9,"mobil":3,"model":3,"modul":[3,6],"monocrystallin":9,"month":9,"more":9,"much":9,"multi":3,"multilingu":3,"my":9,"navig":8,"need":5,"net":9,"new":2,"no\u2093":9,"open":5,"openrout":[0,3,5],"option":3,"owner":3,"packag":4,"page":[],"panel":[3,9],"particul":9,"past":3,"payback":9,"perform":9,"period":9,"photon":9,"photovolta":9,"pip":4,"plant":9,"pollut":9,"polycrystallin":9,"potenti":3,"power":[3,5,9],"powershel":4,"prerequisit":4,"prevent":9,"process":5,"profession":5,"program":9,"project":8,"provid":[3,5,9],"py":8,"python":4,"queri":3,"question":3,"quick":5,"re":2,"real":9,"recommend":3,"recov":9,"recycl":9,"reduc":9,"refer":3,"region":9,"rememb":3,"replac":9,"repositori":4,"reput":9,"request":0,"requir":9,"research":5,"respons":[3,5],"roi":9,"run":[4,8],"save":[3,9],"search":[],"section":[0,9],"sell":9,"sent":9,"setup":[],"sever":[3,9],"sh":8,"sidd0316":4,"silicon":9,"simpl":3,"size":9,"slightli":9,"smart":9,"solar":[0,2,4,5,8],"some":9,"sourc":5,"so\u2082":9,"space":[0,2,4,9],"start":8,"state":9,"step":[2,9],"streamlit":[3,5,8],"student":[3,5],"subsidi":9,"suggest":3,"sunlight":9,"support":3,"sustain":9,"system":9,"tax":9,"termin":4,"test_openrout":[3,6],"thi":[0,8,9],"tool":3,"turn":3,"ui":[3,5],"under":9,"unlik":9,"up":9,"url":3,"us":[0,3,5,8],"usag":3,"user":[3,5,9],"usual":9,"v":[4,9],"vari":9,"version":4,"wast":9,"water":9,"we":2,"welcom":[2,5],"what":[5,9],"whether":2,"while":3,"who":5,"why":9,"world":9,"worldwid":9,"x":9,"ye":9,"year":9,"you":[2,4],"your":[2,4,8,9],"your_usernam":2},"titles":["API Reference","app module","Contributing","Welcome to Solar AI Assistant\u2019s Docs!","Installation Guide","Introduction","solar-ai-assistant1","test_openrouter module","Usage Guide","Example Use Cases"],"titleterms":{"":[3,9],"1":9,"2":9,"3":9,"4":9,"about":[3,9],"ai":[3,6],"api":0,"app":1,"assist":3,"assistant1":6,"base":0,"busi":9,"case":9,"commerci":9,"content":3,"contribut":2,"curiou":9,"doc":3,"document":[],"energi":9,"environmentalist":9,"exampl":9,"explor":9,"fork":2,"futur":3,"guid":[4,8],"homeown":9,"how":2,"impact":9,"improv":3,"indic":[],"instal":4,"interest":9,"introduct":5,"learn":9,"modul":[1,7],"owner":9,"refer":0,"repositori":2,"solar":[3,6,9],"student":9,"tabl":[],"test_openrout":7,"url":0,"us":9,"usag":8,"welcom":3}})

docs/build/html/use_cases.html

@@ -0,0 +1,207 @@
+
+
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="./">
+<head>
+  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Example Use Cases &mdash; Solar AI Assistant 1.0.0 documentation</title>
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
+
+  
+      <script src="_static/jquery.js?v=5d32c60e"></script>
+      <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+      <script src="_static/documentation_options.js?v=8d563738"></script>
+      <script src="_static/doctools.js?v=9bcbadda"></script>
+      <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="prev" title="test_openrouter module" href="test_openrouter.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+          
+          
+          <a href="index.html" class="icon icon-home">
+            Solar AI Assistant
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation Guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage Guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="api_reference.html">API Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="modules.html">solar-ai-assistant1</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Example Use Cases</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#use-case-1-homeowner-interested-in-solar-energy">🏠 <strong>Use Case 1: Homeowner Interested in Solar Energy</strong></a></li>
+<li class="toctree-l2"><a class="reference internal" href="#use-case-2-business-owner-exploring-commercial-solar">🏢 <strong>Use Case 2: Business Owner Exploring Commercial Solar</strong></a></li>
+<li class="toctree-l2"><a class="reference internal" href="#use-case-3-student-learning-about-solar-energy">🎓 <strong>Use Case 3: Student Learning About Solar Energy</strong></a></li>
+<li class="toctree-l2"><a class="reference internal" href="#use-case-4-environmentalist-curious-about-solar-s-impact">🌍 <strong>Use Case 4: Environmentalist Curious About Solar’s Impact</strong></a></li>
+</ul>
+</li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="index.html">Solar AI Assistant</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">Example Use Cases</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="_sources/use_cases.rst.txt" rel="nofollow"> View page source</a>
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+             
+  <section id="example-use-cases">
+<h1>Example Use Cases<a class="headerlink" href="#example-use-cases" title="Link to this heading"></a></h1>
+<p>This section provides real-world examples of how users interact with the <strong>Solar AI Assistant</strong>.</p>
+<section id="use-case-1-homeowner-interested-in-solar-energy">
+<h2>🏠 <strong>Use Case 1: Homeowner Interested in Solar Energy</strong><a class="headerlink" href="#use-case-1-homeowner-interested-in-solar-energy" title="Link to this heading"></a></h2>
+<p>🧑 <strong>User:</strong>
+<em>“How much do solar panels cost for a house?”</em></p>
+<p>🤖 <strong>AI:</strong>
+<em>“The cost of solar panels for a house depends on several factors, including system size, location, and available incentives. On average:</em>
+• A 5kW solar system costs ₹2,00,000 - ₹3,50,000 in India before incentives.
+• Government subsidies can reduce costs by 30-40% under certain programs.
+• The payback period is usually 5-7 years based on electricity savings.”*</p>
+<p>🧑 <strong>User:</strong>
+<em>“How much will I save on electricity bills?”</em></p>
+<p>🤖 <strong>AI:</strong>
+<em>“Solar savings depend on:</em>
+✅ Sunlight availability in your location.
+✅ Electricity consumption (higher bills = more savings).
+✅ Net metering (selling extra power back to the grid).</p>
+<p>💡 <strong>Example Calculation:</strong>
+• Before Solar: ₹3,000/month electricity bill.
+• After Solar: ₹500/month (80% savings).
+• <strong>Annual Savings:</strong> ₹30,000 (₹3,000 x 12 months).
+• <strong>10-year Savings:</strong> ₹3,00,000! 🎉”*</p>
+<p>—</p>
+</section>
+<section id="use-case-2-business-owner-exploring-commercial-solar">
+<h2>🏢 <strong>Use Case 2: Business Owner Exploring Commercial Solar</strong><a class="headerlink" href="#use-case-2-business-owner-exploring-commercial-solar" title="Link to this heading"></a></h2>
+<p>🧑 <strong>User:</strong>
+<em>“Is solar energy a good investment for my business?”</em></p>
+<p>🤖 <strong>AI:</strong>
+<em>“Yes! Here’s why commercial solar is a smart investment:</em>
+🔹 Lower electricity costs: Save up to 50-80% on power bills.
+🔹 Tax benefits: Businesses can claim depreciation &amp; subsidies.
+🔹 ROI in 3-5 years: With net metering, extra energy earns credits.
+🔹 Sustainability: Green branding improves reputation &amp; compliance.”*</p>
+<p>🧑 <strong>User:</strong>
+<em>“What incentives are available for businesses?”</em></p>
+<p>🤖 <strong>AI:</strong>
+<em>“Indian businesses can benefit from:</em>
+💰 Accelerated Depreciation: 40% depreciation in the first year.
+⚡ Net Metering: Sell excess power to the grid.
+🏢 Government Subsidies: Up to 30% for some industries.
+📜 State Incentives: Vary by region (Delhi, Maharashtra, etc.).”*</p>
+<p>—</p>
+</section>
+<section id="use-case-3-student-learning-about-solar-energy">
+<h2>🎓 <strong>Use Case 3: Student Learning About Solar Energy</strong><a class="headerlink" href="#use-case-3-student-learning-about-solar-energy" title="Link to this heading"></a></h2>
+<p>🧑 <strong>User:</strong>
+<em>“How do solar panels generate electricity?”</em></p>
+<p>🤖 <strong>AI:</strong>
+<em>“Solar panels generate electricity using the **photovoltaic effect*</em>.*
+🔹 Step 1: Sunlight hits solar cells (made of silicon).
+🔹 Step 2: Photons excite electrons, creating an electric flow.
+🔹 Step 3: The inverter converts DC power to AC for home use.
+🔹 Step 4: Power is used or sent to the grid for credits.”*</p>
+<p>🧑 <strong>User:</strong>
+<em>“What is the efficiency of monocrystalline vs. polycrystalline panels?”</em></p>
+<p>🤖 <strong>AI:</strong>
+<em>“🔹 **Monocrystalline Panels:*</em>
+• <strong>Efficiency:</strong> 15-22% (higher efficiency).
+• <strong>Cost:</strong> More expensive but better performance.
+• <strong>Lifespan:</strong> 25+ years.</p>
+<p>🔹 <strong>Polycrystalline Panels:</strong>
+• <strong>Efficiency:</strong> 12-18% (slightly lower).
+• <strong>Cost:</strong> More affordable.
+• <strong>Lifespan:</strong> 20-25 years.</p>
+<p>💡 <strong>Monocrystalline =</strong> Best for limited space, maximum efficiency.
+💡 <strong>Polycrystalline =</strong> Best for budget-friendly installations.”*</p>
+<p>—</p>
+</section>
+<section id="use-case-4-environmentalist-curious-about-solar-s-impact">
+<h2>🌍 <strong>Use Case 4: Environmentalist Curious About Solar’s Impact</strong><a class="headerlink" href="#use-case-4-environmentalist-curious-about-solar-s-impact" title="Link to this heading"></a></h2>
+<p>🧑 <strong>User:</strong>
+<em>“How does solar energy help the environment?”</em></p>
+<p>🤖 <strong>AI:</strong>
+<em>“Solar energy helps the environment by:</em>
+✅ <strong>Reducing Carbon Footprint</strong> – Solar energy reduces CO₂ emissions by replacing fossil fuels.
+✅ <strong>Saving Water</strong> – Unlike coal power plants, solar energy does not require water cooling.
+✅ <strong>Preventing Air Pollution</strong> – No harmful emissions like SO₂, NOₓ, or particulate matter.
+✅ <strong>Reducing Land Degradation</strong> – Solar farms do not involve mining, unlike coal and gas.”*</p>
+<p>🧑 <strong>User:</strong>
+<em>“Can solar panels be recycled?”</em></p>
+<p>🤖 <strong>AI:</strong>
+<em>“Yes! Solar panels can be recycled to recover materials like:</em>
+♻️ <strong>Silicon</strong> (95%)
+♻️ <strong>Glass</strong> (90%)
+♻️ <strong>Aluminum</strong> (100%)
+🔹 Recycling plants in India &amp; worldwide help manage end-of-life solar waste.”*</p>
+</section>
+</section>
+
+
+           </div>
+          </div>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="test_openrouter.html" class="btn btn-neutral float-left" title="test_openrouter module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright .</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+   
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>

main.py

@@ -1,39 +0,0 @@
-from fastapi import FastAPI
-from pydantic import BaseModel
-import openai
-import requests
-import os
-
-app = FastAPI()
-
-# Set OpenRouter API key securely
-OPENROUTER_API_KEY = "sk-or-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"  # Replace with new API key
-API_URL = "https://openrouter.ai/api/v1/chat/completions"
-
-class ChatRequest(BaseModel):
-    user_input: str
-
-@app.post("/chat")
-async def chat(request: ChatRequest):
-    headers = {
-        "Authorization": f"Bearer {OPENROUTER_API_KEY}",
-        "Content-Type": "application/json"
-    }
-
-    data = {
-        "model": "openai/gpt-4",  # You can change the model if needed
-        "messages": [{"role": "user", "content": request.user_input}],
-        "temperature": 0.7
-    }
-
-    try:
-        response = requests.post(API_URL, headers=headers, json=data)
-        response_json = response.json()
-
-        if "choices" in response_json and response_json["choices"]:
-            return {"response": response_json["choices"][0]["message"]["content"]}
-        else:
-            return {"error": "Invalid response from OpenRouter."}
-
-    except Exception as e:
-        return {"error": str(e)}

streamlit_app.py

@@ -1,26 +0,0 @@
-import streamlit as st
-import requests
-
-API_URL = "http://127.0.0.1:8000/chat"
-
-st.set_page_config(page_title="Solar AI Assistant", page_icon="🌞", layout="centered")
-
-st.title("Solar AI Assistant 🌞")
-st.write("Ask me anything about solar energy!")
-
-user_input = st.text_input("Type your question below:")
-
-if st.button("Submit"):
-    if user_input:
-        with st.spinner("Thinking..."):
-            try:
-                response = requests.post(API_URL, json={"user_input": user_input})
-                if response.status_code == 200:
-                    st.success("Response:")
-                    st.write(response.json().get("response", "No response received."))
-                else:
-                    st.error("Failed to fetch response from API.")
-            except Exception as e:
-                st.error(f"Error: {str(e)}")
-    else:
-        st.warning("Please enter a question.")

test_openrouter.py

@@ -0,0 +1,25 @@
+import requests
+
+# ✅ OpenRouter API Key
+HF_AUTH_TOKEN = "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"
+
+# ✅ OpenRouter API Endpoint
+API_URL = "https://openrouter.ai/api/v1/chat/completions"
+
+# ✅ Use Dolphin 3.0 R1 Mistral 24B (Free)
+data = {
+    "model": "cognitivecomputations/dolphin3.0-r1-mistral-24b:free",  # ✅ Corrected Model Name
+    "messages": [{"role": "user", "content": "What is solar energy?"}],
+    "temperature": 0.7
+}
+
+# ✅ Define request headers
+headers = {"Authorization": f"Bearer {HF_AUTH_TOKEN}", "Content-Type": "application/json"}
+
+# ✅ Send request and print response
+try:
+    response = requests.post(API_URL, headers=headers, json=data)
+    print("STATUS CODE:", response.status_code)
+    print("RESPONSE JSON:", response.json())  # Print full response
+except Exception as e:
+    print("Error:", str(e))