Upload 4 files

Initial commit from C:\Users\jfhmb\AI FOR SCIENCE\AI Researcher Pro\AI_Researcher

README.md

@@ -1,13 +1,81 @@
----
-title: AI Researcher Pro
-emoji: 📈
-colorFrom: blue
-colorTo: indigo
-sdk: streamlit
-sdk_version: 1.38.0
-app_file: app.py
-pinned: false
-license: mit
+
+# AI Researcher Pro - Your Research Companion
+
+AI Researcher Pro is an AI-powered research assistant designed to streamline your research workflow. The app uses Groq API for intelligent research assistance and Google Scholar to retrieve relevant papers based on user queries. The tool helps researchers ask domain-specific questions and get AI-driven answers, along with recommended papers from the research community.
+
+## Features
+- **AI-Powered Research**: Ask research questions in specific domains like Computer Science, Medical, Engineering, and more.
+- **Research Paper Suggestions**: Get suggested papers directly from Google Scholar based on your question and selected sub-fields.
+- **Customizable Fields**: Choose from multiple research domains and their respective sub-fields to narrow down your research.
+- **Interactive User Interface**: User-friendly interface with enhanced styling and tooltips for better user experience.
+- **Secure API Handling**: Uses `st.secrets` to securely handle API keys, making the app ready for hackathon environments.
+
+## Tech Stack
+- **Streamlit**: For creating the interactive web interface.
+- **Groq API**: To generate AI-powered research responses.
+- **Google Scholar**: For fetching research papers based on the query.
+- **Python**: Core language used for application development.
+- **st.secrets**: Used for secure environment variable management.
+
+## Installation
+
+1. **Clone the Repository**
+   ```bash
+   git clone https://github.com/yourusername/ai-researcher-pro.git
+   cd ai-researcher-pro
+   ```
+
+2. **Set Up Environment Variables**
+   - Create a `secrets.toml` file in the `.streamlit` directory (if it doesn't exist):
+     ```bash
+     mkdir -p .streamlit
+     nano .streamlit/secrets.toml
+     ```
+   - Add your Groq API key in the `secrets.toml` file:
+     ```toml
+     [general]
+     GROQ_API_KEY = "your-groq-api-key-here"
+     ```
+
+3. **Install Dependencies**
+   Use `pip` to install the required dependencies:
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+4. **Run the Application**
+   Start the Streamlit app by running the following command:
+   ```bash
+   streamlit run app.py
+   ```
+
+## Usage
+
+1. **Select a Research Field**: Choose a broad research field from the sidebar (e.g., Computer Science, Medical, Engineering, etc.).
+2. **Select Sub-fields**: Based on the chosen research field, you can select specific sub-fields like AI, Data Science, Quantum Mechanics, and more.
+3. **Enter Research Question**: Type a clear, research-related question in the provided text box.
+4. **Submit**: Click the **Submit** button to get AI-generated answers and suggested research papers.
+5. **View Results**: Check the AI response in the **AI Response** tab and view suggested research papers in the **Suggested Papers** tab.
+
+## Example Queries
+- "What are the latest trends in Machine Learning?"
+- "How to improve model accuracy in Natural Language Processing?"
+- "Current advancements in Quantum Mechanics?"
+  
+The app will return a tailored response based on your query and the sub-fields selected.
+
+## Troubleshooting
+
+- **No Internet Connection**: If the app shows a "No internet connection" error, ensure your device is connected to the internet.
+- **Missing API Key**: If you encounter an error related to the API key, double-check your `secrets.toml` file for the correct `GROQ_API_KEY`.
+
+## Contribution
+
+Feel free to fork this project and submit a pull request if you'd like to contribute. You can also open an issue if you find bugs or have feature requests.
+
+## License
+
+This project is licensed under the [LICENSE](LICENSE).
+
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference

main.py

@@ -0,0 +1,178 @@
+import os
+import streamlit as st
+from dotenv import load_dotenv
+import socket
+from groq import Groq
+from scholarly import scholarly
+from prompts import get_research_prompt, get_guidance_prompt, invalid_question_prompt
+
+# Load environment variables from (.env) file
+load_dotenv()
+
+# Set up Groq client using st.secrets for secure API key handling
+api_key = st.secrets["GROQ_API_KEY"]
+if not api_key:
+    st.error("GROQ_API_KEY not found. Please check your environment variables.")
+else:
+    client = Groq(api_key=api_key)
+
+# Function to check internet connection
+def is_connected():
+    try:
+        socket.create_connection(("www.google.com", 80))
+        return True
+    except OSError:
+        return False
+
+# Streamlit UI Enhancements
+st.set_page_config(page_title="AI Researcher Pro - Your Research Companion", layout="wide")
+
+# Custom CSS for styling
+st.markdown("""
+    <style>
+    body {
+        font-family: 'Arial', sans-serif;
+    }
+    .stButton button {
+        border-radius: 10px;
+        padding: 10px 20px;
+    }
+    
+    .big-title {
+        font-size: 80px;
+        font-weight: bold;
+        color: #d84df1;
+        text-align: center;
+        background: linear-gradient(90deg, #4285f4, #ea4335, #fbbc05, #34a853);
+        -webkit-background-clip: text;
+        -webkit-text-fill-color: transparent;
+    }
+    .subtitle-style {
+        font-size: 18px;
+        text-align: center;
+        margin-bottom: 20px;
+    }
+    .tooltip {
+        color: gray;
+        font-style: italic;
+        font-size: 14px;
+    }
+    .sidebar-title {
+        font-size: 18px;
+        font-weight: bold;
+        color: #c24838;
+        margin-bottom: 10px;
+    }
+    .research-field {
+        font-weight: bold;
+        color: #c24838;
+        font-size: 14px;
+    }
+    </style>
+""", unsafe_allow_html=True)
+
+# Title and subtitle with custom styling
+st.markdown("<h1 class='big-title'>AI Researcher Pro</h1>", unsafe_allow_html=True)
+st.markdown("<p class='subtitle-style'>Your AI-powered research assistant for all your research needs!</p>", unsafe_allow_html=True)
+
+# Adding a tooltip with enhanced styling
+st.markdown("""
+    <p class='tooltip'>Tip: Ask specific research questions like "What are the latest trends in AI?" or "How to improve model accuracy in NLP?"</p>
+    """, unsafe_allow_html=True)
+
+# Connectivity Check
+if not is_connected():
+    st.error("⚠️ No internet connection. Please check your internet and try again.")
+    st.stop()
+
+# Define fields and their respective sub-fields
+fields_dict = {
+    "Computer Science": ["Artificial Intelligence", "Machine Learning", "Data Science", "Computer Vision", "Natural Language Processing"],
+    "Medical": ["Biotechnology", "Genetics", "Neuroscience", "Immunology", "Medical Imaging"],
+    "Physics": ["Quantum Mechanics", "Astrophysics", "Nuclear Physics", "Condensed Matter Physics", "Particle Physics"],
+    "Chemistry": ["Organic Chemistry", "Inorganic Chemistry", "Biochemistry", "Physical Chemistry", "Analytical Chemistry"],
+    "Engineering": ["Electrical Engineering", "Mechanical Engineering", "Civil Engineering", "Aerospace Engineering", "Biomedical Engineering"]
+}
+
+# Sidebar for selecting broad research fields
+st.sidebar.markdown("<div class='sidebar-title'>Select a Broad Research Field</div>", unsafe_allow_html=True)
+broad_field = st.sidebar.selectbox("Research Field", list(fields_dict.keys()))
+
+# Show relevant sub-fields based on the broad field selected
+st.sidebar.markdown(f"<div class='sidebar-title'>Select Sub-fields in {broad_field}</div>", unsafe_allow_html=True)
+selected_subfields = []
+for subfield in fields_dict[broad_field]:
+    if st.sidebar.checkbox(f"🔍 {subfield}", key=subfield):
+        selected_subfields.append(subfield)
+
+# User input in the main layout
+st.markdown("<div class='research-field'>Research Question</div>", unsafe_allow_html=True)
+research_question = st.text_input("", "", help="Enter a clear research-related question")
+
+# Function to get research papers from Google Scholar
+def get_research_papers_from_scholar(topic, fields):
+    papers = []
+    for field in fields:
+        search_query = scholarly.search_pubs(f"{topic} {field}")
+        for i in range(5):  # Get top 5 results for each field
+            try:
+                paper = next(search_query)
+                title = paper['bib']['title']
+                abstract = paper.get('bib', {}).get('abstract', "No abstract available")
+                url = paper.get('pub_url', "No URL available")
+                papers.append({
+                    "title": title,
+                    "abstract": abstract,
+                    "url": url,
+                    "field": field
+                })
+            except StopIteration:
+                break
+    return papers
+
+# Function to simulate AI researcher's response
+def get_researcher_response(question, fields):
+    subfields = ", ".join(fields)
+    chat_completion = client.chat.completions.create(
+        messages=[get_research_prompt(question, subfields)],
+        model="llama3-groq-70b-8192-tool-use-preview",
+    )
+    answer = chat_completion.choices[0].message.content
+
+    if "non-research" in answer.lower():
+        return invalid_question_prompt(), None
+
+    guidance = get_guidance_prompt(question, subfields)
+    
+    return answer, guidance
+
+# Submit button with enhanced styling
+if st.button("Submit"):
+    if research_question and selected_subfields:
+        with st.spinner(f"Researching your question in {', '.join(selected_subfields)}..."):
+            answer, guidance = get_researcher_response(research_question, selected_subfields)
+            
+            if guidance:
+                # Use Tabs with icons for better organization
+                tab1, tab2 = st.tabs([f"🤖 AI Response", f"📄 Suggested Papers"])
+                
+                with tab1:
+                    st.write("### Researcher's Answer:")
+                    st.write(answer)
+                    st.write("### Researcher's Guidance:")
+                    st.write(guidance)
+                
+                with tab2:
+                    st.write("### Suggested Research Papers:")
+                    scholar_papers = get_research_papers_from_scholar(research_question, selected_subfields)
+                    if scholar_papers:
+                        for i, paper in enumerate(scholar_papers):
+                            with st.expander(f"📄 Paper {i+1}: {paper['title']} ({paper['field']})"):
+                                st.write(f"**Abstract**: {paper['abstract']}")
+                                st.write(f"[Read Full Paper]({paper['url']})")
+                    else:
+                        st.info("No papers found, try a different query.")
+            else:
+                st.warning(answer)
+    else:
+        st.warning("Please enter a research question and select at least one sub-field before submitting.")

prompts.py

@@ -0,0 +1,41 @@
+# prompts.py
+
+def get_research_prompt(question, field):
+    return {
+        "role": "user",
+        "content": f"""
+        The user is asking a research-related question in the field of '{field}'. Please provide a comprehensive answer to the question '{question}'.
+        
+        Additionally, include the following guidance:
+        - A suggested approach to perform a literature review.
+        - Potential open challenges or unresolved questions in this field.
+        - The most suitable methods or frameworks to address the research problem.
+        - Peer-reviewed sources or journals to consult.
+        - Next steps to further explore the topic, including objectives, methodology, and potential tools or datasets.
+
+        Make sure the response is structured and concise.
+        """
+    }
+
+
+
+def get_guidance_prompt(question, field):
+    return f"""
+    Here’s a suggested approach to explore the research question '{question}' in the field of '{field}':
+
+    - **Literature Review**: Start by identifying key papers, influential researchers, and recent advancements in the field.
+    - **Open Challenges**: Look for gaps or unresolved questions in existing research that align with your query.
+    - **Peer-Reviewed Sources**: Focus on gathering peer-reviewed papers, conference publications, and reputable journals.
+    - **Approach and Methods**: Consider the most suitable experimental methods or theoretical frameworks to address the research problem.
+    - **Next Steps**: Define a research plan, including objectives, methodology, and potential datasets or tools.
+
+    This structured approach will guide you in navigating and contributing to the existing body of knowledge.
+    """
+
+
+def invalid_question_prompt():
+    return """
+    This question doesn't appear to be research-related. Please ask questions that align with research topics
+    such as theories, methodologies, or advancements in the field. You could ask about current trends, 
+    innovations, or key challenges in research fields like AI or Data Science.
+    """

requirements.txt

@@ -0,0 +1,4 @@
+streamlit
+python-dotenv
+groq
+scholarly