跳转到主要内容

从一个或多个Jupyter笔记本创建和编辑科学报告的流程

项目描述

IPyPublish

一个用于从一个或多个Jupyter笔记本创建和编辑科学报告和演示文稿的程序。

文档: ipypublish.readthedocs.io

CI Status Coverage Status PyPI DOI Conda Code Style

注意:v0.7.0 中发生了重大的API改进。这并没有改变用户界面,但使用自定义转换插件的任何人需要更新它们(请参阅 插件转换

Conversion Process

有关潜在输入/输出的示例,请参阅: Example.ipynbExample.pdfExample.htmlExample.slides.html

或者,为了展示ipypublish功能的一个实际示例,请参阅这些关于原子3D可视化的文档:笔记本PDFHTMLReveal.JS幻灯片演示

设计理念

本质上,梦想是拥有Jupyter Notebook、所见即所得编辑器(例如MS Word)和文档准备系统(例如TexMaker)的终极混合体,能够

  • 动态(并可重复)地探索数据、运行代码并输出结果
  • 动态编辑和可视化文档的基本组件(文本、数学、图形、表格、参考文献、引用等)。
  • 对输出到最终文档中的元素及其布局和排版方式有精确的控制。
    • 还能够将相同的源文档输出到不同的布局和格式(pdf、html、演示文稿等)。

工作流程

  1. 创建一个包含一些内容的笔记本!
  2. 可选地创建.bib文件和外部图像
  3. 调整笔记本和单元元数据。
  4. 安装ipypublish并运行nbpublish,针对特定的笔记本或包含多个笔记本的文件夹。
  5. 将创建一个转换后的文件夹,其中将输出最终的.tex.pdf.html文件,文件名与笔记本或文件夹输入相同。

默认的LaTeX模板输出所有Markdown单元格(除非标记为latex_ignore),然后只有带有LaTeX元数据标签的代码和输出单元格。请参阅Example.ipynbExample.pdfExample.htmlExample.slides.html,了解可能的输入和输出示例。

WorkFlow Example

请访问项目网站获取更多信息!

致谢

IPyPublish作为nbconvert的扩展构建。

我还受到了以下人士的强烈影响:

项目详情


下载文件

下载适用于您的平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源代码分发

ipypublish-0.10.12.tar.gz (215.2 kB 查看散列值)

上传时间 源代码

构建分发

ipypublish-0.10.12-py2.py3-none-any.whl (292.2 kB 查看散列值)

上传于 Python 2 Python 3

由以下支持