Spaces:

shukdevdatta123
/

Systematic-Research-Paper-Review

Running

App Files Files Community

shukdevdatta123 commited on 4 days ago

Commit

a2df9a3

verified ·

1 Parent(s): e56be65

Update app.py

Browse files

Files changed (1) hide show

app.py +282 -34

app.py CHANGED Viewed

@@ -37,7 +37,8 @@ def generate_systematic_review(pdf_files, review_question, include_tables=True):
         openai.api_key = api_key
         # Create the system message with systematic review guidelines
-        system_prompt = """You are an expert academic assistant. Create a systematic review in HTML format using <h2>, <h3>, <p>, <ul>, and <table> tags. The Systematic Review must be in great details. Structure it using these steps:
         Step 1: Identify a Research Field
         The first step in writing a systematic review paper is to identify a research field. This involves selecting a specific area of study that you are interested in and want to explore further.
@@ -70,6 +71,8 @@ def generate_systematic_review(pdf_files, review_question, include_tables=True):
         Step-11:
         Please include references in the form of citation and also link to the reference papers.
         """
         # Extract text from each PDF
@@ -101,7 +104,7 @@ def generate_systematic_review(pdf_files, review_question, include_tables=True):
             {"role": "user", "content": user_prompt + "\n\n" + "\n\n".join([f"Paper {i+1} - {pdf_names[i]}:\n{pdf_texts[i]}" for i in range(len(pdf_texts))])}
         ]
-        # Call the API with temperature=1 and top_p=1 as specified
         response = openai.ChatCompletion.create(
             model="gpt-4.1",
             messages=messages,
@@ -110,19 +113,160 @@ def generate_systematic_review(pdf_files, review_question, include_tables=True):
             max_tokens=16384
         )
-        # Format the response in HTML
         review_content = response["choices"][0]["message"]["content"]
-        # Create a basic HTML structure
-        html_output = f"""
-        <h2>Systematic Review</h2>
-        <p>{review_content}</p>
         """
-        return html_output
     except Exception as e:
-        return f"Error generating systematic review: {str(e)}"
 # Function to save uploaded files
 def save_uploaded_files(files):
@@ -139,34 +283,107 @@ def save_uploaded_files(files):
     return saved_paths
-# Add CSS styling
 custom_css = """
 <style>
     #generate_button {
-        background: linear-gradient(135deg, #4a00e0 0%, #8e2de2 100%); /* Purple gradient */
         color: white;
         font-weight: bold;
     }
     #generate_button:hover {
-        background: linear-gradient(135deg, #5b10f1 0%, #9f3ef3 100%); /* Slightly lighter */
     }
     #api_key_button {
-        background: linear-gradient(135deg, #68d391 0%, #48bb78 100%); /* Green gradient */
         color: white;
         font-weight: bold;
         margin-top: 27px;
     }
     #api_key_button:hover {
-        background: linear-gradient(135deg, #38a169 0%, #68d391 100%); /* Slightly darker green */
     }
-    .gradio-container {
-        font-family: 'Arial', sans-serif;
-        background-color: #f0f4f8;
     }
 </style>
 """
-# Gradio UI Layout
 with gr.Blocks(css=custom_css) as demo:
     gr.Markdown("# Systematic Review Generator for Research Papers")
@@ -179,29 +396,38 @@ with gr.Blocks(css=custom_css) as demo:
         4. Check the "Include Tables" option if you want the review to include comparison tables
         5. Click "Generate Systematic Review" to start the process
