research-helpers 1.0.0__tar.gz

research_helpers-1.0.0/CHANGELOG.md

@@ -0,0 +1,68 @@
+# Changelog
+
+All notable changes to this project are documented here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the project adheres to
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] — 2026-09-11
+
+First public release.
+
+The package was generalized out of three research projects that had each grown their own copy of
+the same utilities.
+
+### The idea
+
+`research-helpers` reads a project's **wiring**—*i.e., where the paper lives, how wide it is, where
+sweep runs are written—and nothing else. Research parameters stay in the project that owns
+them. This wiring lives in one `[tool.research-helpers]` section of a project's `pyproject.toml`, 
+which is also the project-root marker, so finding the configuration and finding the root are one
+operation. Every setting has a working default, and every entry point is callable with plain
+arguments and no project file at all.
+
+### Added
+
+- **`build`** — a registry of generated artefacts with three-way drift detection: a table the
+  paper is behind on, one that is generated but never pulled in, and one typed by hand with no
+  emitter behind it. `--check` exits non-zero, so "every number in the paper is generated from
+  data in the repository, and is current" becomes a build status.
+- **`latex`** — table assembly with the conventions a paper needs: half-up rounding, escaping 
+  for text arriving from data, en-dashes for ranges, em-dashes for empty cells.
+- **`display`** — parse a generated `.tex` table back into rows, spans and alignment, for reading
+  in a notebook or asserting on in a test.
+- **`figures`** — one matplotlib look across a project, and a `print` profile that sizes a figure
+  to the document it is going into, so it renders in the paper at 1:1 with body-text-sized labels.
+- **`arxiv`** — inventory a submission keyed by the paths it takes *inside* the upload, and check
+  it against the engine and TeX Live year it will build under: filenames arXiv rejects, a `.bbl`
+  that is missing, stale or in the wrong `biblatex` format, and `microtype` font expansion under an
+  engine that has none.
+- **`archive`** — byte-reproducible tarballs. Pinned `mtimes`, `uid`, and `gid`, normalised modes,
+  sorted members, and an emptied gzip filename field, so a published checksum means something.
+- **`sweep`** — plan a parameter grid once, run it as a scheduler job array, resume what was
+  killed, collect the parts into one table. Resumption is per combination rather than per task,
+  the manifest is written once so a sparse resubmission reproduces its original slices, and
+  planning, running and status need only the standard library.
+- **`log`** — *structlog* over the standard library, with separate console and file levels, colour
+  only when the stream is a terminal, and progress bars that do not fight the log.
+- **`research-helpers` CLI** — `doctor` prints every setting, the value in force and where it came
+  from; `arxiv` assembles, checks, packs and previews a submission.
+- Lengths may be written in inches, millimetres, centimetres, or TeX points by changing a key's
+  suffix: `text-width-pt = 468.0` is what `\showthe\textwidth` prints, copied across with no
+  arithmetic in between.
+- Full documentation at <https://gpizzorno.github.io/research-helpers/>.
+
+### Notes for packagers
+
+- Requires Python 3.11 or newer.
+- **The core package has no third-party dependencies.** Capabilities are opt-in extras:
+  `figures` (matplotlib, seaborn), `log` (structlog, colorama, tqdm), `sweep` (pandas, pyarrow),
+  and `latex`, which is standard library only and exists, so the capability is discoverable.
+  Importing `research_helpers` pulls in none of them.
+- The package ships a `py.typed` marker, so annotations are visible to type checkers.
+
+### Verified
+
+- 276 tests, 97% coverage, run against Python 3.11, 3.12, and 3.13 in CI.
+- The documentation builds with warnings as errors.
+
+[1.0.0]: https://github.com/gpizzorno/research-helpers/releases/tag/v1.0.0

research_helpers-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Gabe Pizzorno
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

research_helpers-1.0.0/MANIFEST.in

@@ -0,0 +1 @@
+include CHANGELOG.md

research_helpers-1.0.0/PKG-INFO

