Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Jupyter execution of TeX code environments.

Project description

JupyTeX

Provides Jupyter-backed execution of LaTeX code environments, and embeds the results. Similar in concept to PythonTex, but focuses on code execution, and avoids any language specific features.

How to use

  1. Install JupyTeX with pip install git+https://github.com/agoose77/jupytex.git#egg=jupytex
  2. Run jupytex install in LaTeX project directory (or provide an install directory with -d DIR) to create the necessary .latexmkrc and jupytex.sty files
  3. Add \usepackage{jupytex} to the document header
  4. Declare code environments with
    \begin{code}{language}[opts]
        Some source code
    \end{code}
    
    See the configuration section for valid options in opts.
  5. Run jupytex make (which is a pass-through to latexmk --shell-escape) to invoke latexmk.

Example Python Script

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

Uninstallation

Run jupytex uninstall in LaTeX project directory (or provide an install directory with -d DIR) to remove the installed .latexmkrc and jupytex.sty files

Cleaning

Run jupytex clean (which is a pass-through to latexmk -c or latexmk -C) to remove both LaTeX and JupyTex-related run files.

JupyTeX flow control

  1. jupytex.sty declares dependency upon \jobname.timestamp
  2. jupytex.sty macro writes code blocks to numbered .code files and attempts to include results
  3. Code 'blocks' are written to a \jobname.blocks csv file
  4. jupytex hash is invoked to calculate the md5 hash for all of the blocks, which is written to \jobname.hash. In future this should only be performed per-kernel-session.
  5. If \jobname.hash has been modified, jupytex execute is invoked for the corresponding job, the code blocks executed, and results written to .result files, and errors to .traceback files. Code blocks which do not write to stdout write an empty results file. \jobname.timestamp is updated with new timestamp.
  6. latexmk performs a new pass for the dependencies upon \jobname.timestamp

Configuration

  • Each code block must be given a language.
  • One can specify the Jupyter kernel name with a kernel key parameter, which will be used instead of the language if present. One can also access an existing kernel, by passing the name of a connection file.
  • A session key parameter may be passed to create a new kernel associated with the kernel-session pair. If the kernel parameter is set to a connection file, then this will create a new client to the same kernel.

Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for jupytex, version 0.0.3
Filename, size File type Python version Upload date Hashes
Filename, size jupytex-0.0.3-py3-none-any.whl (10.6 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size jupytex-0.0.3.tar.gz (8.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page