3Fun's Blog

Jupyter介绍[转]

Jupyter Notebook（此前被称为 IPython notebook）是一个交互式笔记本，支持运行 40 多种编程语言。

Jupyter Notebook 的本质是一个 Web 应用程序，便于创建和共享程序文档，支持实时代码，数学方程，可视化和 markdown。 用途包括：数据清理和转换，数值模拟，统计建模，机器学习等等 [1]  。

用户可以通过电子邮件，Dropbox，GitHub 和 Jupyter Notebook Viewer，将 Jupyter Notebook 分享给其他人。

在Jupyter Notebook 中，代码可以实时地生成图像，视频，LaTeX和JavaScript。

组件

Jupyter包含以下组件：

Jupyter Notebook 和 Notebook 文件格式

Jupyter Qt 控制台

内核消息协议 (kernel messaging protocol)

许多其他组件

下载安装

一种方式是通过 pip 命令安装。

pip install jupyter

复制

另一种方式是使用集成科学计算环境Anaconda。推荐使用这种方式，下载过程就不说了。根据自己的系统环境，选择对应的版本进行下载。安装基本上也就是一路next，也没有什么要说的。

pip install jupyter

注：Anaconda是Python另一个非常流行的发行版，它之后有着自己的叫做“conda”的安装工具。用户可以使用它来安装很多第三方包。然而，Anaconda会预装很多包，包括了Jupyter Notebook,所以若已经安装了Anaconda，则Jupyter已经自动安装完毕。

启动Jupyter Notebook

使用 Anaconda 安装成功后，默认会将 Jupyter Notebook的启动程序添加到环境变量中。启动程序为jupyter-notebook。可以进入命令行，然后使用 jupyter-notebook --h 来查看使用说明。

(c:\soft\py3) C:\Users\wangwei01>jupyter notebook --h
usage: jupyter-notebook [-h] [--pylab [NOTEBOOKAPP.PYLAB]]
                        [--keyfile NOTEBOOKAPP.KEYFILE]
                        [--client-ca NOTEBOOKAPP.CLIENT_CA]
                        [--notebook-dir NOTEBOOKAPP.NOTEBOOK_DIR]
                        [--port-retries NOTEBOOKAPP.PORT_RETRIES]
                        [--config NOTEBOOKAPP.CONFIG_FILE]
                        [--certfile NOTEBOOKAPP.CERTFILE]
                        [--log-level NOTEBOOKAPP.LOG_LEVEL]
                        [--browser NOTEBOOKAPP.BROWSER]
                        [--transport KERNELMANAGER.TRANSPORT]
                        [--ip NOTEBOOKAPP.IP] [--port NOTEBOOKAPP.PORT] [-y]
                        [--script] [--no-mathjax] [--no-browser]
                        [--allow-root] [--debug] [--no-script]
                        [--generate-config]

optional arguments:
  -h, --help            show this help message and exit
  --pylab [NOTEBOOKAPP.PYLAB]
  --keyfile NOTEBOOKAPP.KEYFILE
  --client-ca NOTEBOOKAPP.CLIENT_CA
  --notebook-dir NOTEBOOKAPP.NOTEBOOK_DIR
  --port-retries NOTEBOOKAPP.PORT_RETRIES
  --config NOTEBOOKAPP.CONFIG_FILE
  --certfile NOTEBOOKAPP.CERTFILE
  --log-level NOTEBOOKAPP.LOG_LEVEL
  --browser NOTEBOOKAPP.BROWSER
  --transport KERNELMANAGER.TRANSPORT
  --ip NOTEBOOKAPP.IP
  --port NOTEBOOKAPP.PORT
  -y, --y
  --script
  --no-mathjax
  --no-browser
  --allow-root
  --debug
  --no-script
  --generate-config

启动前需要先说明一个概念，jupyter notebook中有个叫做工作空间（工作目录）的概念，也就是说如果你想在哪个目录进行之后的工作，那就在哪个目录启动它。例如，这里我想将家目录的的jp_workspace目录作为工作空间，那我就需要进入到这个目录下。

在此文件夹下打开终端，并执行命令：

jupyter notebook

这将开启Jupyter，并使用你的默认浏览器访问URL：http://localhost:8888/tree

像这样：