-        ### Tips:
-        - For best results, upload papers that are related to the same research topic or field
         - Be specific in your review question to get more focused results
         - The generated review will follow a systematic structure including research field identification, data extraction, analysis, and conclusions
         - The more papers you upload, the more comprehensive the review will be
         """)
-    # API Key Input
-    with gr.Row():
-        api_key_input = gr.Textbox(label="Enter OpenAI API Key", type="password")
-        api_key_button = gr.Button("Set API Key", elem_id="api_key_button")
         api_key_output = gr.Textbox(label="API Key Status", interactive=False)
     # PDF Upload and Review Settings
-    with gr.Row():
         with gr.Column():
-            pdf_files = gr.File(label="Upload PDF Research Papers", file_count="multiple", type="binary")
-            review_question = gr.Textbox(label="Review Question or Topic", value="Please Generate a systematic review of the following papers.")
             include_tables = gr.Checkbox(label="Include Comparison Tables", value=True)
-            generate_button = gr.Button("Generate Systematic Review", elem_id="generate_button")
-    # Output
-    review_output = gr.HTML(label="Systematic Review")
     # Button actions
     api_key_button.click(set_api_key, inputs=[api_key_input], outputs=[api_key_output])
@@ -209,11 +435,33 @@ with gr.Blocks(css=custom_css) as demo:
     # Generate systematic review
     def process_files_and_generate_review(files, question, include_tables):
         if not files:
-            return "Please upload at least one PDF file."
         # Save uploaded files
         saved_paths = save_uploaded_files(files)
         # Generate review
         review = generate_systematic_review(saved_paths, question, include_tables)
@@ -224,7 +472,7 @@ with gr.Blocks(css=custom_css) as demo:
             except:
                 pass
-        return review
     generate_button.click(
         process_files_and_generate_review,
@@ -234,4 +482,4 @@ with gr.Blocks(css=custom_css) as demo:
 # Launch the app
 if __name__ == "__main__":
-    demo.launch(share=True)

         openai.api_key = api_key
         # Create the system message with systematic review guidelines
+        system_prompt = """You are an expert academic assistant. Create a systematic review using academic research paper formatting. The Systematic Review must be in great details. Structure it using these steps:
         Step 1: Identify a Research Field
         The first step in writing a systematic review paper is to identify a research field. This involves selecting a specific area of study that you are interested in and want to explore further.
         Step-11:
         Please include references in the form of citation and also link to the reference papers.
+        Your response should be formatted in HTML but generate the content to look like a professional academic paper. Include proper section headers, abstracts, methodology sections, etc. Number all sections like an academic paper.
         """
         # Extract text from each PDF
             {"role": "user", "content": user_prompt + "\n\n" + "\n\n".join([f"Paper {i+1} - {pdf_names[i]}:\n{pdf_texts[i]}" for i in range(len(pdf_texts))])}
         ]
+        # Call the API with temperature=0.7 and top_p=1
         response = openai.ChatCompletion.create(
             model="gpt-4.1",
             messages=messages,
             max_tokens=16384
         )
+        # Get the AI response
         review_content = response["choices"][0]["message"]["content"]
+        # Apply professional academic paper styling
+        styled_html = f"""
+        <!DOCTYPE html>
+        <html lang="en">
+        <head>
+            <meta charset="UTF-8">
+            <meta name="viewport" content="width=device-width, initial-scale=1.0">
+            <title>Systematic Review</title>
+            <style>
+                /* Academic Paper Styling */
+                body {{
+                    font-family: 'Times New Roman', Times, serif;
+                    line-height: 1.6;
+                    color: #333;
+                    margin: 0;
+                    padding: 0;
+                    background-color: #f9f9f9;
+                }}
+                .paper-container {{
+                    max-width: 800px;
+                    margin: 0 auto;
+                    padding: 40px;
+                    background-color: white;
+                    box-shadow: 0 0 20px rgba(0, 0, 0, 0.1);
+                }}
+                header {{
+                    text-align: center;
+                    margin-bottom: 30px;
+                    border-bottom: 1px solid #ddd;
+                    padding-bottom: 20px;
+                }}
+                h1 {{
+                    font-size: 24px;
+                    margin: 0 0 15px;
+                    font-weight: bold;
+                }}
+                .author-info {{
+                    font-size: 14px;
+                    margin-bottom: 15px;
+                }}
+                .abstract {{
+                    font-style: italic;
+                    margin: 20px 0;
+                    padding: 15px;
+                    background-color: #f8f8f8;
+                    border-left: 3px solid #ccc;
+                }}
+                h2 {{
+                    font-size: 18px;
+                    margin: 30px 0 15px;
+                    border-bottom: 1px solid #eee;
+                    padding-bottom: 5px;
+                }}
+                h3 {{
+                    font-size: 16px;
+                    margin: 25px 0 10px;
+                }}
+                p {{
+                    margin: 0 0 15px;
+                    text-align: justify;
+                }}
+                .section {{
+                    margin-bottom: 30px;
+                }}
+                table {{
+                    width: 100%;
+                    border-collapse: collapse;
+                    margin: 20px 0;
+                    font-size: 14px;
+                }}
+                table, th, td {{
+                    border: 1px solid #ddd;
+                }}
+                th, td {{
+                    padding: 10px;
+                    text-align: left;
+                }}
+                th {{
+                    background-color: #f2f2f2;
+                }}
+                tr:nth-child(even) {{
+                    background-color: #f9f9f9;
+                }}
+                .citation {{
+                    font-size: 14px;
+                    color: #555;
+                }}
+                .reference-list {{
+                    margin-top: 40px;
+                    border-top: 1px solid #ddd;
+                    padding-top: 20px;
+                }}
+                .reference-list h2 {{
+                    margin-top: 0;
+                }}
+                .reference-item {{
+                    margin-bottom: 10px;
+                    padding-left: 25px;
+                    text-indent: -25px;
+                }}
+                ul, ol {{
+                    margin: 15px 0;
+                    padding-left: 25px;
+                }}
+                li {{
+                    margin-bottom: 5px;
+                }}
+                .figure {{
+                    margin: 25px 0;
+                    text-align: center;
+                }}
+                .figure img {{
+                    max-width: 100%;
+                }}
+                .figure-caption {{
+                    font-size: 14px;
+                    color: #666;
+                    margin-top: 10px;
+                }}
+                .footnote {{
+                    font-size: 12px;
+                    color: #777;
+                }}
+                @media print {{
+                    body {{
+                        background-color: white;
+                    }}
+                    .paper-container {{
+                        box-shadow: none;
+                        padding: 0;
+                    }}
+                }}
+            </style>
+        </head>
+        <body>
+            <div class="paper-container">
+                {review_content}
+            </div>
+        </body>
+        </html>
         """
+        return styled_html
     except Exception as e:
+        return f"""
+        <div style="color: red; padding: 20px; border: 1px solid red; border-radius: 5px; background-color: #ffecec;">
+            <h3>Error Generating Systematic Review</h3>
+            <p>{str(e)}</p>
+        </div>
+        """
 # Function to save uploaded files
 def save_uploaded_files(files):
     return saved_paths
+# Add CSS styling for the Gradio interface
 custom_css = """
 <style>
