1. Bohrium Notebook
1.1 什么是 Bohrium Notebook
1.2 使用 Notebook 的一些技巧
2. 整体性建议
2.2 作者声明（搬运的内容无需作者声明，仅声明快速开始）
- 中文格式「作者声明」 把以下 HTML 代码添加到你的 Notebook Title Cell 中：（记得修改作者名与 href 属性中的邮箱——第6行、和修改时间——第10行）
©️ Copyright 2023 @ Authors
作者：
*** 📨
日期：2023-06-06
共享协议：本作品采用知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议进行许可。
快速开始：点击上方的 开始连接 按钮，选择 bohrium-notebook:2023-05-31镜像 和任意配置机型即可开始。
你可以在 creativecommons.org 更换为你需要的协议。
- 英文格式的「快速开始」如下：
如果你需要英文格式的作者声明，可根据中文示例进行修改。
📖 Getting Started Guide
This document can be executed directly on the Bohrium Notebook. To begin, click the Connect button located at the top of the interface, then select the bohrium-notebook:2023-04-07 Image and choose your desired machine configuration to proceed.
2.3 图片格式
Notebook 中的图片有时会过大或过小，需要使用 HTML 语法控制图片大小，控制图片大小的语法如下：
<img src="图片链接" width="宽度" height="高度" alt="图片描述">
将上述代码中的 "图片链接" 替换为你的图片链接，"宽度" 和 "高度" 替换为你希望设置的图片尺寸，以及将 "图片描述" 替换为你对图片的描述。例如：（大部分时候不用设置高度）。
<img src="https://example.com/image.jpg" width="300" height="200" alt="Example Image">
此外，没有链接的图片你也可以从本地直接拖拽到 Notebook 中，会转换成 base64 编码的附件形式直接保存在 Notebook 中。
2.4 Open in Bohrium 链接
嵌入 Open in Bohrium 按钮，方便快速在 Bohrium 中打开：
<a href="https://bohrium.dp.tech/notebook/879b6a3a9d394448913ca1ce7de257ec" target="_blank"><img src="https://cdn.dp.tech/bohrium/web/static/images/open-in-bohrium.svg" alt="Open In Bohrium"/></a>
注意将其中 href 属性的链接转为你的 Notebook 的分享链接。显示效果如下：
2.5 标题风格
尽量和已有文档保持一致，例如本文档中的目录格式。且尽量不要超过四级标题。
- 全文中仅保留一个一级标题（即 # ），因为右侧目录会跳过一级标题，从二级标题（即 ## ）开始识别，最多识别到6级标题（即 ######）；
- 避免使用重复的子标题，如有重复，点击右侧目录时只能定位到第一个重名子标题的位置；
- 如果希望在正文中也插入目录，可参考下方格式(以 数字+. 的方式作为序号，与文字之间隔一个空格)
例如：
3. Notebook 格式建议
3.1 Code Cell 的写作建议
- 发挥 Notebook 优势，不要使用封装的函数，尽量使用分割的 Cells 显示输出来让代码更易于理解。
- 确保 Notebook 可以一键运行。
- 添加 Code 注释
- 控制单个 Cell 的输出长度，过长的输出设置成滚动模式
3.1.1 Python Code
无特殊说明，请遵循 PEP8 写作规范。
- 尽量确保每个 Cell 可单独运行（保证变量名不被复用，如果需要复用，请连续编码以保证该 Cell 可单独运行）
- 尽量控制单个 Cell 的输出不要超过 单个屏幕的长度（该屏幕长度可以 1080P 100% 缩放估计，非绝对精确要求）
- 如果输出超过屏幕长度，建议右键输出部分，选择滚动模式。
3.1.2 Bash Code
- Notebook 中不仅可以输入 Python 代码，也可以输入 Bash 代码，这是 Notebook 自带的功能，详情可阅读 3.1.2 章节。
运行结果会在下面的输出栏中显示 如果要在Jupyter Notebook中使用更高级的shell命令，可以使用类似于“％sh”和“％bash”的魔术命令。 例如，如果要在Jupyter Notebook中运行bash命令，只需键入：
之后,你就可以在 cell 中输入bash命令了。
3.2 Markdown Cell 的写作建议
请尽量少使用英文缩写，请仅在以下特别情况下使用缩写：
- 在文档中极大量出现，且在第一次出现时已积极声明；
- 广为人知且不易产生歧义的缩写，例如 DFT，ASE；或专有名词，如 VASP, Lammps, MASER 举例来说，第二点不包括 ML(Machine Learning)
3.2.1 专有名词的格式务必规范
如：DeePMD-kit、DP-GEN、DeepModeling、CPU/GPU等
3.2.2 文件名、路径，统一使用斜体
例如：
example.py ./dictory/example.py
3.2.3 需要嵌入文中的代码统一使用 markdown 格式
例如： import exmple
3.2.4 图片缩放以优化显示效果
见上文 2.3。
3.2.5 不要 在 shell 代码前加 $ 符号，除非你想要展示命令的输出
另，请在代码块中表明使用的语言 建议使用:
echo a
echo a > file
不建议：
$ echo a
$ echo a > file
建议, 展示输出:
$ echo a
a
$ echo a > file
4. 常见问题解答
4.1 我的 Notebook 需要独特的程序环境（镜像），现有的公共镜像都无法满足我的要求，如何创建一个自定义镜像？
在你打开的容器节点上安装好你需要的环境，回到主页面 - 节点，点击「制作镜像」即可快速创建一个自定义镜像。
4.2 我安装了自己的程序环境，可以让我的 Notebook 跑通，我应该怎么分享给别人？
你可以将你自己的程序环境制作为一个镜像共享给别人，详细步骤如下： https://bohrium-doc.dp.tech/docs/software/OtherSoftwares
4.3 我应该如何告诉别人用指定的镜像？
参考 2.2 中的声明方式，在 Notebook 开头用醒目的方式向读者告知需要使用的镜像名称与推荐的机器配置。
4.4 我的 Notebook 中用到了我的本地数据，但是我只能分享给别人 Notebook，数据无法分享，我该怎么办？
推荐使用 Bohrium 数据集功能，详情可见：https://bohrium-doc.dp.tech/docs/userguide/Dataset
4.5 我的一些图片引用地址是相对地址，上传到 Bohrium 后就无法显示了，我该怎么办？
- 最简单也是最原始的办法是可以直接从本地拖动图片到 Notebook 中，Notebook 会将该图片以附件形式存储在文件中，缺点是读者无法从该 Bohrium notebook 中导出改图像了，同时你也无法调整它的大小。
- 我们可以将图像改变为在线地址，这需要我们找到该图片的 URL，并将其替换到引用中。例如，将
<img src="images/pic.jpg">更改为<img src="https://yourpicswebsite.com/images/pic.jpg">。 - 可以考虑使用 Bohrium 的 API 或其他工具将它们上传到 Bohrium，如果图片存储在同一服务器上，然后就可以使用数据盘中的地址，这样就可以让图片与内容保持一致。
4.6 Notebook 中只能输入 Python 语句吗，我想使用一些命令行可以吗？
参考章节 3.1.2
6. 参考案例
一般来说，Notebook 的内容主要分为以下类型:
6.1 互动类
6.2 知识讲解类：
6.3 先进实践类：
6.4 前沿技术类：
