janosh/diagrams · 上手攻略

  • 仓库:j anosh/diagrams
  • 链接:https://github.com/janosh/diagrams
  • 分类:学术 · 可视化 · LaTeX/TikZ
  • 作者:Jay
  • 更新:2026-09-06

这是什么

j anosh/diagrams 是一个开放的学术图表开源仓库,收集了大量物理、化学、机器学习等领域的概念示意图,以 LaTeX (TikZ)Typst 源码形式保存。每个图表配有一个 diagram.yml 元数据文件,仓库附带渲染脚本,可将 .tex / .typ 文件导出为 PDF / SVG / PNG 格式。

作者 Janosh Riebesell(及贡献者 Stefan Bringuier)于 2020 年创建,Zenodo DOI: 10.5281/zenodo.7486911。可通过 j anosh.github.io/diagrams 在线浏览、搜索、按主题/领域筛选,或直接点击"Open in Overleaf"编辑。

解决什么问题

  • 找现成的学术示意图:论文里要画 Attention 机制图、Bloch 球、卷积层示意图,直接从仓库里找,无需从零写 TikZ
  • 直接 Overleaf 导入:在线浏览时点"Open in Overleaf",立即在 Overleaf 中打开对应 .tex 文件,稍作修改即可用于自己的论文
  • 多格式导出:同一源码可导出 PDF(用于 LaTeX)/ SVG(用于网页)/ PNG(用于 PPT / Markdown)
  • 引用方便:提供标准化 CITATION.cff,Zenodo DOI,可直接引用整套图集合集
  • 贡献社区:有自己画的 TikZ / CeTZ 图?提交 PR,审核通过后合并进主仓库,全世界研究者都能用

快速安装(本地渲染图表)

克隆仓库

git clone https://github.com/janosh/diagrams.git
cd diagrams

目录结构

diagrams/
├── assets/              # 各主题子目录,含 .tex / .typ 源码 + metadata .yml
│   ├── 2d-convolution/
│   ├── autoencoder/
│   ├── bloch-sphere/
│   ├── transformer-attention/
│   └── ...(100+ 主题)
├── scripts/             # 渲染脚本(将 .tex / .typ 转为多格式)
└── CITATION.cff        # 标准引用格式

渲染依赖

LaTeX 图表(需要本地 LaTeX 环境):

# Ubuntu/Debian
sudo apt install texlive-latex-base texlive-pictures texlive-science

# macOS
brew install --cask mactex

Typst 图表(如果仓库中有 .typ 文件):

# 安装 Typst
# https://github.com/typst/typst/releases 或
cargo install typst

渲染所有图表

cd diagrams
./scripts/render.py        # 渲染所有 assets/ 下的图表
# 输出到 assets/<topic>/out/ 目录(PDF / SVG / PNG)

⚠️ 渲染前请确认:README 中说明渲染脚本位于 scripts/ 目录,如目录不存在可参考仓库最新文档。

核心用法

在线浏览(最简方式,无需安装)

访问 https://j anosh.github.io/diagrams,你可以:

功能 说明
搜索 按关键词搜索图表名称和描述
分类筛选 按物理/化学/ML 等领域过滤
Open in Overleaf 点击直接跳转到 Overleaf 在线编辑
下载 PDF / SVG / PNG 格式直接下载
预览 大图预览,鼠标滚轮缩放

在论文中使用某个图表

  1. j anosh.github.io/diagrams 找到需要的图
  2. 点击 Open in Overleaf → 在 Overleaf 中编辑 → 编译 PDF
  3. 或下载 .tex 源码文件,复制到自己的项目
  4. 记得在参考文献中引用:@software{riebesell_diagrams_2020, ...}(CITATION.cff 可直接导入 Zotero / BibTeX)

贡献自己的图表(Submit a PR)

1. fork 本仓库
2. 在 assets/ 下新建 <your-diagram>/ 目录
3. 放入 .tex 或 .typ 源码 + metadata .yml(主题/标签/描述)
4. 在 CITATION.cff 的 author 列表中添加你的名字
5. 提交 Pull Request

提交规范请参考仓库 CONTRIBUTING.md 或现有图表的元数据格式。

已知主题列表(部分)

主题 领域
2d-convolution ML / 信号处理
autoencoder ML / 深度学习
transformer-attention ML / NLP
bloch-sphere 量子物理
bose-einstein-distribution 统计物理
atomistic-gpu-batching 计算化学
ball-tree 算法 / 数据结构
branch-and-bound 优化算法
change-of-variables 数学 / 微积分
chain-homology 拓扑学

完整列表请访问 assets/ 目录

典型适用场景

  1. 写论文插图:直接复用 Attention 机制、Bloch 球、卷积图等,无需手画
  2. 制作 PPT / 幻灯片:导出 SVG/PNG 插入 slides
  3. 教学材料:从仓库找现成的物理/化学概念示意图
  4. Overleaf 快速上手:不熟悉 TikZ 语法?从 Overleaf 直接打开一个现成例子,边改边学
  5. 贡献社区:分享你自己画的学术图表,获取 DOI 引用

坑与注意

  1. ⚠️ 并非所有图表都支持 Typst:仓库以 TikZ(LaTeX)为主,部分新图可能仅有 .typ 格式,使用前请确认自己用的是 LaTeX 还是 Typst 工作流。
  2. 本地渲染需要完整 LaTeX 发行版:Ubuntu minimal install 可能缺 texlive-science 等包,导致某些图编译失败;推荐安装完整 texlive 或至少 texlive-pictures
  3. 图表许可:每个图表继承仓库的 Apache 2.0 许可,商用前请确认修改后的许可要求。
  4. Overleaf 兼容性:部分 Overleaf 模板可能缺少某些 TikZ 宏包,编译前需检查。
  5. GitHub Stars 更新:该仓库 Stars 约 684(数据来自 2026-09 工作队列),属于小型但精专的学术工具仓库,非大众产品。
  6. Zenodo DOI 版本:DOI 10.5281/zenodo.7486911 对应 v0.2.0;后续更新可能不在同一 DOI 下,引用时请注明版本。
  7. 在线图库功能有限:j anosh.github.io/diagrams 主要用于浏览和下载,不是交互式图表编辑器,无法在网页上实时修改图。

与同类对比

方案 类型 优点 缺点
j anosh/diagrams 学术图表开源库 100+ 精修图、Overleaf 直连、多格式导出 规模有限、更新频率较低
TikZ examples (texample.net) TikZ 示例集 规模更大、涵盖面广 无 Overleaf 直连、导出脚本不统一
Matplotlib / Plotly 通用图表库 灵活性高、程序化生成 学术示意图需要大量手动调整
draw.io / Excalidraw 在线图表工具 易于上手、实时协作 非 LaTeX 源码、不适合发表级论文
PGB/TikZ 官方文档 官方教程 完整权威 学习曲线陡、需要自己从零画

j anosh/diagrams 的核心价值在于:拿来到就能用,Overleaf 一键导入,学术发表级质量——而非从零学习 TikZ 语法。

一句话推荐结论

如果你写过学术论文、需要高质量的物理/化学/ML 概念示意图,j anosh/diagrams 值得收藏;通过 Overleaf 直接导入比自己从零画快一个数量级,适合论文作者、教学课件制作者和 TikZ 学习者。