跳转到主要内容

Jupyter执行TeX代码环境。

项目描述

JupyTeX

提供Jupyter支持的LaTeX代码环境执行,并嵌入结果。在概念上类似于 PythonTex,但侧重于代码 执行,并避免任何特定语言的功能。

如何使用

  1. 使用 pip install git+https://github.com/agoose77/jupytex.git#egg=jupytex 安装JupyTeX
  2. 在LaTeX项目目录中运行 jupytex install(或使用 -d DIR 提供安装目录)以创建必要的 .latexmkrcjupytex.sty 文件
  3. \usepackage{jupytex} 添加到文档标题
  4. 使用以下方式声明代码环境:
    \begin{code}{language}[opts]
        Some source code
    \end{code}
    
    有关 opts 中有效选项的配置部分。
  5. 运行 jupytex make(它是对 latexmk --shell-escape 的代理)以调用 latexmk

示例Python脚本

\begin{code}{python}[kernel=python3]
    print("$x + y = z$")
\end{code}

卸载

在LaTeX项目目录中运行 jupytex uninstall(或使用 -d DIR 提供安装目录)以删除已安装的 .latexmkrcjupytex.sty 文件

清理

运行 jupytex clean(它是对 latexmk -clatexmk -C 的代理)以删除与LaTeX和JupyTex相关的运行文件。

JupyTeX流程控制

  1. jupytex.sty 声明依赖于 \jobname.timestamp
  2. jupytex.sty 宏将代码块写入编号的 .code 文件并尝试包含结果
  3. 代码 '块' 写入到 \jobname.blocks csv 文件
  4. 调用 jupytex hash 计算所有块的 md5 哈希值,并将其写入 \jobname.hash。在将来,这应该仅在每个内核会话中执行。
  5. 如果 \jobname.hash 已被修改,将调用 jupytex execute 对应作业,执行代码块并将结果写入 .result 文件,错误写入 .traceback 文件。不写入 stdout 的代码块将写入一个空的结果文件。《\jobname.timestamp 将更新为新的时间戳。
  6. latexmk 根据 \jobname.timestamp 对依赖项执行新的遍历。

配置

  • 每个代码块都必须指定一种语言。
  • 可以通过 kernel 键参数指定 Jupyter 内核名称,如果存在,将使用该名称代替语言。还可以通过传递连接文件的名称访问现有的内核。
  • 可以通过传递与内核会话对关联的内核的名称来传递 session 键参数以创建一个新的内核。如果 kernel 参数设置为连接文件,那么 这将创建与同一内核的新客户端

项目详情


下载文件

下载适用于您的平台的文件。如果您不确定选择哪个,请了解有关 安装包 的更多信息。

源分布

jupytex-0.0.3.tar.gz (8.2 kB 查看哈希值)

上传时间

构建分布

jupytex-0.0.3-py3-none-any.whl (10.6 kB 查看哈希值)

上传时间 Python 3

由以下机构支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误日志 StatusPage StatusPage 状态页面