Academic Literature Review, Deduplication & AI Ranking Tool

A comprehensive desktop application for academic researchers to search, collect, deduplicate, and rank scholarly articles using AI. Built with Python and designed for ease of use.

---

Table of Contents

• English
• Persian (Farsi)

---

English

Features

• Google Scholar Search - Search millions of academic papers via Google Scholar
• Scopus Search - Access Elsevier's Scopus database with your API key
• Automatic Deduplication - Detect and remove duplicate papers using fuzzy matching
• AI-Powered Ranking - Use Google Gemini AI to rank papers by relevance to your research topic
• Excel Export - Export your results to .xlsx format for further analysis
• Theme Toggle - Switch between light and dark themes
• Session Management - Save and load your research sessions to continue later

Prerequisites

Python 3.8 or higher

1. Download Python from https://www.python.org/downloads/
2. Run the installer
3. IMPORTANT: Check the box that says "Add Python to PATH" during installation
4. Click "Install Now"
5. Verify installation by opening Command Prompt and typing: python --version

Getting API Keys

Scopus API Key (for Scopus search)

1. Go to https://dev.elsevier.com/
2. Click "Register" or "Sign in" (create a free account if you don't have one)
3. After signing in, navigate to "My API Key" or "Create API Key"
4. Fill in the required information (application name, description)
5. Copy your API key
6. Paste it into the "Scopus API Key" field in the application

Google Gemini API Key (for AI ranking)

1. Go to https://aistudio.google.com/
2. Sign in with your Google account
3. Click on "Get API Key" in the left sidebar
4. Click "Create API Key"
5. Select a Google Cloud project (or create a new one)
6. Copy your API key
7. Paste it into the "Gemini API Key" field in the application

Installation & Running

1. Download or clone this project to your computer
2. Double-click run.bat to start the application
3. The script will automatically:
   • Check if Python is installed
   • Install all required dependencies
   • Launch the application

That's it! No command line knowledge required.

Usage Guide

Main Interface

The application window has several sections:

Search Section (Top)

• Search Query: Enter your research topic or keywords
• Max Results: Set how many results you want (per source)
• Search Scholar: Click to search Google Scholar
• Search Scopus: Click to search the Scopus database (requires API key)

API Keys Section

• Scopus API Key: Enter your Scopus API key here
• Gemini API Key: Enter your Google Gemini API key here

Results Table (Middle)

• Displays all collected papers with columns: Title, Authors, Year, Source, Similarity
• Click on column headers to sort results
• Select rows to view details

Action Buttons

• Deduplicate: Analyzes all papers and removes duplicates based on title similarity. Papers with very similar titles are merged, keeping the most complete record.
• AI Rank: Uses Google Gemini to rank papers by relevance to your search query. Papers are scored and sorted with the most relevant ones at the top.
• Export to Excel: Saves all current results to an Excel file (.xlsx) that you can open in Microsoft Excel or Google Sheets.
• Save Session: Saves your current work (all papers, settings, API keys) to a file so you can continue later.
• Load Session: Opens a previously saved session file to restore your work.
• Toggle Theme: Switches between light and dark color themes.

Workflow

1. Enter your research topic in the search box
2. Click "Search Scholar" to find papers on Google Scholar
3. (Optional) Enter your Scopus API key and click "Search Scopus" for additional results
4. Click "Deduplicate" to remove duplicate papers
5. (Optional) Enter your Gemini API key and click "AI Rank" to rank papers by relevance
6. Click "Export to Excel" to save your final list
7. Use "Save Session" to save your progress for later

Troubleshooting

Problem	Solution
"Python is not installed" error	Download Python from python.org and make sure to check "Add Python to PATH" during installation
"pip is not recognized"	Reinstall Python with "Add Python to PATH" checked
Scopus search returns no results	Verify your API key is correct and that you have network access
Gemini API key error	Make sure you copied the full API key from AI Studio
"No module named..." error	Run pip install -r requirements.txt manually in the project folder
Application freezes during search	Searches can take time depending on the number of results. Wait for it to complete.
Network/connection errors	Check your internet connection. Some institutional networks may block API access.
Google Scholar blocks requests	Google Scholar may temporarily block requests if too many searches are made. Wait a few minutes and try again.

---

Persian (Farsi) / فارسی

ابزار مرور ادبیات علمی، حذف تکراری و رتبه‌بندی هوشمند

یک برنامه دسکتاپ جامع برای پژوهشگران دانشگاهی جهت جستجو، جمع‌آوری، حذف مقالات تکراری و رتبه‌بندی مقالات علمی با استفاده از هوش مصنوعی. ساخته شده با پایتون و طراحی شده برای سهولت استفاده.

ویژگی‌ها

• جستجوی گوگل اسکالر - جستجو در میلیون‌ها مقاله علمی از طریق Google Scholar
• جستجوی اسکوپوس - دسترسی به پایگاه داده Scopus الزویر با کلید API
• حذف خودکار تکراری‌ها - شناسایی و حذف مقالات تکراری با استفاده از تطبیق فازی
• رتبه‌بندی هوشمند با AI - استفاده از Google Gemini برای رتبه‌بندی مقالات بر اساس ارتباط با موضوع تحقیق
• خروجی اکسل - ذخیره نتایج در فرمت xlsx. برای تحلیل بیشتر
• تغییر تم - تغییر بین تم‌های روشن و تاریک
• مدیریت جلسات - ذخیره و بارگذاری جلسات تحقیقاتی برای ادامه کار

پیش‌نیازها

پایتون نسخه 3.8 یا بالاتر

1. پایتون را از https://www.python.org/downloads/ دانلود کنید
2. فایل نصب را اجرا کنید
3. مهم: حتما گزینه "Add Python to PATH" را در هنگام نصب تیک بزنید
4. روی "Install Now" کلیک کنید
5. برای تایید نصب، Command Prompt را باز کنید و تایپ کنید: python --version

دریافت کلیدهای API

کلید API اسکوپوس (برای جستجوی Scopus)

1. به آدرس https://dev.elsevier.com/ بروید
2. روی "Register" یا "Sign in" کلیک کنید (اگر حساب کاربری ندارید، یک حساب رایگان بسازید)
3. پس از ورود، به بخش "My API Key" یا "Create API Key" بروید
4. اطلاعات لازم (نام برنامه، توضیحات) را وارد کنید
5. کلید API خود را کپی کنید
6. آن را در فیلد "Scopus API Key" در برنامه وارد کنید

کلید API گوگل جمینای (برای رتبه‌بندی هوشمند)

1. به آدرس https://aistudio.google.com/ بروید
2. با حساب گوگل خود وارد شوید
3. روی "Get API Key" در نوار کناری سمت چپ کلیک کنید
4. روی "Create API Key" کلیک کنید
5. یک پروژه Google Cloud انتخاب کنید (یا یک پروژه جدید بسازید)
6. کلید API خود را کپی کنید
7. آن را در فیلد "Gemini API Key" در برنامه وارد کنید

نصب و اجرا

1. این پروژه را دانلود یا clone کنید
2. روی فایل run.bat دابل‌کلیک کنید
3. اسکریپت به طور خودکار:
   • بررسی می‌کند که پایتون نصب شده باشد
   • تمام وابستگی‌ها را نصب می‌کند
   • برنامه را اجرا می‌کند

همین! نیازی به دانش خط فرمان نیست.

راهنمای استفاده

رابط اصلی

پنجره برنامه شامل بخش‌های زیر است:

بخش جستجو (بالا)

• عبارت جستجو: موضوع تحقیق یا کلمات کلیدی خود را وارد کنید
• حداکثر نتایج: تعداد نتایج مورد نظر را تنظیم کنید
• جستجوی Scholar: برای جستجو در Google Scholar کلیک کنید
• جستجوی Scopus: برای جستجو در پایگاه داده Scopus کلیک کنید (نیاز به کلید API دارد)

بخش کلیدهای API

• کلید API اسکوپوس: کلید Scopus خود را اینجا وارد کنید
• کلید API جمینای: کلید Google Gemini خود را اینجا وارد کنید

جدول نتایج (وسط)

• تمام مقالات جمع‌آوری شده با ستون‌های: عنوان، نویسندگان، سال، منبع، شباهت نمایش داده می‌شود
• روی سربرگ ستون‌ها کلیک کنید تا نتایج مرتب شوند
• ردیف‌ها را انتخاب کنید تا جزئیات را ببینید

دکمه‌های عملیات

• حذف تکراری (Deduplicate): تمام مقالات را تحلیل کرده و تکراری‌ها را بر اساس شباهت عنوان حذف می‌کند
• رتبه‌بندی AI: از Google Gemini برای رتبه‌بندی مقالات بر اساس ارتباط با موضوع جستجو استفاده می‌کند
• خروجی اکسل: نتایج فعلی را در فایل اکسل (xlsx.) ذخیره می‌کند
• ذخیره جلسه: کار فعلی شما (تمام مقالات، تنظیمات، کلیدهای API) را ذخیره می‌کند
• بارگذاری جلسه: یک جلسه ذخیره شده قبلی را بازیابی می‌کند
• تغییر تم: بین تم‌های رنگی روشن و تاریک تغییر می‌دهد

روند کار

1. موضوع تحقیق خود را در کادر جستجو وارد کنید
2. روی "Search Scholar" کلیک کنید تا مقالات از Google Scholar پیدا شوند
3. (اختیاری) کلید API اسکوپوس خود را وارد کنید و روی "Search Scopus" کلیک کنید
4. روی "Deduplicate" کلیک کنید تا مقالات تکراری حذف شوند
5. (اختیاری) کلید API جمینای خود را وارد کنید و روی "AI Rank" کلیک کنید
6. روی "Export to Excel" کلیک کنید تا لیست نهایی ذخیره شود
7. از "Save Session" برای ذخیره پیشرفت کار خود استفاده کنید

عیب‌یابی

مشکل	راه‌حل
خطای "Python is not installed"	پایتون را از python.org دانلود و نصب کنید. حتما "Add Python to PATH" را تیک بزنید
خطای "pip is not recognized"	پایتون را مجددا با تیک "Add Python to PATH" نصب کنید
جستجوی Scopus نتیجه‌ای ندارد	کلید API خود را بررسی کنید و مطمئن شوید به اینترنت دسترسی دارید
خطای کلید API جمینای	مطمئن شوید کلید API کامل را از AI Studio کپی کرده‌اید
خطای "No module named..."	دستور pip install -r requirements.txt را در پوشه پروژه اجرا کنید
برنامه هنگ می‌کند	جستجوها ممکن است زمان‌بر باشند. صبر کنید تا تکمیل شود
خطاهای شبکه	اتصال اینترنت خود را بررسی کنید. برخی شبکه‌های سازمانی ممکن است دسترسی API را مسدود کنند
مسدود شدن توسط Google Scholar	اگر جستجوهای زیادی انجام شود، Google Scholar ممکن است موقتا درخواست‌ها را مسدود کند. چند دقیقه صبر کنید

---

License

This project is open source and available for academic use.