Skip to content

Commit 35c8db7

Browse files
author
Vambrocop
committed
Add ScanSci PDF integration guide
1 parent d53bb17 commit 35c8db7

2 files changed

Lines changed: 187 additions & 0 deletions

File tree

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ See:
6161
- [`docs/reading-list.md`](docs/reading-list.md)
6262
- [`docs/gu-baojing-method-extraction.md`](docs/gu-baojing-method-extraction.md)
6363
- [`docs/knowledge-graph-navigation.md`](docs/knowledge-graph-navigation.md)
64+
- [`docs/scansci-pdf-setup-and-workflow.md`](docs/scansci-pdf-setup-and-workflow.md)
6465
- [`docs/version-roadmap.md`](docs/version-roadmap.md)
6566

6667
## Origin and Workflow Inspiration
Lines changed: 186 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,186 @@
1+
# ScanSci PDF Setup and Workflow
2+
3+
`scansci-pdf` is best treated as a literature-ingestion layer for EvidenceForge.
4+
5+
It is not a meta-analysis method by itself. It is the infrastructure that helps an agent:
6+
7+
- search papers;
8+
- resolve DOI and citation metadata;
9+
- download PDFs;
10+
- import `.bib` lists;
11+
- hand a structured paper set to screening, extraction, review, or meta-analysis workflows.
12+
13+
## Why It Fits EvidenceForge
14+
15+
EvidenceForge already covers:
16+
17+
- protocol design;
18+
- search and screening logs;
19+
- coding sheets;
20+
- effect-size extraction;
21+
- meta-analysis and umbrella-review logic;
22+
- environmental and life-science review variants.
23+
24+
`scansci-pdf` fits before those steps. It can serve as the retrieval and PDF-collection layer for:
25+
26+
- systematic reviews;
27+
- meta-analysis projects;
28+
- umbrella reviews;
29+
- AI-assisted screening;
30+
- domain-specific evidence audits.
31+
32+
## Recommended Architecture
33+
34+
Use three layers:
35+
36+
1. Retrieval layer:
37+
`scansci-pdf`
38+
39+
2. Evidence-method layer:
40+
`EvidenceForge`
41+
42+
3. Analysis or writing layer:
43+
`meta-analysis-forge`, `umbrella-review-skeptic`, `environment-life-review-forge`, or downstream manuscript tools.
44+
45+
This keeps paper retrieval separate from methodological judgment.
46+
47+
## Local Installation
48+
49+
Install from PyPI:
50+
51+
```bash
52+
py -m pip install scansci-pdf
53+
```
54+
55+
Check the local environment:
56+
57+
```bash
58+
scansci-pdf check
59+
```
60+
61+
The project README describes the standard MCP stdio configuration as:
62+
63+
```json
64+
{
65+
"mcpServers": {
66+
"scansci-pdf": {
67+
"command": "scansci-pdf",
68+
"args": ["run"]
69+
}
70+
}
71+
}
72+
```
73+
74+
For Claude Code, the command-line equivalent is:
75+
76+
```bash
77+
claude mcp add scansci-pdf -- scansci-pdf run
78+
```
79+
80+
Then verify:
81+
82+
```bash
83+
claude mcp list
84+
```
85+
86+
## Claude Code and Other Agents
87+
88+
If an MCP-compatible agent exposes the configured server, `scansci-pdf` can provide tools such as:
89+
90+
- keyword search;
91+
- DOI or arXiv download;
92+
- batch download;
93+
- citation export;
94+
- `.bib` import;
95+
- health checks and network diagnostics.
96+
97+
That makes it a strong front end for AI-assisted evidence synthesis.
98+
99+
## How To Use It With EvidenceForge
100+
101+
### Example: systematic review intake
102+
103+
1. Search papers by keyword.
104+
2. Export or collect DOI and citation metadata.
105+
3. Download PDFs in batch.
106+
4. Build a screening set.
107+
5. Move to:
108+
- `evidence-synthesis-forge` for protocol and screening;
109+
- `meta-analysis-forge` for coding and pooling;
110+
- `environment-life-review-forge` for domain-specific extraction.
111+
112+
### Example prompt pattern
113+
114+
```text
115+
Use scansci-pdf to search and download candidate papers on rice biochar and greenhouse gas emissions.
116+
Then switch to EvidenceForge screening and extraction workflows.
117+
Keep retrieval separate from methodological judgment.
118+
```
119+
120+
## Suggested Workflow Boundaries
121+
122+
Use `scansci-pdf` for:
123+
124+
- paper search;
125+
- PDF download;
126+
- DOI resolution;
127+
- citation export;
128+
- `.bib` import;
129+
- retrieval diagnostics.
130+
131+
Do not use `scansci-pdf` as a substitute for:
132+
133+
- study eligibility judgment;
134+
- risk-of-bias appraisal;
135+
- effect-size extraction quality control;
136+
- causal interpretation;
137+
- synthesis-model choice.
138+
139+
## Compliance and Risk Boundary
140+
141+
The project README lists multiple retrieval routes, including open-access sources, publisher links, WebVPN or CARSI access, and also routes such as Sci-Hub or LibGen.
142+
143+
Because of that, EvidenceForge should document a simple boundary:
144+
145+
- prefer open-access, publisher-authorized, institution-authorized, or otherwise legitimate access routes first;
146+
- treat legally or institutionally sensitive routes as a user-side decision, not an automatic default;
147+
- document the chosen retrieval strategy in the review ledger when reproducibility matters.
148+
149+
The project also documents a `legal_only` strategy. That is the cleanest default when a review needs a conservative retrieval policy.
150+
151+
## Useful Configuration Ideas
152+
153+
Examples from the project README:
154+
155+
- `download_strategy = legal_only` for conservative retrieval;
156+
- `output_dir` to keep a dedicated paper folder per review;
157+
- `batch_workers` for larger download jobs;
158+
- `vpnsci_enabled` or `carsi_enabled` when institution-authorized access is available.
159+
160+
## What To Store In Your Own Repositories
161+
162+
Keep these in your GitHub repositories:
163+
164+
- setup instructions;
165+
- MCP registration instructions;
166+
- recommended retrieval policies;
167+
- folder conventions for downloaded PDFs;
168+
- review-ledger notes explaining whether retrieval was OA-only, institution-assisted, or mixed.
169+
170+
Do not vendor the whole upstream project into EvidenceForge unless you have a specific maintenance reason. A thin integration document is cleaner and easier to keep current.
171+
172+
## Minimal Review Ledger Add-On
173+
174+
When `scansci-pdf` is used in a review project, record:
175+
176+
- search date;
177+
- search terms;
178+
- download strategy;
179+
- whether `.bib` import was used;
180+
- output folder;
181+
- access mode: OA-only, publisher-authorized, institution-authorized, or mixed;
182+
- unresolved missing PDFs.
183+
184+
## Source
185+
186+
- Upstream repository: https://github.com/Rimagination/scansci-pdf

0 commit comments

Comments
 (0)