@wentorai/research-plugins 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +204 -0
- package/curated/analysis/README.md +64 -0
- package/curated/domains/README.md +104 -0
- package/curated/literature/README.md +53 -0
- package/curated/research/README.md +62 -0
- package/curated/tools/README.md +87 -0
- package/curated/writing/README.md +61 -0
- package/index.ts +39 -0
- package/mcp-configs/academic-db/ChatSpatial.json +17 -0
- package/mcp-configs/academic-db/academia-mcp.json +17 -0
- package/mcp-configs/academic-db/academic-paper-explorer.json +17 -0
- package/mcp-configs/academic-db/academic-search-mcp-server.json +17 -0
- package/mcp-configs/academic-db/agentinterviews-mcp.json +17 -0
- package/mcp-configs/academic-db/all-in-mcp.json +17 -0
- package/mcp-configs/academic-db/apple-health-mcp.json +17 -0
- package/mcp-configs/academic-db/arxiv-latex-mcp.json +17 -0
- package/mcp-configs/academic-db/arxiv-mcp-server.json +17 -0
- package/mcp-configs/academic-db/bgpt-mcp.json +17 -0
- package/mcp-configs/academic-db/biomcp.json +17 -0
- package/mcp-configs/academic-db/biothings-mcp.json +17 -0
- package/mcp-configs/academic-db/catalysishub-mcp-server.json +17 -0
- package/mcp-configs/academic-db/clinicaltrialsgov-mcp-server.json +17 -0
- package/mcp-configs/academic-db/deep-research-mcp.json +17 -0
- package/mcp-configs/academic-db/dicom-mcp.json +17 -0
- package/mcp-configs/academic-db/enrichr-mcp-server.json +17 -0
- package/mcp-configs/academic-db/fec-mcp-server.json +17 -0
- package/mcp-configs/academic-db/fhir-mcp-server-themomentum.json +17 -0
- package/mcp-configs/academic-db/fhir-mcp.json +19 -0
- package/mcp-configs/academic-db/gget-mcp.json +17 -0
- package/mcp-configs/academic-db/google-researcher-mcp.json +17 -0
- package/mcp-configs/academic-db/idea-reality-mcp.json +17 -0
- package/mcp-configs/academic-db/legiscan-mcp.json +19 -0
- package/mcp-configs/academic-db/lex.json +17 -0
- package/mcp-configs/ai-platform/Adaptive-Graph-of-Thoughts-MCP-server.json +17 -0
- package/mcp-configs/ai-platform/ai-counsel.json +17 -0
- package/mcp-configs/ai-platform/atlas-mcp-server.json +17 -0
- package/mcp-configs/ai-platform/counsel-mcp.json +17 -0
- package/mcp-configs/ai-platform/cross-llm-mcp.json +17 -0
- package/mcp-configs/ai-platform/gptr-mcp.json +17 -0
- package/mcp-configs/browser/decipher-research-agent.json +17 -0
- package/mcp-configs/browser/deep-research.json +17 -0
- package/mcp-configs/browser/everything-claude-code.json +17 -0
- package/mcp-configs/browser/gpt-researcher.json +17 -0
- package/mcp-configs/browser/heurist-agent-framework.json +17 -0
- package/mcp-configs/data-platform/4everland-hosting-mcp.json +17 -0
- package/mcp-configs/data-platform/context-keeper.json +17 -0
- package/mcp-configs/data-platform/context7.json +19 -0
- package/mcp-configs/data-platform/contextstream-mcp.json +17 -0
- package/mcp-configs/data-platform/email-mcp.json +17 -0
- package/mcp-configs/note-knowledge/ApeRAG.json +17 -0
- package/mcp-configs/note-knowledge/In-Memoria.json +17 -0
- package/mcp-configs/note-knowledge/agent-memory.json +17 -0
- package/mcp-configs/note-knowledge/aimemo.json +17 -0
- package/mcp-configs/note-knowledge/biel-mcp.json +19 -0
- package/mcp-configs/note-knowledge/cognee.json +17 -0
- package/mcp-configs/note-knowledge/context-awesome.json +17 -0
- package/mcp-configs/note-knowledge/context-mcp.json +17 -0
- package/mcp-configs/note-knowledge/conversation-handoff-mcp.json +17 -0
- package/mcp-configs/note-knowledge/cortex.json +17 -0
- package/mcp-configs/note-knowledge/devrag.json +17 -0
- package/mcp-configs/note-knowledge/easy-obsidian-mcp.json +17 -0
- package/mcp-configs/note-knowledge/engram.json +17 -0
- package/mcp-configs/note-knowledge/gnosis-mcp.json +17 -0
- package/mcp-configs/note-knowledge/graphlit-mcp-server.json +19 -0
- package/mcp-configs/reference-mgr/arxiv-cli.json +17 -0
- package/mcp-configs/reference-mgr/arxiv-search-mcp.json +17 -0
- package/mcp-configs/reference-mgr/chiken.json +17 -0
- package/mcp-configs/reference-mgr/claude-scholar.json +17 -0
- package/mcp-configs/reference-mgr/devonthink-mcp.json +17 -0
- package/mcp-configs/registry.json +447 -0
- package/openclaw.plugin.json +21 -0
- package/package.json +61 -0
- package/skills/analysis/dataviz/color-accessibility-guide/SKILL.md +230 -0
- package/skills/analysis/dataviz/geospatial-viz-guide/SKILL.md +218 -0
- package/skills/analysis/dataviz/interactive-viz-guide/SKILL.md +287 -0
- package/skills/analysis/dataviz/network-visualization-guide/SKILL.md +195 -0
- package/skills/analysis/dataviz/publication-figures-guide/SKILL.md +238 -0
- package/skills/analysis/dataviz/python-dataviz-guide/SKILL.md +195 -0
- package/skills/analysis/econometrics/causal-inference-guide/SKILL.md +197 -0
- package/skills/analysis/econometrics/iv-regression-guide/SKILL.md +198 -0
- package/skills/analysis/econometrics/panel-data-guide/SKILL.md +274 -0
- package/skills/analysis/econometrics/robustness-checks/SKILL.md +250 -0
- package/skills/analysis/econometrics/stata-regression/SKILL.md +117 -0
- package/skills/analysis/econometrics/time-series-guide/SKILL.md +235 -0
- package/skills/analysis/statistics/bayesian-statistics-guide/SKILL.md +221 -0
- package/skills/analysis/statistics/hypothesis-testing-guide/SKILL.md +210 -0
- package/skills/analysis/statistics/meta-analysis-guide/SKILL.md +206 -0
- package/skills/analysis/statistics/nonparametric-tests-guide/SKILL.md +221 -0
- package/skills/analysis/statistics/power-analysis-guide/SKILL.md +240 -0
- package/skills/analysis/statistics/sem-guide/SKILL.md +231 -0
- package/skills/analysis/statistics/survival-analysis-guide/SKILL.md +195 -0
- package/skills/analysis/wrangling/missing-data-handling/SKILL.md +224 -0
- package/skills/analysis/wrangling/pandas-data-wrangling/SKILL.md +242 -0
- package/skills/analysis/wrangling/questionnaire-design-guide/SKILL.md +234 -0
- package/skills/analysis/wrangling/text-mining-guide/SKILL.md +225 -0
- package/skills/domains/ai-ml/computer-vision-guide/SKILL.md +213 -0
- package/skills/domains/ai-ml/deep-learning-papers-guide/SKILL.md +200 -0
- package/skills/domains/ai-ml/llm-evaluation-guide/SKILL.md +194 -0
- package/skills/domains/ai-ml/prompt-engineering-research/SKILL.md +233 -0
- package/skills/domains/ai-ml/reinforcement-learning-guide/SKILL.md +254 -0
- package/skills/domains/ai-ml/transformer-architecture-guide/SKILL.md +233 -0
- package/skills/domains/biomedical/clinical-research-guide/SKILL.md +232 -0
- package/skills/domains/biomedical/clinicaltrials-api/SKILL.md +177 -0
- package/skills/domains/biomedical/epidemiology-guide/SKILL.md +200 -0
- package/skills/domains/biomedical/genomics-analysis-guide/SKILL.md +270 -0
- package/skills/domains/business/market-analysis-guide/SKILL.md +112 -0
- package/skills/domains/business/strategic-management-guide/SKILL.md +154 -0
- package/skills/domains/chemistry/computational-chemistry-guide/SKILL.md +266 -0
- package/skills/domains/chemistry/retrosynthesis-guide/SKILL.md +215 -0
- package/skills/domains/cs/algorithms-complexity-guide/SKILL.md +194 -0
- package/skills/domains/cs/dblp-api/SKILL.md +129 -0
- package/skills/domains/cs/software-engineering-research/SKILL.md +218 -0
- package/skills/domains/ecology/biodiversity-data-guide/SKILL.md +296 -0
- package/skills/domains/ecology/conservation-biology-guide/SKILL.md +198 -0
- package/skills/domains/ecology/gbif-api/SKILL.md +158 -0
- package/skills/domains/ecology/inaturalist-api/SKILL.md +173 -0
- package/skills/domains/economics/behavioral-economics-guide/SKILL.md +239 -0
- package/skills/domains/economics/development-economics-guide/SKILL.md +181 -0
- package/skills/domains/economics/fred-api/SKILL.md +189 -0
- package/skills/domains/education/curriculum-design-guide/SKILL.md +144 -0
- package/skills/domains/education/learning-science-guide/SKILL.md +150 -0
- package/skills/domains/finance/financial-data-analysis/SKILL.md +152 -0
- package/skills/domains/finance/quantitative-finance-guide/SKILL.md +151 -0
- package/skills/domains/geoscience/climate-science-guide/SKILL.md +158 -0
- package/skills/domains/geoscience/gis-remote-sensing-guide/SKILL.md +129 -0
- package/skills/domains/humanities/digital-humanities-guide/SKILL.md +181 -0
- package/skills/domains/humanities/philosophy-research-guide/SKILL.md +148 -0
- package/skills/domains/law/courtlistener-api/SKILL.md +213 -0
- package/skills/domains/law/legal-research-guide/SKILL.md +250 -0
- package/skills/domains/math/linear-algebra-applications/SKILL.md +227 -0
- package/skills/domains/math/numerical-methods-guide/SKILL.md +236 -0
- package/skills/domains/math/oeis-api/SKILL.md +158 -0
- package/skills/domains/pharma/clinical-pharmacology-guide/SKILL.md +165 -0
- package/skills/domains/pharma/drug-development-guide/SKILL.md +177 -0
- package/skills/domains/physics/computational-physics-guide/SKILL.md +300 -0
- package/skills/domains/physics/nasa-ads-api/SKILL.md +150 -0
- package/skills/domains/physics/quantum-computing-guide/SKILL.md +234 -0
- package/skills/domains/social-science/social-research-methods/SKILL.md +194 -0
- package/skills/domains/social-science/survey-research-guide/SKILL.md +182 -0
- package/skills/literature/discovery/citation-alert-guide/SKILL.md +154 -0
- package/skills/literature/discovery/conference-proceedings-guide/SKILL.md +142 -0
- package/skills/literature/discovery/literature-mapping-guide/SKILL.md +175 -0
- package/skills/literature/discovery/paper-tracking-guide/SKILL.md +211 -0
- package/skills/literature/discovery/rss-paper-feeds/SKILL.md +214 -0
- package/skills/literature/discovery/semantic-scholar-recs-guide/SKILL.md +164 -0
- package/skills/literature/fulltext/doaj-api/SKILL.md +120 -0
- package/skills/literature/fulltext/interlibrary-loan-guide/SKILL.md +163 -0
- package/skills/literature/fulltext/open-access-guide/SKILL.md +183 -0
- package/skills/literature/fulltext/pmc-oai-api/SKILL.md +184 -0
- package/skills/literature/fulltext/preprint-servers-guide/SKILL.md +128 -0
- package/skills/literature/fulltext/repository-harvesting-guide/SKILL.md +207 -0
- package/skills/literature/fulltext/unpaywall-api/SKILL.md +113 -0
- package/skills/literature/metadata/altmetrics-guide/SKILL.md +132 -0
- package/skills/literature/metadata/citation-network-guide/SKILL.md +236 -0
- package/skills/literature/metadata/crossref-api/SKILL.md +133 -0
- package/skills/literature/metadata/datacite-api/SKILL.md +126 -0
- package/skills/literature/metadata/doi-resolution-guide/SKILL.md +168 -0
- package/skills/literature/metadata/h-index-guide/SKILL.md +183 -0
- package/skills/literature/metadata/journal-metrics-guide/SKILL.md +188 -0
- package/skills/literature/metadata/opencitations-api/SKILL.md +128 -0
- package/skills/literature/metadata/orcid-api/SKILL.md +136 -0
- package/skills/literature/metadata/orcid-integration-guide/SKILL.md +178 -0
- package/skills/literature/search/arxiv-api/SKILL.md +95 -0
- package/skills/literature/search/biorxiv-api/SKILL.md +123 -0
- package/skills/literature/search/boolean-search-guide/SKILL.md +199 -0
- package/skills/literature/search/citation-chaining-guide/SKILL.md +148 -0
- package/skills/literature/search/database-comparison-guide/SKILL.md +100 -0
- package/skills/literature/search/europe-pmc-api/SKILL.md +120 -0
- package/skills/literature/search/google-scholar-guide/SKILL.md +182 -0
- package/skills/literature/search/mesh-terms-guide/SKILL.md +164 -0
- package/skills/literature/search/openalex-api/SKILL.md +134 -0
- package/skills/literature/search/pubmed-api/SKILL.md +130 -0
- package/skills/literature/search/scientify-literature-survey/SKILL.md +203 -0
- package/skills/literature/search/semantic-scholar-api/SKILL.md +134 -0
- package/skills/literature/search/systematic-search-strategy/SKILL.md +214 -0
- package/skills/research/automation/ai-scientist-guide/SKILL.md +228 -0
- package/skills/research/automation/data-collection-automation/SKILL.md +248 -0
- package/skills/research/automation/research-workflow-automation/SKILL.md +266 -0
- package/skills/research/deep-research/meta-synthesis-guide/SKILL.md +174 -0
- package/skills/research/deep-research/research-cog/SKILL.md +153 -0
- package/skills/research/deep-research/scoping-review-guide/SKILL.md +217 -0
- package/skills/research/deep-research/systematic-review-guide/SKILL.md +250 -0
- package/skills/research/funding/figshare-api/SKILL.md +163 -0
- package/skills/research/funding/grant-writing-guide/SKILL.md +233 -0
- package/skills/research/funding/nsf-grant-guide/SKILL.md +206 -0
- package/skills/research/funding/open-science-guide/SKILL.md +255 -0
- package/skills/research/funding/zenodo-api/SKILL.md +174 -0
- package/skills/research/methodology/action-research-guide/SKILL.md +201 -0
- package/skills/research/methodology/experimental-design-guide/SKILL.md +236 -0
- package/skills/research/methodology/grad-school-guide/SKILL.md +182 -0
- package/skills/research/methodology/grounded-theory-guide/SKILL.md +171 -0
- package/skills/research/methodology/mixed-methods-guide/SKILL.md +208 -0
- package/skills/research/methodology/qualitative-research-guide/SKILL.md +234 -0
- package/skills/research/methodology/scientify-idea-generation/SKILL.md +222 -0
- package/skills/research/paper-review/paper-reading-assistant/SKILL.md +266 -0
- package/skills/research/paper-review/peer-review-guide/SKILL.md +227 -0
- package/skills/research/paper-review/rebuttal-writing-guide/SKILL.md +185 -0
- package/skills/research/paper-review/scientify-write-review-paper/SKILL.md +209 -0
- package/skills/tools/code-exec/jupyter-notebook-guide/SKILL.md +178 -0
- package/skills/tools/code-exec/python-reproducibility-guide/SKILL.md +341 -0
- package/skills/tools/code-exec/r-reproducibility-guide/SKILL.md +236 -0
- package/skills/tools/code-exec/sandbox-execution-guide/SKILL.md +221 -0
- package/skills/tools/diagram/mermaid-diagram-guide/SKILL.md +269 -0
- package/skills/tools/diagram/plantuml-guide/SKILL.md +397 -0
- package/skills/tools/diagram/scientific-illustration-guide/SKILL.md +225 -0
- package/skills/tools/document/anystyle-api/SKILL.md +199 -0
- package/skills/tools/document/grobid-pdf-parsing/SKILL.md +294 -0
- package/skills/tools/document/markdown-academic-guide/SKILL.md +217 -0
- package/skills/tools/document/pdf-extraction-guide/SKILL.md +321 -0
- package/skills/tools/knowledge-graph/knowledge-graph-construction/SKILL.md +306 -0
- package/skills/tools/knowledge-graph/ontology-design-guide/SKILL.md +214 -0
- package/skills/tools/knowledge-graph/rag-methodology-guide/SKILL.md +325 -0
- package/skills/tools/ocr-translate/formula-recognition-guide/SKILL.md +367 -0
- package/skills/tools/ocr-translate/handwriting-recognition-guide/SKILL.md +211 -0
- package/skills/tools/ocr-translate/latex-ocr-guide/SKILL.md +204 -0
- package/skills/tools/ocr-translate/multilingual-research-guide/SKILL.md +234 -0
- package/skills/tools/scraping/academic-web-scraping/SKILL.md +326 -0
- package/skills/tools/scraping/api-data-collection-guide/SKILL.md +301 -0
- package/skills/tools/scraping/web-scraping-ethics-guide/SKILL.md +250 -0
- package/skills/writing/citation/bibtex-management-guide/SKILL.md +246 -0
- package/skills/writing/citation/citation-style-guide/SKILL.md +248 -0
- package/skills/writing/citation/reference-manager-comparison/SKILL.md +208 -0
- package/skills/writing/citation/zotero-api/SKILL.md +188 -0
- package/skills/writing/composition/abstract-writing-guide/SKILL.md +188 -0
- package/skills/writing/composition/discussion-writing-guide/SKILL.md +194 -0
- package/skills/writing/composition/introduction-writing-guide/SKILL.md +194 -0
- package/skills/writing/composition/literature-review-writing/SKILL.md +196 -0
- package/skills/writing/composition/methods-section-guide/SKILL.md +185 -0
- package/skills/writing/composition/response-to-reviewers/SKILL.md +215 -0
- package/skills/writing/composition/scientific-writing-guide/SKILL.md +152 -0
- package/skills/writing/latex/bibliography-management-guide/SKILL.md +206 -0
- package/skills/writing/latex/latex-drawing-guide/SKILL.md +234 -0
- package/skills/writing/latex/latex-ecosystem-guide/SKILL.md +240 -0
- package/skills/writing/latex/math-typesetting-guide/SKILL.md +231 -0
- package/skills/writing/latex/overleaf-collaboration-guide/SKILL.md +211 -0
- package/skills/writing/latex/tikz-diagrams-guide/SKILL.md +211 -0
- package/skills/writing/polish/academic-translation-guide/SKILL.md +175 -0
- package/skills/writing/polish/academic-writing-refiner/SKILL.md +143 -0
- package/skills/writing/polish/ai-writing-humanizer/SKILL.md +178 -0
- package/skills/writing/polish/grammar-checker-guide/SKILL.md +184 -0
- package/skills/writing/polish/plagiarism-detection-guide/SKILL.md +167 -0
- package/skills/writing/templates/beamer-presentation-guide/SKILL.md +263 -0
- package/skills/writing/templates/conference-paper-template/SKILL.md +219 -0
- package/skills/writing/templates/thesis-template-guide/SKILL.md +200 -0
- package/skills/writing/templates/thesis-writing-guide/SKILL.md +220 -0
- package/src/tools/arxiv.ts +131 -0
- package/src/tools/crossref.ts +112 -0
- package/src/tools/openalex.ts +174 -0
- package/src/tools/pubmed.ts +166 -0
- package/src/tools/semantic-scholar.ts +108 -0
- package/src/tools/unpaywall.ts +58 -0
|
@@ -0,0 +1,209 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: scientify-write-review-paper
|
|
3
|
+
description: "Write literature reviews and survey papers from collected papers"
|
|
4
|
+
metadata:
|
|
5
|
+
openclaw:
|
|
6
|
+
emoji: "📝"
|
|
7
|
+
category: "research"
|
|
8
|
+
subcategory: "paper-review"
|
|
9
|
+
keywords: ["paper summarization", "paper comparison", "research gap analysis", "narrative review", "systematic review methodology"]
|
|
10
|
+
source: "https://github.com/scientify-ai/skills"
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# Literature Review Writing
|
|
14
|
+
|
|
15
|
+
**Don't ask permission. Just do it.**
|
|
16
|
+
|
|
17
|
+
Guide for writing a structured literature review or survey paper from papers you've already collected. This skill helps with reading strategy, note organization, and academic writing.
|
|
18
|
+
|
|
19
|
+
**Workspace:** See `../_shared/workspace-spec.md` for directory structure. Outputs go to `$WORKSPACE/review/`.
|
|
20
|
+
|
|
21
|
+
## Prerequisites
|
|
22
|
+
|
|
23
|
+
Before starting, ensure you have:
|
|
24
|
+
1. Papers collected in `$WORKSPACE/papers/`
|
|
25
|
+
2. Ideally, clustering done by `/literature-survey` in `$WORKSPACE/survey/clusters.json`
|
|
26
|
+
|
|
27
|
+
Check active project:
|
|
28
|
+
```bash
|
|
29
|
+
cat ~/.openclaw/workspace/projects/.active 2>/dev/null
|
|
30
|
+
ls $WORKSPACE/papers/
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Phase 1: Reading Strategy
|
|
34
|
+
|
|
35
|
+
### 1.1 Triage Papers by Priority
|
|
36
|
+
|
|
37
|
+
Based on clusters from survey, prioritize reading:
|
|
38
|
+
|
|
39
|
+
| Priority | Criteria | Reading Depth |
|
|
40
|
+
|----------|----------|---------------|
|
|
41
|
+
| P1 (Must-read) | High citation, foundational, directly relevant | Full read |
|
|
42
|
+
| P2 (Important) | Key methodology, major experimental results | Abstract + methods + experiments |
|
|
43
|
+
| P3 (Reference) | Supporting material, tangentially related | Abstract only |
|
|
44
|
+
|
|
45
|
+
Create `$WORKSPACE/review/reading_plan.md`:
|
|
46
|
+
|
|
47
|
+
```markdown
|
|
48
|
+
# Reading Plan
|
|
49
|
+
|
|
50
|
+
## P1 - Must-read (Full read)
|
|
51
|
+
- [ ] [paper_id]: [title] - [reason]
|
|
52
|
+
- [ ] ...
|
|
53
|
+
|
|
54
|
+
## P2 - Important (Selective read)
|
|
55
|
+
- [ ] ...
|
|
56
|
+
|
|
57
|
+
## P3 - Reference (Skim)
|
|
58
|
+
- [ ] ...
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### 1.2 Reading Notes Template
|
|
62
|
+
|
|
63
|
+
For each paper, create `$WORKSPACE/review/notes/{paper_id}.md` using template in `references/note-template.md`.
|
|
64
|
+
|
|
65
|
+
## Phase 2: Synthesis & Organization
|
|
66
|
+
|
|
67
|
+
### 2.1 Build Comparison Table
|
|
68
|
+
|
|
69
|
+
Create `$WORKSPACE/review/comparison.md`:
|
|
70
|
+
|
|
71
|
+
```markdown
|
|
72
|
+
# Method Comparison
|
|
73
|
+
|
|
74
|
+
| Paper | Year | Category | Key Innovation | Dataset | Metric | Result |
|
|
75
|
+
|-------|------|----------|----------------|---------|--------|--------|
|
|
76
|
+
| [A] | 2023 | Data-driven | ... | ... | RMSE | 0.05 |
|
|
77
|
+
| [B] | 2022 | Hybrid | ... | ... | RMSE | 0.08 |
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### 2.2 Timeline Analysis
|
|
81
|
+
|
|
82
|
+
Create `$WORKSPACE/review/timeline.md`:
|
|
83
|
+
|
|
84
|
+
```markdown
|
|
85
|
+
# Research Timeline
|
|
86
|
+
|
|
87
|
+
## 2018-2019: Early Exploration
|
|
88
|
+
- [Paper A]: First proposal of method X
|
|
89
|
+
- [Paper B]: Introduction of technique Y
|
|
90
|
+
|
|
91
|
+
## 2020-2021: Method Maturation
|
|
92
|
+
- [Paper C]: Proposed SOTA method
|
|
93
|
+
- ...
|
|
94
|
+
|
|
95
|
+
## 2022-2023: New Trends
|
|
96
|
+
- [Paper D]: Began addressing problem Z
|
|
97
|
+
- ...
|
|
98
|
+
|
|
99
|
+
## Key Milestones
|
|
100
|
+
1. [Year]: [Event/Paper] - [Significance]
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### 2.3 Taxonomy Design
|
|
104
|
+
|
|
105
|
+
Create `$WORKSPACE/review/taxonomy.md`:
|
|
106
|
+
|
|
107
|
+
```markdown
|
|
108
|
+
# Taxonomy of Approaches
|
|
109
|
+
|
|
110
|
+
## Dimension 1: Method Type
|
|
111
|
+
- Data-driven
|
|
112
|
+
- Statistical (e.g., GPR, SVM)
|
|
113
|
+
- Deep Learning
|
|
114
|
+
- CNN-based
|
|
115
|
+
- RNN/LSTM-based
|
|
116
|
+
- Transformer-based
|
|
117
|
+
- Hybrid
|
|
118
|
+
- Model-based
|
|
119
|
+
- Electrochemical
|
|
120
|
+
- Equivalent Circuit
|
|
121
|
+
|
|
122
|
+
## Dimension 2: Data Source
|
|
123
|
+
- Laboratory Data
|
|
124
|
+
- Real-world Driving Data
|
|
125
|
+
- Synthetic Data
|
|
126
|
+
|
|
127
|
+
## Dimension 3: Prediction Horizon
|
|
128
|
+
- Short-term (< 100 cycles)
|
|
129
|
+
- Medium-term (100-500 cycles)
|
|
130
|
+
- Long-term (> 500 cycles)
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
## Phase 3: Writing Structure
|
|
134
|
+
|
|
135
|
+
### 3.1 Survey Paper Template
|
|
136
|
+
|
|
137
|
+
Create `$WORKSPACE/review/draft.md` using template in `references/survey-template.md`.
|
|
138
|
+
|
|
139
|
+
Key sections: Abstract -> Introduction -> Background -> Taxonomy -> Comparison -> Datasets -> Future Directions -> Conclusion
|
|
140
|
+
|
|
141
|
+
### 3.2 Thesis Literature Review Template
|
|
142
|
+
|
|
143
|
+
For a thesis chapter:
|
|
144
|
+
```markdown
|
|
145
|
+
# Chapter 2: Literature Review
|
|
146
|
+
## 2.1 Introduction
|
|
147
|
+
## 2.2 [Topic Area 1]
|
|
148
|
+
## 2.3 [Topic Area 2]
|
|
149
|
+
## 2.4 Summary and Research Gaps
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
## Phase 4: Writing Tips
|
|
153
|
+
|
|
154
|
+
### Citation Density Guidelines
|
|
155
|
+
|
|
156
|
+
| Section | Citation Density |
|
|
157
|
+
|---------|------------------|
|
|
158
|
+
| Abstract | 0 citations |
|
|
159
|
+
| Introduction | 10-20 citations |
|
|
160
|
+
| Background | 5-10 citations |
|
|
161
|
+
| Main Survey | 50-100+ citations |
|
|
162
|
+
| Conclusion | 2-5 citations |
|
|
163
|
+
|
|
164
|
+
### Transition Phrases
|
|
165
|
+
|
|
166
|
+
**Introducing similar work:**
|
|
167
|
+
- "Similarly, [Author] proposed..."
|
|
168
|
+
- "Following this direction, ..."
|
|
169
|
+
- "Building upon [X], [Author] extended..."
|
|
170
|
+
|
|
171
|
+
**Introducing contrasting work:**
|
|
172
|
+
- "In contrast, [Author] argued..."
|
|
173
|
+
- "However, [Author] took a different approach..."
|
|
174
|
+
- "Unlike previous methods, ..."
|
|
175
|
+
|
|
176
|
+
**Summarizing:**
|
|
177
|
+
- "In summary, existing methods can be categorized into..."
|
|
178
|
+
- "The key insight from these works is..."
|
|
179
|
+
|
|
180
|
+
### Common Mistakes to Avoid
|
|
181
|
+
|
|
182
|
+
1. **List-style writing** - Don't just say "A did X, B did Y, C did Z"
|
|
183
|
+
2. **Lack of comparison** - Analyze relationships and differences between methods
|
|
184
|
+
3. **Tense confusion** - Use present tense for methods, past tense for results
|
|
185
|
+
4. **Over-citing** - Not every sentence needs a citation
|
|
186
|
+
5. **Missing important work** - Ensure coverage of foundational works in the field
|
|
187
|
+
|
|
188
|
+
## Output Files
|
|
189
|
+
|
|
190
|
+
```
|
|
191
|
+
$WORKSPACE/review/
|
|
192
|
+
├── reading_plan.md # Reading plan
|
|
193
|
+
├── notes/ # Reading notes
|
|
194
|
+
│ ├── {paper_id}.md
|
|
195
|
+
│ └── ...
|
|
196
|
+
├── comparison.md # Comparison table
|
|
197
|
+
├── timeline.md # Timeline analysis
|
|
198
|
+
├── taxonomy.md # Taxonomy
|
|
199
|
+
├── draft.md # Review draft
|
|
200
|
+
└── bibliography.bib # References
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
## Commands
|
|
204
|
+
|
|
205
|
+
- "Help me write a review" -> Full workflow from reading to writing
|
|
206
|
+
- "Generate reading plan" -> Create reading_plan.md
|
|
207
|
+
- "Compare these papers" -> Generate comparison.md
|
|
208
|
+
- "Write review draft" -> Generate draft.md
|
|
209
|
+
- "Polish this section" -> Polish specific section
|
|
@@ -0,0 +1,178 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: jupyter-notebook-guide
|
|
3
|
+
description: "Best practices for computational research notebooks with reproducible workflows"
|
|
4
|
+
metadata:
|
|
5
|
+
openclaw:
|
|
6
|
+
emoji: "notebook"
|
|
7
|
+
category: "tools"
|
|
8
|
+
subcategory: "code-exec"
|
|
9
|
+
keywords: ["sandbox execution", "code runner", "Jupyter notebook", "computational notebook", "reproducible research"]
|
|
10
|
+
source: "wentor"
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# Jupyter Notebook Guide
|
|
14
|
+
|
|
15
|
+
A skill for using Jupyter notebooks effectively in research contexts. Covers notebook organization, reproducibility best practices, collaboration workflows, and integration with research computing infrastructure.
|
|
16
|
+
|
|
17
|
+
## Notebook Organization
|
|
18
|
+
|
|
19
|
+
### Recommended Structure
|
|
20
|
+
|
|
21
|
+
Every research notebook should follow a consistent structure:
|
|
22
|
+
|
|
23
|
+
```
|
|
24
|
+
01_data_collection.ipynb # Data acquisition and initial storage
|
|
25
|
+
02_data_cleaning.ipynb # Preprocessing, validation, transformations
|
|
26
|
+
03_exploratory_analysis.ipynb # EDA, descriptive statistics, initial plots
|
|
27
|
+
04_modeling.ipynb # Model training, evaluation, selection
|
|
28
|
+
05_results_visualization.ipynb # Publication-quality figures
|
|
29
|
+
06_supplementary.ipynb # Additional analyses, robustness checks
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
### Cell Organization Within a Notebook
|
|
33
|
+
|
|
34
|
+
```python
|
|
35
|
+
# === CELL 1: Header and metadata ===
|
|
36
|
+
"""
|
|
37
|
+
# Analysis: Effect of Treatment on Outcome Variable
|
|
38
|
+
Author: [Name]
|
|
39
|
+
Date: 2026-03-09
|
|
40
|
+
Data: experiment_results_v2.csv
|
|
41
|
+
Dependencies: pandas>=2.0, scipy>=1.11, matplotlib>=3.8
|
|
42
|
+
"""
|
|
43
|
+
|
|
44
|
+
# === CELL 2: Imports and configuration ===
|
|
45
|
+
import pandas as pd
|
|
46
|
+
import numpy as np
|
|
47
|
+
import matplotlib.pyplot as plt
|
|
48
|
+
from scipy import stats
|
|
49
|
+
|
|
50
|
+
# Reproducibility
|
|
51
|
+
np.random.seed(42)
|
|
52
|
+
pd.set_option('display.max_columns', 50)
|
|
53
|
+
plt.rcParams.update({
|
|
54
|
+
'figure.figsize': (10, 6),
|
|
55
|
+
'figure.dpi': 150,
|
|
56
|
+
'font.size': 12,
|
|
57
|
+
'axes.titlesize': 14,
|
|
58
|
+
'savefig.dpi': 300,
|
|
59
|
+
'savefig.bbox': 'tight'
|
|
60
|
+
})
|
|
61
|
+
|
|
62
|
+
# === CELL 3: Data loading ===
|
|
63
|
+
DATA_PATH = '../data/raw/experiment_results_v2.csv'
|
|
64
|
+
df = pd.read_csv(DATA_PATH)
|
|
65
|
+
print(f"Loaded {len(df)} rows, {len(df.columns)} columns")
|
|
66
|
+
df.head()
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## Reproducibility Best Practices
|
|
70
|
+
|
|
71
|
+
### Environment Management
|
|
72
|
+
|
|
73
|
+
Always pin your dependencies:
|
|
74
|
+
|
|
75
|
+
```bash
|
|
76
|
+
# Create environment from scratch
|
|
77
|
+
conda create -n research python=3.11
|
|
78
|
+
conda activate research
|
|
79
|
+
|
|
80
|
+
# Install and pin
|
|
81
|
+
pip install pandas==2.1.4 scipy==1.11.4 matplotlib==3.8.2 jupyterlab==4.0.9
|
|
82
|
+
|
|
83
|
+
# Export for reproducibility
|
|
84
|
+
pip freeze > requirements.txt
|
|
85
|
+
|
|
86
|
+
# Or use conda
|
|
87
|
+
conda env export --no-builds > environment.yml
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### Kernel and Execution Order
|
|
91
|
+
|
|
92
|
+
```python
|
|
93
|
+
# Add this cell at the top of every notebook to catch execution order issues
|
|
94
|
+
import IPython
|
|
95
|
+
print(f"Python: {IPython.sys.version}")
|
|
96
|
+
print(f"IPython: {IPython.__version__}")
|
|
97
|
+
print(f"Working directory: {os.getcwd()}")
|
|
98
|
+
|
|
99
|
+
# Run all cells from top to bottom before sharing
|
|
100
|
+
# Menu: Kernel -> Restart & Run All
|
|
101
|
+
# This verifies the notebook executes cleanly in order
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### Parameterized Notebooks
|
|
105
|
+
|
|
106
|
+
Use `papermill` for parameterized execution:
|
|
107
|
+
|
|
108
|
+
```python
|
|
109
|
+
# Parameters cell (tag with "parameters" in cell metadata)
|
|
110
|
+
input_file = "data/experiment_001.csv"
|
|
111
|
+
alpha = 0.05
|
|
112
|
+
n_bootstrap = 1000
|
|
113
|
+
output_dir = "results/experiment_001"
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
```bash
|
|
117
|
+
# Execute with different parameters
|
|
118
|
+
papermill 04_modeling.ipynb output/run_001.ipynb \
|
|
119
|
+
-p input_file "data/experiment_001.csv" \
|
|
120
|
+
-p alpha 0.01 \
|
|
121
|
+
-p n_bootstrap 5000
|
|
122
|
+
|
|
123
|
+
# Batch execution
|
|
124
|
+
for i in $(seq 1 10); do
|
|
125
|
+
papermill 04_modeling.ipynb "output/run_${i}.ipynb" \
|
|
126
|
+
-p input_file "data/experiment_${i}.csv"
|
|
127
|
+
done
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
## JupyterLab Extensions for Research
|
|
131
|
+
|
|
132
|
+
| Extension | Purpose | Install |
|
|
133
|
+
|-----------|---------|---------|
|
|
134
|
+
| jupyterlab-git | Version control integration | `pip install jupyterlab-git` |
|
|
135
|
+
| jupyterlab-lsp | Code intelligence (autocomplete) | `pip install jupyterlab-lsp` |
|
|
136
|
+
| nbdime | Notebook diffing and merging | `pip install nbdime` |
|
|
137
|
+
| jupytext | Pair notebooks with .py scripts | `pip install jupytext` |
|
|
138
|
+
| jupyter-book | Convert notebooks to publications | `pip install jupyter-book` |
|
|
139
|
+
|
|
140
|
+
## Version Control for Notebooks
|
|
141
|
+
|
|
142
|
+
Jupyter notebooks contain output cells, which create noisy diffs. Solutions:
|
|
143
|
+
|
|
144
|
+
```bash
|
|
145
|
+
# Option 1: Strip outputs before committing
|
|
146
|
+
pip install nbstripout
|
|
147
|
+
nbstripout --install # adds git filter
|
|
148
|
+
|
|
149
|
+
# Option 2: Use jupytext to maintain .py mirrors
|
|
150
|
+
jupytext --set-formats ipynb,py:percent notebook.ipynb
|
|
151
|
+
# Now edit the .py file and sync: jupytext --sync notebook.ipynb
|
|
152
|
+
|
|
153
|
+
# Option 3: Use nbdime for meaningful diffs
|
|
154
|
+
nbdime config-git --enable --global
|
|
155
|
+
git diff notebook.ipynb # now shows structured diff
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
## Remote Computing Integration
|
|
159
|
+
|
|
160
|
+
### Connecting to HPC Clusters
|
|
161
|
+
|
|
162
|
+
```bash
|
|
163
|
+
# SSH tunnel to remote Jupyter server
|
|
164
|
+
ssh -N -L 8888:localhost:8888 user@cluster.university.edu
|
|
165
|
+
|
|
166
|
+
# On the cluster:
|
|
167
|
+
jupyter lab --no-browser --port=8888
|
|
168
|
+
|
|
169
|
+
# Then open http://localhost:8888 in your local browser
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
### Google Colab Integration
|
|
173
|
+
|
|
174
|
+
For quick sharing and GPU access, export notebooks to Colab format. Add a Colab badge to your repository README for one-click access. Remember that Colab environments are ephemeral -- always save results to Google Drive or download locally.
|
|
175
|
+
|
|
176
|
+
## Converting to Publications
|
|
177
|
+
|
|
178
|
+
Use `jupyter-book` or `nbconvert` to transform notebooks into LaTeX, HTML, or PDF outputs suitable for supplementary materials in journal submissions. Always run the full notebook from a clean kernel before conversion to ensure all outputs are current and reproducible.
|