'Octave的Jupyter内核。
项目描述
先决条件
Jupyter Notebook 和 GNU Octave。
安装
要使用pip安装
pip install octave_kernel
添加 --user 在用户级环境中安装,而不是系统环境。
要使用conda安装
conda config --add channels conda-forge conda install octave_kernel conda install texinfo # For the inline documentation (shift-tab) to appear.
我们需要的 octave-cli 或 octave 可执行文件来运行内核。将此可执行文件的目录添加到 PATH 环境变量中,或创建环境变量 OCTAVE_EXECUTABLE 指向可执行文件本身。请注意,在Windows上的Octave 5+中,可执行文件位于 "Octave-x.x.x.x\mingw64\bin"。
在安装 Python 包时,我们会自动安装 Jupyter kernelspec。您可以使用 jupyter kernelspec list 命令找到此位置。如果不希望使用默认位置,请删除 octave 内核的目录,并使用 python -m octave_kernel install 命令进行安装。有关可用选项,请参阅 python -m octave_kernel install --help。
用法
要使用此内核,请运行以下命令之一:
jupyter notebook # or ``jupyter lab``, if available
# In the notebook interface, select Octave from the 'New' menu
jupyter qtconsole --kernel octave
jupyter console --kernel octave
此内核基于 MetaKernel,这意味着它包含一组标准的魔法命令(如 %%html)。要获取魔法命令的完整列表,请在单元格中运行 %lsmagic。
示例笔记本可在 网上 获取。
配置
可以通过在 jupyter 配置路径中添加 octave_kernel_config.py 文件来配置内核。OctaveKernel 类提供了可配置特性,包括 plot_settings、inline_toolkit、kernel_json 和 cli_options。可用的绘图设置有:'format'、'backend'、'width'、'height'、'resolution' 和 'plot_dir'。
cat ~/.jupyter/octave_kernel_config.py
# use Qt as the default backend for plots
c.OctaveKernel.plot_settings = dict(backend='qt')
还可以通过创建一个 OCTAVE_KERNEL_JSON 环境变量来指定 Octave 内核 JSON 文件的路径。
可以使用 OCTAVE_CLI_OPTIONS 环境变量指定 Octave 的命令行选项。cli 选项将附加到默认的 --interactive --quiet --no-init-file 选项。注意,在内核设置 more off 后显式调用初始化文件,以防止在 ~/.octaverc 中调用分页器时发生锁定。
内联工具包是用于生成内联后端图形的 graphics_toolkit。默认为 qt。可以通过使用此配置或使用带有后端名称的绘图魔法来使用不同的后端进行内联绘图,例如 plot -b inline:fltk。
故障排除
内核启动时超时
如果内核无法启动,请在终端中运行以下命令:
python -m octave_kernel.check
这可以帮助诊断与 Octave 集成的设置问题。如果有疑问,请创建一个包含该命令输出的 issue。
内核未列出
如果内核未作为可用内核列出,请首先尝试以下命令:
python -m octave_kernel install --user
如果内核仍然未列出,请验证以下内容是否指向同一版本的 Python:
which python # use "where" if using cmd.exe
which jupyter
Gnuplot 错误
以 gnuplot> set terminal aqua enhanced title 开头的错误可以通过在 MacOS 上将 setenv("GNUTERM","qt"); 添加到 ~/.octaverc 或安装 gunplot-x11 并使用 setenv("GNUTERM", "X11") 来修复。
Octave-Snap(Linux)
您可以通过检查 Octave 安装路径来检查是否在 Linux 上使用 snap 版本。
which octave
如果返回的路径中包含 snap,则 Octave 在容器中运行,您需要相应地配置内核。
设置环境变量 OCTAVE_EXECUTABLE="octave"
echo export OCTAVE_EXECUTABLE=\"octave\" >> ~/.bashrc
为内核使用的临时绘图目录创建一个目录。此目录 不能 是隐藏目录。
mkdir ~/octavePlots
将 plot_dir 设置为指向 octave_kernel_config.py 中的绘图目录。
c.OctaveKernel.plot_settings = dict(plot_dir='<home>/octavePlots')
其中 <home> 是您家目录的绝对路径。不要使用 ~,因为它对于 Octave-Snap 来说是另一个位置。
空白绘图
使用 %plot -f <backend> 魔法或配置设置指定不同的格式。在某些系统上,默认的 'png' 产生一个黑色的绘图。在其他系统上,'svg' 产生一个黑色的绘图。
本地安装
要从 git 检出安装,请运行
make install
项目详情
下载文件
下载您平台上的文件。如果您不确定选择哪个,请了解有关 安装包 的更多信息。