注意：现在并没有运行一个Notebook,而是仅仅运行了Notebook服务器。

创建一个Notebook

点击“New”按钮，打开菜单选择环境。
这里我的电脑里安装了Python3，因此选择Python3。

命名

点击上方的”Untitled”，然后键入想要的名称。

这里改为demo。

运行Cells

在cell中输入代码后，可以点击

或者可以使用键盘shift + enter运行代码。

注意：当一个页面中有多个单元格时，按顺序运行它们，它们之间则可以共享方法与变量。无需在单元格中重新导入模块和变量。

当运行单元格时，在单元格左侧的单词In旁边有一些方括号。方括号将自动填充一个数字，该数字表示将运行单元格的顺序。例如，如果我们打开一个全新的Notebook并运行该Notebook顶部的第一个单元格，则方括号将填充数字1。

File

File 菜单中主要包含了以下功能：创建新的Notebook、打开新的界面、拷贝当前Notebook、重命名Notebook、保存还原点、恢复到指定还原点、查看Notebook预览、下载Notebook、关闭Notebook。

这里重点强调下下载Notebook选项，它可以将当前Notebook转为py文件、html文件、markdown文件、rest文件、latex文件、pdf文件。

保存检查点(Ctrl + s) 这个功能较特殊且有用，它可以保存以后想用来回滚的检查点，并在需要的时候Revert to Checkpoint。

Edit
接下来是编辑菜单。在这里可以剪切、复制和粘贴单元格。这里也可以删除、分割或合并一个单元。并且也可以在这里重新排序单元格。

选中单元格时，左侧竖条呈蓝色，这时可以对单元格进行操作。
点按”x”剪切单元格。
点按”c”复制单元格。
点按”v”粘贴单元格。
双击”d,d”删除单元格。
选中单元格中的文本框内容时，左侧竖条呈绿色，这时可以对文本进行操作。
使用”Ctrl + 上述单个字符”实现对文本的操作。

注意：我们会发现Edit中有一些条目选项是灰色的，不可点击。这是因为在当前类型的单元格中不可使用这些功能。例如，代码单元格中不能够插入图片，但Markdown单元格中可以。

View
View栏可以开关顶栏和工具栏，还可以开关代码行号(Ctrl + L)。

Insert
Insert栏可以在当前单元格的上方和下方插入单元格。(A / B)

Cell
Cell 菜单主要包含了运行cells、运行cells后并在之后插入新的cell、运行所有cells、运行当前之上的所有cell、运行当前之下的所有cell、改变cell类型（code、markdown、raw nbconvert）等。

Kernel
内核单元用于处理在后台运行的内核。在这里，我们可以重新启动内核，重新连接它，关闭它，甚至更改您的Notebook使用的内核。
虽然我们可能不会经常使用内核，但是在调试Notebook时，可能需要重新启动内核。当这种情况发生时，就会去这里操作，也可使用toolbar的循环箭头重启内核。

Widgets
Widgets菜单用于保存和清除widget状态。小部件基本上是JavaScript小部件，我们可以将其添加到单元格中，以使用Python(或其他内核)生成动态内容。

Help
可以从中查看键盘快捷键，使用界面教程和许多相关工具。

熟悉工具栏

工具栏上的内容都在下图中：

依次来介绍下，保存还原点、在当前位置之下添加cell、剪切当前cell、拷贝选择的cell、复制选择的cell、上移选中的cell、下移选中的cell、运行cell、中断kernel、重启kernel、修改cell类型、打开命令行调色板、美化cell代码。

很明显，工具栏中的功能大多都是菜单栏中的一部分功能的体现，主要是为了方便寻找。

运行Python代码

想要运行Python代码，其实很简单，因为Python代码最后都在 Cell 中编写的。首先在cell中编写好Python代码，然后点击运行，可以直接在下面看到结果。

仔细一点，我们可以发现，第一个cell前面有 “In [1]:”提示符，第二个cell前面有“In[2]:”提示符，同时也有“Out[2]:”输出符，这是因为如果没有print语句的话，Notebook会将当前cell的最后一条语句的结果以“Out[?]:”的方式输出。

编写Markdown

Notebook最友好的一个功能就是可以在cell中通过Markdown来编写文本。我们首先创建一个cell，然后更改类型为markdown，更改成功后，cell开头没有“In[?]:”的提示符。然后点击cell，按照markdown语法来输入文本。