@@ -0,0 +1,293 @@
+Metadata-Version: 2.4
+Name: research-helpers
+Version: 1.0.0
+Summary: Utilities for code-intensive research projects and the papers they produce
+Author: Gabe Pizzorno
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/gpizzorno/research-helpers
+Project-URL: Documentation, https://gpizzorno.github.io/research-helpers/
+Project-URL: Repository, https://github.com/gpizzorno/research-helpers
+Project-URL: Issues, https://github.com/gpizzorno/research-helpers/issues
+Project-URL: Changelog, https://github.com/gpizzorno/research-helpers/blob/main/CHANGELOG.md
+Keywords: research,latex,arxiv,zenodo,matplotlib,reproducibility,slurm,parameter-sweep
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Text Processing :: Markup :: LaTeX
+Classifier: Typing :: Typed
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: figures
+Requires-Dist: matplotlib; extra == "figures"
+Requires-Dist: seaborn; extra == "figures"
+Provides-Extra: log
+Requires-Dist: colorama; extra == "log"
+Requires-Dist: structlog; extra == "log"
+Requires-Dist: tqdm; extra == "log"
+Provides-Extra: latex
+Provides-Extra: sweep
+Requires-Dist: pandas; extra == "sweep"
+Requires-Dist: pyarrow; extra == "sweep"
+Provides-Extra: dev
+Requires-Dist: research-helpers[figures,latex,log,sweep]; extra == "dev"
+Requires-Dist: factory_boy; extra == "dev"
+Requires-Dist: hypothesis; extra == "dev"
+Requires-Dist: pillow; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-mock; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: ty; extra == "dev"
+Requires-Dist: types-requests; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: research-helpers[figures,latex,log,sweep]; extra == "docs"
+Requires-Dist: sphinx>=7.2.0; extra == "docs"
+Requires-Dist: sphinx-rtd-theme>=2.0.0; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints>=1.25.0; extra == "docs"
+Requires-Dist: sphinxcontrib-mermaid>=1.0.0; extra == "docs"
+Requires-Dist: myst-parser>=2.0.0; extra == "docs"
+Dynamic: license-file
+
+# Research Helpers
+
+[![License](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
+[![Python](https://img.shields.io/badge/Language-Python-blue.svg)](https://www.python.org)
+[![Tests](https://github.com/gpizzorno/research-helpers/actions/workflows/tests.yml/badge.svg)](https://github.com/gpizzorno/research-helpers/actions/workflows/tests.yml)
+[![Documentation](https://img.shields.io/badge/Docs-latest-blue.svg)](https://gpizzorno.github.io/research-helpers/)
+
+**Research Helpers** is 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](https://arxiv.org)
+and [Zenodo](https://zenodo.org), structured logging, and a parameter-sweep engine for [scheduler](https://slurm.schedmd.com/overview.html) job arrays.
+
+[Read the documentation](https://gpizzorno.github.io/research-helpers/)
+
+## Features
+
+- **Generated Tables and Figures**: Build the paper's tables and figures from the repository's own data
+- **Drift Detection**: Detect when the paper and the data differ
+- **LaTeX Assembly**: Compose tables for LaTeX and also display them in Jupyter
+- **Shared Figure Styling**: Consistent look across LaTeX and Jupyter
+- **Submission Packaging**: Automatic preparation and pre-checking for arXiv and Zenodo
+- **Parameter Sweeps**: Plan a grid, run it as a scheduler job array, resume if necessary, and collect the results
+- **Structured Logging**: Console and file output at separate levels, with progress bars and colour output
+
+## Installation
+
+The core package has no third-party dependencies. Capabilities are installed as extras:
+
+```sh
+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.
+
+## Quick Start
+
+### Wire up the project
+
+A project's wiring—*i.e.*, where the paper lives, how wide it is, where runs are written—goes in the
+`[tool.research-helpers]` section of the `pyproject.toml` file.
+
+```toml
+[tool.research-helpers.paper]
+main = "tex/paper.tex"
+tables-dir = "tex/tables"
+figures-dir = "tex/figures"
+text-width-pt = 468.0 # as reported by \showthe\textwidth
+
+[tool.research-helpers.figures]
+profile = "print"
+palette = "colorblind"
+dpi = 300
+```
+
+`research-helpers doctor` shows every setting, the value in force, and where it came from.
+
+Keys and values are described in the [configuration reference](https://gpizzorno.github.io/research-helpers/configuration.html).
+
+### Generate a table from data
+
+```python
+import json
+
+from research_helpers.build import TABLES, Registry
+from research_helpers.latex import half_up, header, table
+
+tables = Registry(TABLES)
+
+
+@tables.register('tab:scores')
+def scores() -> str:
+    """Accuracy on the held-out set."""
+    data = json.loads(SCORES_PATH.read_text())
+    return table(
+        spec='lr',
+        header_rows=[[header('System'), header('Accuracy')]],
+        body_rows=[[name.title(), half_up(v['accuracy'] * 100)] for name, v in data.items()],
+        caption='Accuracy on the held-out set.',
+        label='tab:scores',
+    )
+
+
+if __name__ == '__main__':
+    raise SystemExit(tables.main())
+```
+
+The label names the file, so this is written to `scores.tex` and the paper reads it with
+`\input{tables/scores}`:
+
+```console
+$ python -m demo.tables --install
+wrote build/tables/scores.tex
+installed tex/tables/scores.tex
+```
+
+### Check for drift
+
+```console
+$ python -m demo.tables --check
+OK: all 1 tables in the paper are current
+```
+
+If the data is changed without rebuilding, the check fails:
+
+```console
+$ python -m demo.tables --check
+stale, the paper is behind the data: tab:scores
+to fix: rebuild and install the tables
+$ echo $?
+1
+```
+
+For a full example, see [adding a generated table](https://gpizzorno.github.io/research-helpers/guide/generated-table.html).
+
+### Style a figure for the page
+
+```python
+import matplotlib.pyplot as plt
+
+from research_helpers.figures import apply_style, save
+
+apply_style(profile='print')  # \textwidth across, paper font sizes
+fig, ax = plt.subplots()  # the profile's size is already in rcParams
+ax.plot(iterations, accuracy, marker='o')
+save(fig, 'tex/figures/learning-curve.png')
+```
+
+See details in the [figures guide](https://gpizzorno.github.io/research-helpers/guide/figures.html).
+
+### Run a parameter sweep
+
+```python
+from research_helpers.sweep import Sweep
+
+sweep = Sweep()
+
+
+@sweep.context
+def prepare(manifest, run_dir):
+    """Loaded once per array task."""
+    return load_corpus(manifest.metadata['corpus'])
+
+
+@sweep.evaluate
+def evaluate(params, corpus):
+    """One parameter combination."""
+    return {'f1': score(corpus, **params)}
+
+
+if __name__ == '__main__':
+    raise SystemExit(sweep.main())
+```
+
+```console
+$ python sweep_demo.py plan --config sweep.toml --run-dir runs/demo --tasks 4
+planned 12 combinations over 4 array tasks (~3 per task)
+manifest: runs/demo/manifest.json
+
+submit with:
+  sbatch --array=1-4 <your sbatch script> runs/demo
+```
+
+The manifest is written once and the tasks read it, so re-submitting the two that were killed
+reproduces exactly their original slices instead of repartitioning the grid. Resumption is per
+combination, not per task, so a job that hits its walltime keeps everything it finished.
+`status` and `run` need only the standard library, so nothing needs to be installed to run a 
+progress check from a login node.
+
+Full details are discussed in the [sweeps guide](https://gpizzorno.github.io/research-helpers/guide/sweeps.html).
+
+### Package a submission
+
+```console
+$ research-helpers arxiv --dry-run
+  paper.tex                       43.1 KB
+  paper.bbl                       82.1 KB
+  tables/scores.tex                0.3 KB
+  figures/learning-curve.png      66.3 KB
+
+  4 files, 0.19 MB
+  bbl format 3.3 (TeX Live 2025)
+
+ready to upload: select xelatex and TeX Live 2025
+
+(dry run, nothing written)
+```
+
+The target files are keyed by the path they take *inside* the submission, so what resolves locally 
+will also resolve at the destination. The checks cover filenames arXiv rejects, a `.bbl` that is missing, 
+stale, or in a format the selected TeX Live will not read, and `microtype` font expansion under an engine 
+that has none. `--tar` packs it reproducibly, so re-packing an unchanged submission gives an identical
+file.
+
+See the [submission guide](https://gpizzorno.github.io/research-helpers/guide/submission.html).
+
+### Logging
+
+```python
+from research_helpers.log import get_logger, setup_logging
+
+setup_logging()
+log = get_logger(__name__)
+
+log.info('scoring', corpus='perseus', sentences=18_000)
+```
+
+```console
+[INFO    ] 19:41:47 __main__ scoring (corpus=perseus, sentences=18000)
+```
+
+The console and the log file take separate levels. Colour is applied only when the stream is a terminal, 
+so no escape codes are included in a redirected log.
+
+Details in the [logging guide](https://gpizzorno.github.io/research-helpers/guide/logging.html).
+
+## Documentation
+
+The full documentation includes:
+
+- **[Configuration](https://gpizzorno.github.io/research-helpers/configuration.html)**: Every section, key, type, and default, plus units and settings resolution
+- **[Guides](https://gpizzorno.github.io/research-helpers/guide/index.html)**: Task-focused walkthroughs
+  - [Adding a generated table](https://gpizzorno.github.io/research-helpers/guide/generated-table.html): Full table pipeline
+  - [Figures](https://gpizzorno.github.io/research-helpers/guide/figures.html): Profiles, scoped styling, saving versus rendering
+  - [LaTeX tables](https://gpizzorno.github.io/research-helpers/guide/tables.html): Assembling tables and reading them back
+  - [Parameter sweeps](https://gpizzorno.github.io/research-helpers/guide/sweeps.html): Planning, running, resuming, and collecting
+  - [arXiv and Zenodo](https://gpizzorno.github.io/research-helpers/guide/submission.html): Submission checks and reproducible archives
+  - [Logging](https://gpizzorno.github.io/research-helpers/guide/logging.html): Setup, levels, colour, and progress bars
+- **[API Reference](https://gpizzorno.github.io/research-helpers/api/index.html)**: Complete API documentation
+
+## License
+
+The project is licensed under the [MIT License](LICENSE), allowing free use, modification, and distribution.

research_helpers-1.0.0/README.md

@@ -0,0 +1,235 @@
+# Research Helpers
+
+[![License](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
+[![Python](https://img.shields.io/badge/Language-Python-blue.svg)](https://www.python.org)
+[![Tests](https://github.com/gpizzorno/research-helpers/actions/workflows/tests.yml/badge.svg)](https://github.com/gpizzorno/research-helpers/actions/workflows/tests.yml)
+[![Documentation](https://img.shields.io/badge/Docs-latest-blue.svg)](https://gpizzorno.github.io/research-helpers/)
+
+**Research Helpers** is 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](https://arxiv.org)
+and [Zenodo](https://zenodo.org), structured logging, and a parameter-sweep engine for [scheduler](https://slurm.schedmd.com/overview.html) job arrays.
+
+[Read the documentation](https://gpizzorno.github.io/research-helpers/)
+
+## Features
+
+- **Generated Tables and Figures**: Build the paper's tables and figures from the repository's own data
+- **Drift Detection**: Detect when the paper and the data differ
+- **LaTeX Assembly**: Compose tables for LaTeX and also display them in Jupyter
+- **Shared Figure Styling**: Consistent look across LaTeX and Jupyter
+- **Submission Packaging**: Automatic preparation and pre-checking for arXiv and Zenodo
+- **Parameter Sweeps**: Plan a grid, run it as a scheduler job array, resume if necessary, and collect the results
+- **Structured Logging**: Console and file output at separate levels, with progress bars and colour output
+
+## Installation
+
+The core package has no third-party dependencies. Capabilities are installed as extras:
+
+```sh
+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.
+
+## Quick Start
+
+### Wire up the project
+
+A project's wiring—*i.e.*, where the paper lives, how wide it is, where runs are written—goes in the
+`[tool.research-helpers]` section of the `pyproject.toml` file.
+
+```toml
+[tool.research-helpers.paper]
+main = "tex/paper.tex"
+tables-dir = "tex/tables"
+figures-dir = "tex/figures"
+text-width-pt = 468.0 # as reported by \showthe\textwidth
+
+[tool.research-helpers.figures]
+profile = "print"
+palette = "colorblind"
+dpi = 300
+```
+
+`research-helpers doctor` shows every setting, the value in force, and where it came from.
+
+Keys and values are described in the [configuration reference](https://gpizzorno.github.io/research-helpers/configuration.html).
+
+### Generate a table from data
+
+```python
+import json
+
+from research_helpers.build import TABLES, Registry
+from research_helpers.latex import half_up, header, table
+
+tables = Registry(TABLES)
+
+
+@tables.register('tab:scores')
+def scores() -> str:
+    """Accuracy on the held-out set."""
+    data = json.loads(SCORES_PATH.read_text())
+    return table(
+        spec='lr',
+        header_rows=[[header('System'), header('Accuracy')]],
+        body_rows=[[name.title(), half_up(v['accuracy'] * 100)] for name, v in data.items()],
+        caption='Accuracy on the held-out set.',
+        label='tab:scores',
+    )
+
+
+if __name__ == '__main__':
+    raise SystemExit(tables.main())
+```
+
+The label names the file, so this is written to `scores.tex` and the paper reads it with
+`\input{tables/scores}`:
+
+```console
+$ python -m demo.tables --install
+wrote build/tables/scores.tex
+installed tex/tables/scores.tex
+```
+
+### Check for drift
+
+```console
+$ python -m demo.tables --check
+OK: all 1 tables in the paper are current
+```
+
+If the data is changed without rebuilding, the check fails:
+
+```console
+$ python -m demo.tables --check
+stale, the paper is behind the data: tab:scores
+to fix: rebuild and install the tables
+$ echo $?
+1
+```
+
+For a full example, see [adding a generated table](https://gpizzorno.github.io/research-helpers/guide/generated-table.html).
+
+### Style a figure for the page
+
+```python
+import matplotlib.pyplot as plt
+
+from research_helpers.figures import apply_style, save
+
+apply_style(profile='print')  # \textwidth across, paper font sizes
+fig, ax = plt.subplots()  # the profile's size is already in rcParams
+ax.plot(iterations, accuracy, marker='o')
+save(fig, 'tex/figures/learning-curve.png')
+```
+
+See details in the [figures guide](https://gpizzorno.github.io/research-helpers/guide/figures.html).
+
+### Run a parameter sweep
+
+```python
+from research_helpers.sweep import Sweep
+
+sweep = Sweep()
+
+
+@sweep.context
+def prepare(manifest, run_dir):
+    """Loaded once per array task."""
+    return load_corpus(manifest.metadata['corpus'])
+
+
+@sweep.evaluate
+def evaluate(params, corpus):
+    """One parameter combination."""
+    return {'f1': score(corpus, **params)}
+
+
+if __name__ == '__main__':
+    raise SystemExit(sweep.main())
+```
+
+```console
+$ python sweep_demo.py plan --config sweep.toml --run-dir runs/demo --tasks 4
+planned 12 combinations over 4 array tasks (~3 per task)
+manifest: runs/demo/manifest.json
+
+submit with:
+  sbatch --array=1-4 <your sbatch script> runs/demo
+```
+
+The manifest is written once and the tasks read it, so re-submitting the two that were killed
+reproduces exactly their original slices instead of repartitioning the grid. Resumption is per
+combination, not per task, so a job that hits its walltime keeps everything it finished.
+`status` and `run` need only the standard library, so nothing needs to be installed to run a 
+progress check from a login node.
+
+Full details are discussed in the [sweeps guide](https://gpizzorno.github.io/research-helpers/guide/sweeps.html).
+
+### Package a submission
+
+```console
+$ research-helpers arxiv --dry-run
+  paper.tex                       43.1 KB
+  paper.bbl                       82.1 KB
+  tables/scores.tex                0.3 KB
+  figures/learning-curve.png      66.3 KB
+
+  4 files, 0.19 MB
+  bbl format 3.3 (TeX Live 2025)
+
+ready to upload: select xelatex and TeX Live 2025
+
+(dry run, nothing written)
+```
+
+The target files are keyed by the path they take *inside* the submission, so what resolves locally 
+will also resolve at the destination. The checks cover filenames arXiv rejects, a `.bbl` that is missing, 
+stale, or in a format the selected TeX Live will not read, and `microtype` font expansion under an engine 
+that has none. `--tar` packs it reproducibly, so re-packing an unchanged submission gives an identical
+file.
+
+See the [submission guide](https://gpizzorno.github.io/research-helpers/guide/submission.html).
+
+### Logging
+
+```python
+from research_helpers.log import get_logger, setup_logging
+
+setup_logging()
+log = get_logger(__name__)
+
+log.info('scoring', corpus='perseus', sentences=18_000)
+```
+
+```console
+[INFO    ] 19:41:47 __main__ scoring (corpus=perseus, sentences=18000)
+```
+
+The console and the log file take separate levels. Colour is applied only when the stream is a terminal, 
+so no escape codes are included in a redirected log.
+
+Details in the [logging guide](https://gpizzorno.github.io/research-helpers/guide/logging.html).
+
+## Documentation
+
+The full documentation includes:
+
+- **[Configuration](https://gpizzorno.github.io/research-helpers/configuration.html)**: Every section, key, type, and default, plus units and settings resolution
+- **[Guides](https://gpizzorno.github.io/research-helpers/guide/index.html)**: Task-focused walkthroughs
+  - [Adding a generated table](https://gpizzorno.github.io/research-helpers/guide/generated-table.html): Full table pipeline
+  - [Figures](https://gpizzorno.github.io/research-helpers/guide/figures.html): Profiles, scoped styling, saving versus rendering
+  - [LaTeX tables](https://gpizzorno.github.io/research-helpers/guide/tables.html): Assembling tables and reading them back
+  - [Parameter sweeps](https://gpizzorno.github.io/research-helpers/guide/sweeps.html): Planning, running, resuming, and collecting
+  - [arXiv and Zenodo](https://gpizzorno.github.io/research-helpers/guide/submission.html): Submission checks and reproducible archives
+  - [Logging](https://gpizzorno.github.io/research-helpers/guide/logging.html): Setup, levels, colour, and progress bars
+- **[API Reference](https://gpizzorno.github.io/research-helpers/api/index.html)**: Complete API documentation
+
+## License
+
+The project is licensed under the [MIT License](LICENSE), allowing free use, modification, and distribution.