SuperAPI AI 工具集

scientific-reproducible-reporting

写作与研究

查看项目

更新于 10-15 21:03

技能介绍

用途:提供可复现的科学报告与文档生成流水线,把代码、执行与文档化串成自动化流程。

主要能力:

  1. Quarto 科学文档模板生成,支持 html、pdf、docx、revealjs 等格式,含目录、章节编号、代码折叠与缓存等配置。
  2. Papermill 参数化执行,用多组参数自动重复运行同一模板笔记本,并汇总每次运行的成功或失败状态。
  3. Jupyter Book 多章项目生成,自动创建 _config.yml、_toc.yml 及各章 Markdown 模板。
  4. nbconvert 批量转换,可将目录下笔记本批量转为 html、pdf、markdown 或 script,并可选先执行再转换。
  5. 资料还提到 Sphinx-Gallery 代码示例文档,但未给出具体用法细节。

使用方式:调用相应函数生成项目或执行转换。Quarto 项目生成后按提示构建:cd <output_dir> && quarto render report.qmd;Jupyter Book 构建命令为 jupyter-book build <output_dir>;nbconvert 通过 jupyter nbconvert --to=<format> 调用,可加 --execute 与 --output-dir。

适用场景:需要可复现科学文档、多章书籍式文档、参数化批量分析、CI/CD 自动生成分析报告,以及用多组参数重复执行分析时。

限制:资料未说明依赖版本、安装步骤、平台支持、性能与收费信息;Sphinx-Gallery 部分仅提及名称,未提供实现细节。