Spaces:
Running
Running
|
Download README.md from nikeshn/researchbee: direct link, hf CLI and curl.
- Browser
- Download file 4.69 kB
-
https://huggingface.co/spaces/nikeshn/researchbee/resolve/main/README.md
- Command line
-
hf download hf://spaces/nikeshn/researchbee/README.md
-
curl -L -o README.md https://huggingface.co/spaces/nikeshn/researchbee/resolve/main/README.md
4.69 kB
| title: ResearchBee | |
| emoji: 🐝 | |
| colorFrom: indigo | |
| colorTo: purple | |
| sdk: docker | |
| app_port: 7860 | |
| pinned: false | |
| license: mit | |
| short_description: Journal selection, Open Access and research data assistant | |
| # ResearchBee 1.8.3 (interface v1.9.3) | |
| **What's new:** nearest-subject matching for journal browse (e.g. "physics" → Physics and Astronomy, disclosed to the user) and a clearly labelled re3data.org supplement in the data-repository finder. See **RELEASE_1.8.3.md** for details, validation and post-deploy checks. Deploy as described in README-DEPLOY.md; the new optional settings are `RE3DATA_ENABLED` and `RE3DATA_TIMEOUT_SECONDS`. | |
| ## Earlier: hyperlink update | |
| See **DEPLOYMENT-LINKS.md** for this update, upload instructions, executed checks and untested limitations. The following notes describe the supplied base release. | |
| ## Base release 1.8.2 | |
| Publishing, Open Access and research data guidance for Khalifa University researchers. | |
| This release repairs the supplied backend and uses the separately uploaded LibGuides fragment as the frontend baseline. It retains the existing HF endpoint and `journal_discovery_v2` schema. | |
| ## Included functions | |
| - Journal discovery by manuscript or subject, verified identities and subject quartiles, preferred/excluded titles, comparisons and exports. | |
| - On-demand journal policies and DOI-based article-sharing checks with version, destination, licence, funder and embargo context. | |
| - Dataset repository selection from a curated registry, with deterministic constraint checks. | |
| - Source-aware English/Arabic chat, tool shortcuts, related literature and cover-letter drafts. | |
| - Health reporting, authenticated Khazna refresh and administration/usage monitoring. | |
| ## Main repairs | |
| - Repaired 7,721 missing subject-quartile values in 7,096 existing journal records using the bundled 2025 CSV. Remaining unknowns stay unknown. | |
| - Retained eligible preferred journals through both shortlist limits; removed inflated fallback match scores. | |
| - Sharing advice evaluates complete policy options. Permission, embargo timing and destination conditions cannot be borrowed from incompatible options. | |
| - Repository recommendations enforce declared capabilities and sensitive-data restrictions. Khazna dataset advice is metadata registration, with file-hosting capabilities requiring confirmation. | |
| - Fixed chat rendering, question chips, history limits, SSE interruptions, autocomplete identity, embargo controls, CSV safety and long-abstract cover letters. | |
| - Added Arabic knowledge matching, interface translations, focus/keyboard improvements and source-review warnings. | |
| - Added bounded requests, paid-route quotas/concurrency, safer admin sessions, server-only usage credentials, redacted failure logging and lifecycle repairs. | |
| - OpenAlex receives broad validated taxonomy terms for manuscript evidence searches, not the unpublished title or abstract. It still receives journal identifiers and public literature queries. | |
| - Disabled the unsupported journal-level Altmetric score and unrepresentative percentile calculation. | |
| ## Deploy | |
| See **README-DEPLOY.md**. Upload the complete extracted release to the existing Docker Space, including `journals.db`, new helper modules and `tests/`. Then replace the entire LibGuides fragment with `ResearchBee_LibGuides.html`. | |
| The Docker build installs pinned dependencies, runs `pip check`, compiles Python and runs the full Python test suite before creating the runtime image. Production runs as a non-root user. | |
| ## Validation | |
| See **VALIDATION_1.8.2.md** for executed checks and limitations. Local verification used Python 3.12 and Node 24; the container targets Python 3.11. The Docker build and real FastAPI HTTP smoke suite could not be executed in the preparation environment. Live credentials, external service availability and rendered LibGuides browser behavior require the post-upload checks. | |
| ```bash | |
| python -m pip install -r requirements-dev.txt | |
| python -m pytest -q | |
| node tests/test_frontend_links.cjs | |
| node tests/test_frontend_re3data.cjs | |
| ``` | |
| ## Evidence boundaries | |
| Journal identities and metrics come from the supplied local database and 2025 CSV. This release does not refresh them from current Scopus/SCImago sources. Fit scores support comparison; they do not estimate acceptance probability. Current APCs, title-level KU eligibility and unstructured policy conditions need authoritative confirmation. | |
| Khazna lookup reports a loaded snapshot. Its source harvest date is absent from the supplied snapshot format, so a missing DOI is not proof of current repository absence. | |
| Questions: library@ku.ac.ae; Khazna: khazna@ku.ac.ae. | |