Skip to content

Commit b61691b

Browse files
committed
Update docs and polish downstream frontend outputs
1 parent d2cdf9f commit b61691b

6 files changed

Lines changed: 1587 additions & 196 deletions

File tree

README.md

Lines changed: 74 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,24 @@
22
<h1>SciNet: A Large-Scale Knowledge Graph for Automated Scientific Research</h1>
33
</div>
44

5+
<p align="center">
6+
🌐 <strong>English</strong> · <a href="README_zh.md">简体中文</a>
7+
</p>
8+
9+
<p align="center">
10+
<a href="docs/api/SCINET_API_DOC.html">📚 API Docs Website</a>
11+
</p>
12+
513
<p align="center">
614
A pip-installable client and CLI for literature-grounded scientific research workflows on top of the hosted SciNet API.
715
</p>
816

917
<p align="center">
10-
<a href="https://arxiv.org/abs/2602.14367">馃搫 arXiv</a>
11-
12-
<a href="http://scinet.openkg.cn/register">馃攽 Get API Token</a>
13-
14-
<a href="http://scinet.openkg.cn/healthz">馃┖ API Health</a>
18+
<a href="https://arxiv.org/abs/2602.14367">📄 arXiv</a>
19+
·
20+
<a href="http://scinet.openkg.cn/register">🔑 Get API Token</a>
21+
·
22+
<a href="http://scinet.openkg.cn/healthz">🩺 API Health</a>
1523
</p>
1624

1725
<p align="center">
@@ -27,47 +35,62 @@
2735

2836
---
2937

