https://github.com/agoose77/jupytex

Jupyter execution of LaTeX code environments
https://github.com/agoose77/jupytex

julia jupyter latex python pythontex r

Last synced: 22 days ago
JSON representation

Jupyter execution of LaTeX code environments

• Host: GitHub
• URL: https://github.com/agoose77/jupytex
• Owner: agoose77
• License: mit
• Created: 2018-03-01T10:45:25.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2021-05-21T13:55:40.000Z (over 3 years ago)
• Last Synced: 2024-12-15T16:48:10.027Z (about 2 months ago)
• Topics: julia, jupyter, latex, python, pythontex, r
• Language: Python
• Homepage:
• Size: 55.7 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# JupyTeX

[![pypi-badge][]][pypi]

[pypi-badge]: https://img.shields.io/pypi/v/jupytex

[pypi]: https://pypi.org/project/jupytex

Provides Jupyter-backed execution of LaTeX `code` environments, and embeds the results. Similar in concept to [PythonTex](https://github.com/gpoore/PythonTex), but focuses on code _execution_, and avoids any language specific features.

Install with `pip install jupytex`.

## How to Use

1. Run `jupytex install` in LaTeX project directory (or provide an install directory with `-d DIR`) to create the necessary `.latexmkrc` and `jupytex.sty` files

2. Add `\usepackage{jupytex}` to the document header

3. Declare code environments with

    ```latex

    \begin{code}{language}[opts]

        Some source code

    \end{code}

    ```

    See the configuration section for valid options in `opts`.

4. Run `jupytex make` (which is a pass-through to `latexmk --shell-escape`) to invoke `latexmk`.

### Example Python Script

```latex

\begin{code}{python}[kernel=python3]

    print("$x + y = z$")

\end{code}

```

## Removing from Project

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 Files

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

## Flow Control

1. `jupytex.sty` declares dependency upon `\jobname.timestamp`

1. `jupytex.sty` macro writes code blocks to numbered `.code` files and attempts to include results

1. Code 'blocks' are written to a `\jobname.blocks` csv file

1. `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.

1. 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.

1. `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*.