researchbee / README.md
nikeshn's picture
Upload README.md
8d8b945 verified
|
Raw
History Blame Contribute Delete
3.52 kB
---
title: Research Navigator
emoji: 🐝
colorFrom: indigo
colorTo: purple
sdk: docker
app_port: 7860
pinned: false
license: mit
short_description: Journal finder, OA rights checker, data repository guide
---
# 🐝 Research Navigator
**Publishing & Repository Assistant for Khalifa University Researchers**
> *Find the right journal. Check your rights. Deposit to the right repository.*
Research Navigator is an AI-powered publishing and open access assistant built by [Khalifa University Library](https://library.ku.ac.ae/lib). It helps KU researchers navigate journal selection, self-archiving rights, and research data management β€” in one place.
---
## ✨ Features
### πŸ“° Tab 1 β€” Journal Submission
- 5 detailed journal cards + 10 quick-match suggestions (15 total per query)
- Full Green OA breakdown per journal: Preprint / AAM / Version of Record
- Ranking verified from 2025 journal data (32K+ journals) + OpenAlex enrichment
- Scopus Sources direct links per journal for live metric verification
- Khazna deposit guidance always included
### πŸ›‘ Tab 2 β€” License Checking
- Version-specific self-archiving policy (3-version breakdown)
- Embargo lengths, licence conditions, risk flags
- Direct deposit guidance for Khazna
### πŸ—„ Tab 3 β€” Data Repository
- 4–5 recommended repositories (domain-specific + generalist mix)
- Khazna always first as KU institutional option
- Metadata-first rule: register in Khazna even if data goes elsewhere
- FAIR alignment, certification, cost, embargo support per repository
### πŸ›οΈ Khazna Integration
- KU institutional repository always recommended across all three tabs
- Article and dataset deposit guidance
- Contact: khazna@ku.ac.ae
---
## πŸ—οΈ Architecture
```
GitHub Pages (frontend) ──HTTPS──► HuggingFace Spaces (FastAPI)
β”‚
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚ scimagojr_2025.csv β”‚
β”‚ OpenAlex API (free) β”‚
β”‚ OpenAI API (gpt-4o-mini) β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
```
---
## πŸš€ Deployment
### Backend β€” This Space
1. Add secret: `OPENAI_API_KEY` in Space Settings β†’ Secrets
2. All files are in the Space root and `static/` folder
3. Ping `/api/health` every 5 min via UptimeRobot to prevent cold starts
### Frontend β€” GitHub Pages
1. Update `HF_BASE` in `static/js/api.js` to your Space URL
2. Push to `gh-pages` branch of `ku-library/researchbee`
---
## πŸ“Š Data Sources
| Source | Used for | Key needed? |
|---|---|---|
| SCImago CSV 2025 | Offline quartile lookup (private) | No β€” bundled |
| OpenAlex API | Journal enrichment, h-index, citedness | No β€” free |
| OpenAI API | All AI analysis | Yes |
> Ranking metrics sourced from journal data (2025). Always verify policies on
> [Open Policy Finder](https://openpolicyfinder.jisc.ac.uk) and repositories on
> [re3data](https://www.re3data.org) before deposit.
---
## πŸ›οΈ About
Built by [Khalifa University Library](https://library.ku.ac.ae/lib) as part of the Research Navigator suite.
- πŸ“§ Library: library@ku.ac.ae
- πŸ›οΈ Khazna: khazna@ku.ac.ae
- 🌐 [khazna.ku.ac.ae](https://khazna.ku.ac.ae)
- πŸ“š [library.ku.ac.ae/lib](https://library.ku.ac.ae/lib)
---
MIT License β€” Khalifa University Library