Notebooker 项目使用教程

Notebooker 项目使用教程

notebooker Productionise & schedule your Jupyter Notebooks as easily as you wrote them. 项目地址: https://gitcode.com/gh_mirrors/no/notebooker

1. 项目介绍

Notebooker 是一个可以将 Jupyter Notebook 生产化和调度的 Web 应用程序。它允许用户将 Jupyter Notebook 提交到 Git 仓库后，自动执行并参数化这些 Notebook。执行结果存储在 MongoDB 中，并通过 Web 界面进行搜索和查看。Notebooker 的主要功能包括：

• 将 Jupyter Notebook 作为报告运行，并支持参数化。
• 通过 Web 服务或命令行执行 Jupyter Notebook。
• 将 Notebook 的输出结果以静态 HTML 形式展示。
• 所有结果都可以从主页访问，并支持深入查看每个模板的执行结果。

2. 项目快速启动

安装与运行

Notebooker 支持在 Linux、Windows 10 和 OSX 系统上运行。以下是快速启动的步骤：

1. 克隆项目仓库：

   git clone https://github.com/man-group/notebooker.git
   cd notebooker
   

2. 使用 Docker 启动 Notebooker：

   cd docker
   docker-compose up
   

3. 访问 Notebooker： 启动后，可以通过浏览器访问 http://localhost:8080/ 来使用 Notebooker。

示例模板

Notebooker 自带了一些示例模板，可以在启动后直接使用这些模板进行测试和学习。

3. 应用案例和最佳实践

应用案例

Notebooker 可以广泛应用于数据分析、报告生成和自动化任务中。例如：

• 数据分析报告：定期执行数据分析 Notebook，并将结果生成报告。
• 自动化任务：将复杂的任务分解为多个 Notebook，并通过 Notebooker 进行调度和执行。

最佳实践

• 参数化：在编写 Notebook 时，尽量使用参数化功能，以便在执行时可以动态调整参数。
• 版本控制：将 Notebook 提交到 Git 仓库，确保代码的可追溯性和版本管理。
• 结果存储：利用 MongoDB 存储执行结果，便于后续的查询和分析。

4. 典型生态项目

Notebooker 依赖于以下几个关键的开源项目：

• Jupytext：用于将 Jupyter Notebook 转换为其他格式，便于版本控制。
• Papermill：用于参数化 Jupyter Notebook 的执行。
• nbconvert：用于将 Notebook 转换为 HTML 或其他格式。
• Fomantic-UI：用于构建 Web 界面的 UI 框架。

这些项目与 Notebooker 紧密结合，共同构建了一个强大的 Notebook 生产化平台。

notebooker Productionise & schedule your Jupyter Notebooks as easily as you wrote them. 项目地址: https://gitcode.com/gh_mirrors/no/notebooker