kxsys/jupyterq

jupyterq

镜像概述和主要用途

jupyterq是一个为kdb+设计的Jupyter内核，旨在将Jupyter notebooks的交互性与kdb+的高性能数据分析能力相结合。它允许用户在Jupyter环境中编写、运行和可视化kdb+代码，提升数据分析和开发效率。

核心功能和特性

• q语言语法高亮
• 代码补全：支持q关键字、.z/.h/.Q/.j命名空间函数及用户定义变量
• 代码帮助：提供q关键字帮助及用户定义对象的基本帮助（显示和类型信息）
• 脚本式代码执行（多行输入）
• 通过embedPy和matplotlib创建的图表内联显示
• 控制台stdout/stderr捕获并在笔记本中显示
• 笔记本单元格内脚本的加载和保存

要求

• kdb+>=v3.5 64位版本
• Anaconda Python 3.x
• https://github.com/KxSystems/embedPy

构建和安装

在安装embedPy后，使用以下命令安装Python依赖：

使用pip

bash
pip install -r requirements.txt

使用conda

bash
conda install --file requirements.txt

下载

从发布页面下载相应的发布档案。

Linux/Mac

确保已设置QHOME环境变量，且PATH中包含可运行的q，然后执行：

bash
./install.sh

Windows

确保已设置QHOME环境变量，且PATH中包含可运行的q，然后执行：

install.bat

Jupyter控制台、笔记本和QtConsole可正常工作，Jupyter Lab未经过测试。

Mac

在Mac上，使用嵌入式Python模式时可能存在MKL相关问题（例如：https://github.com/ContinuumIO/anaconda-issues/issues/6423%EF%BC%89%E3%80%82%E8%8B%A5%E4%BD%BF%E7%94%A8Anaconda Python遇到类似问题，可尝试以下命令解决：

bash
conda install nomkl

Docker

若已安装Docker，可创建名为q的目录，将kc.lic（或k4.lic）和l64.zip文件放入该目录，然后运行：

bash
docker run --rm -it -v `pwd`/q:/tmp/q -p 8888:8888 kxsys/jupyterq

之后在浏览器中访问 http://localhost:8888/notebooks/kdb%2BNotebooks.ipynb 即可。

注意：镜像构建说明已提供。

安装后运行

启动Jupyter控制台

bash
jupyter console --kernel=qpk

运行示例笔记本

bash
jupyter notebook kdb+Notebooks.ipynb

使用笔记本

完整的交互式示例和说明请参见kdb+Notebooks.ipynb笔记本，该笔记本可在GitHub上查看。

文档

文档可在jupyterq主页获取。