Research Helpers Documentation

License Python Tests

A set of utilities for managing code-intensive research projects and their accompanying papers. Includes shared figure styling, LaTeX table generation and rendering, a build pipeline that keeps a paper’s generated tables and figures from drifting out of date, submission packaging for arXiv and Zenodo, structured logging, and a parameter-sweep engine for scheduler job arrays.

Install

The core package has no third-party dependencies. Additional capabilities are installed as extras:

pip install research-helpers[figures]   # matplotlib, seaborn
pip install research-helpers[latex]     # LaTeX table assembly and rendering (stdlib only)
pip install research-helpers[log]       # structlog, colorama, tqdm
pip install research-helpers[sweep]     # pandas, pyarrow (planning and running need neither)

Requires Python 3.11 or newer (tomllib is needed to read the project’s wiring).

Where to start

  • Wiring up a project — Configuration includes the full reference for [tool.research-helpers].

  • See it work — Adding a generated table takes one table from a JSON file to a drift check in CI.

Documentation