+    /* Main UI */
+    .gradio-container {
+        font-family: 'Arial', sans-serif;
+        background-color: #f9f9f9;
+    }
+    /* Header */
+    h1 {
+        font-size: 28px;
+        color: #333;
+        margin-bottom: 20px;
+        text-align: center;
+        padding-bottom: 10px;
+        border-bottom: 2px solid #4a00e0;
+    }
+    /* Primary Button */
     #generate_button {
+        background: linear-gradient(135deg, #4a00e0 0%, #8e2de2 100%);
         color: white;
         font-weight: bold;
+        padding: 10px 20px;
+        border-radius: 5px;
+        transition: all 0.3s ease;
     }
     #generate_button:hover {
+        background: linear-gradient(135deg, #5b10f1 0%, #9f3ef3 100%);
+        transform: translateY(-2px);
+        box-shadow: 0 4px 8px rgba(0,0,0,0.1);
     }
+    /* API Key Button */
     #api_key_button {
+        background: linear-gradient(135deg, #68d391 0%, #48bb78 100%);
         color: white;
         font-weight: bold;
         margin-top: 27px;
+        padding: 10px 20px;
+        border-radius: 5px;
+        transition: all 0.3s ease;
     }
     #api_key_button:hover {
+        background: linear-gradient(135deg, #38a169 0%, #68d391 100%);
+        transform: translateY(-2px);
+        box-shadow: 0 4px 8px rgba(0,0,0,0.1);
     }