30-
## 馃搼 Table of Contents
31-
32-
- [鉁?Overview](#-overview)
33-
- [馃殌 Quick Start](#-quick-start)
34-
- [馃攽 API Token](#-api-token)
35-
- [馃 What SciNet Does](#-what-scinet-does)
36-
- [馃З Supported Tasks](#-supported-tasks)
37-
- [馃洜锔?CLI-First Workflow](#锔?cli-first-workflow)
38-
- [馃О Editable Skills](#-editable-skills)
39-
- [馃悕 Python SDK](#-python-sdk)
40-
- [鈿欙笍 Configuration](#锔?configuration)
41-
- [馃И Examples](#-examples)
42-
- [馃摝 Outputs and Artifacts](#-outputs-and-artifacts)
43-
- [馃洜锔?GROBID for PDF Workflows](#锔?grobid-for-pdf-workflows)
44-
- [馃搨 Repository Layout](#-repository-layout)
45-
- [馃Н Troubleshooting](#-troubleshooting)
46-
- [馃椇锔?Roadmap](#锔?roadmap)
47-
- [鉁嶏笍 Citation](#锔?citation)
48-
- [馃搫 License](#-license)
38+
## ✨ Overview
4939

50-
---
40+
SciNet is a research map you can use from the command line. Give it a topic, an idea, an author, or a paper trail, and it helps you look up literature, gather graph-backed evidence, and turn the result into readable reports and reusable JSON artifacts.
41+
42+
Behind that simple workflow is a large scientific knowledge graph. SciNet connects papers, authors, institutions, venues, keywords, citations, and a four-level research taxonomy from domains down to topics. That means a search is not limited to matching words: it can follow how research areas, people, concepts, and papers relate to one another.
43+
44+
This repository packages that capability as a lightweight **SciNet client**. New users can install it with `pip`, register an API token, and start running literature-grounded research tasks without setting up Neo4j, maintaining graph data, or touching backend infrastructure.
45+
46+
<p align="center">
47+
<img src="imgs/field_distribution_pie.png" alt="SciNet field distribution across research areas" width="92%">
48+
</p>
49+
50+
<p align="center">
51+
<em>SciNet spans a broad research landscape, from medicine and social sciences to engineering, computer science, materials science, mathematics, and more.</em>
52+
</p>
5153

52-
## 鉁?Overview
54+
<p align="center">
55+
<img src="imgs/schema.png" alt="SciNet knowledge graph schema" width="92%">
56+
</p>
5357

54-
SciNet is a large-scale, multi-disciplinary, heterogeneous academic resource knowledge graph designed as a panoramic scientific evolution network. By integrating papers, authors, keywords, citations, disciplines, and other academic entities, SciNet provides a structured topological substrate for scientific discovery agents and research-assistance workflows.
58+
<p align="center">
59+
<em>The graph links papers with authors, institutions, sources, keywords, citations, related work, and the domain-field-subfield-topic hierarchy.</em>
60+
</p>
5561

56-
This repository provides a lightweight, user-facing **client package** for running literature-grounded research tasks on top of the hosted SciNet / KG2API backend.
62+
With the client, you can:
5763

58-
The client is responsible for:
64+
- search for papers with keyword, semantic, title, reference, and graph-aware retrieval;
65+
- run research workflows such as literature review, idea grounding, idea evaluation, idea generation, trend analysis, related-author retrieval, and researcher profiling;
66+
- save reproducible outputs such as `request.json`, `response.json`, `summary.txt`, and `report.md`;
67+
- customize downstream workflows through editable CLI **skills**.
5968

60-
- building structured retrieval requests;
61-
- calling the hosted SciNet API;
62-
- formatting concise terminal outputs;
63-
- saving reproducible artifacts such as `request.json`, `response.json`, and `report.md`;
64-
- exposing downstream research workflows as editable CLI **skills**.
69+
---
6570

66-
Users do **not** need to connect to Neo4j, graph databases, or backend infrastructure directly.
71+
## 📑 Table of Contents
72+
73+
- [✨ Overview](#-overview)
74+
- [🚀 Quick Start](#-quick-start)
75+
- [🔑 API Token](#-api-token)
76+
- [🧠 What SciNet Does](#-what-scinet-does)
77+
- [🧩 Supported Tasks](#-supported-tasks)
78+
- [🛠️ CLI-First Workflow](#-cli-first-workflow)
79+
- [🧰 Editable Skills](#-editable-skills)
80+
- [🐍 Python SDK](#-python-sdk)
81+
- [⚙️ Configuration](#-configuration)
82+
- [🧪 Examples](#-examples)
83+
- [📦 Outputs and Artifacts](#-outputs-and-artifacts)
84+
- [🛠️ GROBID for PDF Workflows](#-grobid-for-pdf-workflows)
85+
- [📂 Repository Layout](#-repository-layout)
86+
- [🧯 Troubleshooting](#-troubleshooting)
87+
- [🗺️ Roadmap](#-roadmap)
88+
- [✍️ Citation](#-citation)
89+
- [📄 License](#-license)
6790

6891
---
6992

70-
## 馃殌 Quick Start
93+
## 🚀 Quick Start
7194

7295
### 1. Install
7396

@@ -133,7 +156,7 @@ scinet search-papers \
133156

134157
---
135158

136-
## 馃攽 API Token
159+
## 🔑 API Token
137160

138161
SciNet uses personal API tokens for public access.
139162

@@ -171,7 +194,7 @@ curl -H "Authorization: Bearer $SCINET_API_KEY" \
171194

172195
---
173196

174-
## 馃 What SciNet Does
197+
## 🧠 What SciNet Does
175198

176199
SciNet is built for research workflows rather than plain keyword search.
177200

@@ -182,7 +205,7 @@ SciNet is built for research workflows rather than plain keyword search.
182205

183206
---
184207

185-
## 馃З Supported Tasks
208+
## 🧩 Supported Tasks
186209

187210
| Command | Scenario | Main Output |
188211
|---|---|---|
@@ -201,7 +224,7 @@ SciNet is built for research workflows rather than plain keyword search.
201224

202225
---
203226

204-
## 馃洜锔?CLI-First Workflow
227+
## 🛠️ CLI-First Workflow
205228

206229
SciNet is CLI-first. The CLI is the primary interface for both users and AI agents.
207230

@@ -273,7 +296,7 @@ Recommended safe defaults:
273296

274297
---
275298

276-
## 馃О Editable Skills
299+
## 🧰 Editable Skills
277300

278301
SciNet skills are JSON presets for downstream research workflows. They make complex workflows easier to inspect, reuse, and customize.
279302

@@ -312,7 +335,7 @@ User-defined skills can override built-in skills with the same name.
312335

313336
---
314337

315-
## 馃悕 Python SDK
338+
## 🐍 Python SDK
316339

317340
SciNet also provides a lightweight Python client.
318341

@@ -347,7 +370,7 @@ print(client.token_status())
347370

348371
---
349372

350-
## 鈿欙笍 Configuration
373+
## ⚙️ Configuration
351374

352375
```env
353376
SCINET_API_BASE_URL=http://scinet.openkg.cn
@@ -367,7 +390,7 @@ For new setups, prefer `SCINET_*`.
367390

368391
---
369392

370-
## 馃И Examples
393+
## 🧪 Examples
371394

372395
### Literature Review
373396

@@ -428,7 +451,7 @@ scinet researcher-review \
428451

429452
---
430453

431-
## 馃摝 Outputs and Artifacts
454+
## 📦 Outputs and Artifacts
432455

433456
Terminal output is concise and table-based. Full outputs are saved under:
434457

@@ -449,7 +472,7 @@ Common artifacts:
449472

450473
---
451474

452-
## 馃洜锔?GROBID for PDF Workflows
475+
## 🛠️ GROBID for PDF Workflows
453476

454477
GROBID extracts structured metadata from scientific PDFs, including titles, authors, abstracts, and references. It is only needed for PDF-based workflows.
455478

@@ -467,7 +490,7 @@ GROBID_BASE_URL=http://127.0.0.1:8070
467490

468491
---
469492

470-
## 馃搨 Repository Layout
493+
## 📂 Repository Layout
471494

472495
```text
473496
SciNet/
@@ -496,7 +519,7 @@ SciNet/
496519

497520
---
498521

499-
## 馃Н Troubleshooting
522+
## 🧯 Troubleshooting
500523

501524
### `scinet health` works but `search-papers` returns 401
502525

@@ -545,7 +568,7 @@ or reinstall:
545568

546569
---
547570

548-
## 馃椇锔?Roadmap
571+
## 🗺️ Roadmap
549572

550573
- [ ] PyPI release for `pip install scinet-client`
551574
- [ ] `scinet auth login/status/usage`
@@ -559,7 +582,7 @@ or reinstall:
559582

560583
---
561584

562-
## 鉁嶏笍 Citation
585+
## ✍️ Citation
563586

564587
If you find SciNet helpful, please cite:
565588

@@ -574,6 +597,6 @@ If you find SciNet helpful, please cite:
574597

575598
---
576599

577-
## 馃搫 License
600+
## 📄 License
578601

579602
This project is licensed under the MIT License. See [LICENSE](LICENSE) for details.

0 commit comments

Comments
 (0)