除了对markdown语法的支持外，同时也支持html代码，此外，也支持latex公式语法。

使用latex公式时，如果需要在当前行内插入公式，公式前后分别需要一个$，如果需要在下一行单独插入公式，公式前后分别需要两个$。

在markdown类型的cell中输入以下内容：

## 这是一个二级标题

这是一个markdown类型的cell

- 下面演示了对html代码的支持：

  <a href="www.naodongopen">这是使用html的a标签实现的超链接</a>


- 下面演示的对latex公式的支持：

  当前行内插入公式：$ \int_0^{+\infty} x^2 dx $

  下一行插入公式：$$ \int_0^{+\infty} x^2 dx $$

运行该cell，得到以下结果：

开启终端或其他

Jupyter Notebook中，除了代码页面外，还可以开启终端，或文本。
终端框实现了在web网页中打开服务器端的操作系统终端。允许你运行bash,Powershell等shell。

查看什么正在运行

在Jupyter服务器的首页(http://localhost:8888/tree)中,有另外两个按钮：Running和Clusters。

Running中会告诉你哪个Notebooks和终端在运行。这对于你想在关闭服务器前确保相应数据被保存的情况将很有用处。

安装插件管理器

第一步：用pip安装插件管理包

pip install jupyter_contrib_nbextensions
pip install jupyter_nbextensions_configurator

第二步：安装一些插件并启用插件管理器

jupyter nbextensions_configurator install --user
jupyter nbextensions_configurator enable --user

然后打开Jupyter notebook会发现菜单栏多了一个选项Nbextensions

记得勾选第一项，否则下方插件是不可选状态。

我们可以通过命令来管理开户中或关闭某个插件，但是我觉得还是通过直接勾选我们需要的插件效率更高。

选择插件

我们从上面可以看出，jupyter notebook有很多插件，我们该用哪一个呢？我推荐5款个人认为不错的插件。

  • Table of Contents
  • Execute Time
  • Nofity
  • Codefolding
  • Hinterland

下面分别介绍一下它们的功能

Table of Contents是一款自动生成目录的工具，它能够通过我们我们富文本中定义的标题自动生成目录，这样我们能够通过点击左侧目录快速定位到我们想要的到达的代码片段。

Execute Time顾名思义，执行时间，我觉得这是一款非常实用的插件，在企业项目开发中，效率是永远无法越过的一个门槛，和学术上理论效果足够优秀即可不同，在企业项目中对效率要求也很高，因此，我们需要统计代码的运行时间，其中最初级的用法就是在每个函数开始和结尾处写一个计时语句，这样比较繁琐。然后再高阶一些的用法就是通过装饰器写一些计时器，在每个函数上调用这个装饰器。其实，如果用jupyter notebook完全没必要这么麻烦。我们只需要打开Execute Time，它就能统计每个cell的运行耗费时间，结束时间等，非常详细，一目了然。

Nofity同样是一款非常实用的插件，当我们运行一个耗时较长的代码时，我们不可能一直盯着屏幕等待，但是我们又希望及时知道它运行结束了，Notify这款插件就可以实现这个功能，它能够在代码运行结束时发出通知，及时告知你代码运行结束了。

Codefolding是一款代码折叠工具，有时候我们写的一个函数非常长，但是我们又不关注 ，这样在阅读过程中会使得效率很低，代码折叠就是一个不错的选择，折叠我们不关注的代码块，Codefolding能够像其他IDE那样让你轻松自如的折叠代码块。

Hinterland是一款自动补全插件，称一个IDE“优秀”，如果没有自动补全显然是说不过去的。jupyter notebook自带补全功能，但是每次都需要点击tab键来补全，这样效率比较低，我们可以通过勾选Hinterland让jupyter notebook具备自动补全功能，当我们输入几个包含字母后它能够快速补全我们想要的函数，补全速度堪比pycharm。

主题修改

很多同学使用jupyter notebook都会觉得，这款开发工具界面太单调了，只有纯白色的主题，其实并不是这样，jupyter notebook也支持主题修改，而且非常方便。

首先在命令行下输入下面命令安装主题，

$ pip install jupyterthemes

jupyter notebook的主题管理工具叫做jt，我们可以通过下面命令查看可用主题，

$ jt -l
Available Themes:
   chesterish
   grade3
   gruvboxd
   gruvboxl
   monokai
   oceans16
   onedork
   solarizedd
   solarizedl

然后通过下面命令设置主题，

$ jt -t <theme_name>

其中theme_name为主题名称。

如果觉得不满意，想退回默认主题，可以通过下方命令实现，

$ jt -r

多语言支持

很多同学是因为Python而解除到jupyter notebook的，因此会认为这就是一款Python专属的开发工具，如果这样的话，那么也不足以我专门用一篇文章来介绍这款开发工具。

它更像是eclipse、IDEA、vscode，是一款综合的开发工具，它不仅支持Python，还支持C++、julia、R、ruby、Go、Scala、C#、Perl、PHP、Octave、Matlab、Lua、Tcl、等多种编程语言，功能十分强大，支持语言详情，请查看下方链接，

https://link.zhihu.com/?target=https%3A//github.com/jupyter/jupyter/wiki/Jupyter-kernels

不同语言的配置方式各不相同，这里不再一一介绍，可以根据自己需要的语言自行在网上搜索相关配置资料进行配置。

jupyter notebook服务

如果非要找出使用jupyter notebook的缺点，我认为就是每次启动的时候相对繁琐，我们启动本地安装的IDE，一个命令或者点击一下图标即可，但是如果启动jupyter notebook就需要进入命令行或终端，输入“jupyter notebook”进行打开，如果使用的是虚拟环境，首先还要激活虚拟环境，这无疑是非常繁琐的，而且启动后它会占用一个终端或命令行窗口，如果意外关闭则会终止jupyter notebook服务。其实，这也是有解决方法的，我们搭建一个持续化的jupyter notebook服务，让它一直在服务器后台运行，这样既不占用窗口，也不需要繁琐的打开步骤，我们只需要把对应的URL收藏，每次需要时能够秒级速度打开，下面就来介绍一下jupyter notebook的搭建步骤。

第一步：获取sha1密码

在命令行下输入ipython，

In [1]: from IPython.lib import passwd
In [2]: passwd()
Enter password:
Verify password:
Out[2]: 'sha1:746cf729d33f:0af9cda409de9791f237a6c46c3c76a3237962fc'

导入passwd函数，调用后会让你输入密码，你可以设置一个明文密码，例如123，然后它会生成一个sha1密码串，这个很重要，后面会用到。

修改jupyter配置文件，linux系统配置文件路径为~/.jupyter/jupyter_notebook_config.py，windows系统配置文件路径为C:\Users\User\.jupyter\jupyter_notebook_config.py，如果没有这个文件，可以使用下面命令生成，

$ jupyter notebook --generate-config

这个配置文件很长，以linux为例，主要关注的是如下几项，

c.NotebookApp.ip = '*'  
c.NotebookApp.password = u'sha1:xxx:xxx' 
c.NotebookApp.open_browser = False 
c.NotebookApp.port = 8888
c.NotebookApp.enable_mathjax = True

c.NotebookApp.ip、c.NotebookApp.port，ip要和服务器保持一致，端口可以自行设定，不和其他端口冲突即可，后续访问时在浏览器输入ip:port即可。

c.NotebookApp.password就是前面生成的sha1密码串，复制过来即可。

c.NotebookApp.open_browser = False 的含义为是每次启动命令时是否打开浏览器，由于我们用的时候直接输入URL即可，所以这里不需要打开浏览器。

c.NotebookApp.enable_mathjax的含义为是否用mathjax，它是一种用于数学公式显示的工具，这里选True。

配置好这几项之后保存退出，输入下面命令即可启动，

$ nohup jupyter notebook > /dev/null 2>&1 &

nohup的含义是后台运行，这样就不用占用一个窗口来了。

配置好之后只要服务器不关机，jupyter notebook的服务会一直处于运行状态，我们随时可以使用，只需要打开ip:port即可。

Jupyter现如今已经成为Python开发中举足轻重的IDE，在数据分析等领域应用非常广泛。

尤其，随着Python逐渐在机器学习、数据分析、可视化、自动化办公等方面越来越广泛的应用，Jupyter会得到更多的重视。