+    /* Form Elements */
+    .input-container {
+        background-color: white;
+        padding: 20px;
+        border-radius: 8px;
+        box-shadow: 0 2px 10px rgba(0,0,0,0.05);
+        margin-bottom: 20px;
+    }
+    /* Labels */
+    label {
+        font-weight: 600;
+        color: #555;
+        margin-bottom: 8px;
+    }
+    /* Instructions Accordion */
+    .accordion {
+        background-color: white;
+        border: 1px solid #e0e0e0;
+        border-radius: 8px;
+        margin-bottom: 20px;
+    }
+    /* Output Container */
+    .output-container {
+        background-color: white;
+        padding: 15px;
+        border-radius: 8px;
+        box-shadow: 0 2px 10px rgba(0,0,0,0.05);
+    }
+    /* File Upload Area */
+    .file-upload {
+        border: 2px dashed #ccc;
+        border-radius: 5px;
+        padding: 20px;
+        text-align: center;
+        margin-bottom: 20px;
+    }
+    /* Responsive adjustments */
+    @media screen and (max-width: 768px) {
+        .gradio-container {
+            padding: 10px;
+        }
     }
 </style>
 """
+# Gradio UI Layout with improved styling
 with gr.Blocks(css=custom_css) as demo:
     gr.Markdown("# Systematic Review Generator for Research Papers")
         4. Check the "Include Tables" option if you want the review to include comparison tables
         5. Click "Generate Systematic Review" to start the process
+        ### Tips for Best Results:
+        - Upload papers that are related to the same research topic or field
         - Be specific in your review question to get more focused results
         - The generated review will follow a systematic structure including research field identification, data extraction, analysis, and conclusions
         - The more papers you upload, the more comprehensive the review will be
+        - The review will be formatted as a professional academic paper with proper sections and citations
         """)
+    # API Key Input in a styled container
+    with gr.Row(elem_classes="input-container"):
+        with gr.Column(scale=3):
+            api_key_input = gr.Textbox(label="Enter OpenAI API Key", type="password", placeholder="sk-...")
+        with gr.Column(scale=1):
+            api_key_button = gr.Button("Set API Key", elem_id="api_key_button")
         api_key_output = gr.Textbox(label="API Key Status", interactive=False)
     # PDF Upload and Review Settings
+    with gr.Row(elem_classes="input-container"):
         with gr.Column():
+            gr.Markdown("### Upload Research Papers")
+            pdf_files = gr.File(label="Upload PDF Research Papers", file_count="multiple", type="binary", elem_classes="file-upload")
+            review_question = gr.Textbox(
+                label="Review Question or Topic",
+                value="Please generate a systematic review of the following papers.",
+                placeholder="e.g., What are the effects of mindfulness meditation on stress reduction?"
+            )
             include_tables = gr.Checkbox(label="Include Comparison Tables", value=True)
+            generate_button = gr.Button("Generate Systematic Review", elem_id="generate_button", size="large")
+    # Output with improved styling
+    with gr.Row(elem_classes="output-container"):
+        review_output = gr.HTML(label="Systematic Review")
     # Button actions
     api_key_button.click(set_api_key, inputs=[api_key_input], outputs=[api_key_output])
     # Generate systematic review
     def process_files_and_generate_review(files, question, include_tables):
         if not files:
+            return """
+            <div style="padding: 20px; border: 1px solid #e0e0e0; border-radius: 5px; background-color: #f9f9f9;">
+                <h3 style="color: #666;">Please upload at least one PDF file.</h3>
+                <p>To generate a systematic review, upload one or more research papers in PDF format.</p>
+            </div>
+            """
         # Save uploaded files
         saved_paths = save_uploaded_files(files)
+        # Show loading message
+        yield """
+        <div style="padding: 20px; text-align: center;">
+            <h3>Generating Systematic Review...</h3>
+            <p>This may take a few minutes depending on the number and size of papers.</p>
+            <div style="width: 100%; height: 4px; background-color: #f0f0f0; margin: 20px 0; border-radius: 2px; overflow: hidden;">
+                <div style="width: 30%; height: 100%; background: linear-gradient(90deg, #4a00e0, #8e2de2); animation: progress 2s infinite linear;"></div>
+            </div>
+            <style>
+                @keyframes progress {
+                    0% { margin-left: -30%; }
+                    100% { margin-left: 100%; }
+                }
+            </style>
+        </div>
+        """
         # Generate review
         review = generate_systematic_review(saved_paths, question, include_tables)
             except:
                 pass
+        yield review
     generate_button.click(
         process_files_and_generate_review,
 # Launch the app
 if __name__ == "__main__":
+    demo.launch(share=True)