Research Helpers

Documentation

  • Configuration
    • Three layers of resolution
    • Complete example
    • Subsections
      • paper
      • Units
      • figures
      • log
      • sweep
      • arxiv
      • latex
      • documents
      • Without the manuscript
    • Checking settings resolution
    • Overriding the root
    • Reading settings
  • Guides
    • Adding a generated table
      • 1. Wire the project
      • 2. Write the emitter
      • 3. Reference the table from the paper
      • 4. Build the table
      • 5. Install the table
      • 6. Scenarios covered by the check
      • 7. The check can be used in CI
      • 8. Publishing the floats without the paper
      • Figures work the same way
    • Numbers in the prose
      • Register a sentence
      • Check
      • Known discrepancies
      • Find untracked values
      • In a test suite
      • More than one document
    • Several documents
      • Configure the second document
      • One Document per manuscript
    • Figures
      • Profiles
      • Scoped styling
      • Saving versus rendering
      • Long tick labels
      • Checking current settings
    • LaTeX tables
      • Assembling
      • The helpers
      • Maths in the table’s typeface
      • Reading a table back
    • Parameter sweeps
      • Define the sweep
      • Configure the grid
      • Plan
      • Run
      • Status
      • Collect
      • Artefacts
      • Aggregating several runs
      • Sizing the array
      • Submitting
    • Many sweeps through few arrays
      • Plan the campaign
      • Write the queue
      • Run it
      • Resume
      • Elements that ran twice
    • Cluster jobs
      • What the templates handle
      • Single jobs
      • Resubmitting
    • arXiv and Zenodo
      • arXiv
      • Reproducible archives
    • Logging
      • Setup
      • Console and file levels
      • Other libraries
      • Colour
      • Multiple concurrent log files
      • Progress bars
  • Reference
    • research_helpers.project
      • ConfigWarning
      • ProjectRootNotFoundError
      • PaperSettings
      • FigureSettings
      • LogSettings
      • SweepSettings
      • ArxivSettings
      • LatexSettings
      • Project
      • current_project()
      • resolve()
      • find_project_root()
    • research_helpers.build
      • Kind
      • Artefact
      • Drift
      • Registry
      • Document
    • research_helpers.prose
      • normalise_prose()
      • ProseNumber
      • Mismatch
      • ProseCheck
      • Occurrence
      • ProseRegistry
      • audit()
      • audit_report()
    • research_helpers.latex
      • table()
      • header()
      • half_up()
      • bare()
      • dash_range()
      • packages()
    • research_helpers.textmath
      • UnsupportedMathError
      • render()
      • to_text()
      • convert()
    • research_helpers.display
      • Row
      • Table
      • parse()
      • show()
    • research_helpers.figures
      • current_settings()
      • apply_style()
      • style()
      • save()
      • render()
      • fit_x()
    • research_helpers.arxiv
      • manifest()
      • unused()
      • bbl_format()
      • check()
      • build()
      • pack()
      • preview()
      • report()
    • research_helpers.archive
      • digest()
      • normalise()
      • write_archive()
      • archive_directory()
      • write_checksums()
    • research_helpers.log
      • get_logger()
      • reset_logging()
      • set_log_file()
      • setup_logging()
      • Renderer
      • MultiFileHandler
      • LoggingTqdm
      • progress()
    • research_helpers.sweep
      • aggregate_runs()
      • array_spec()
      • collect_results()
      • leading_columns()
      • missing_task_indices()
      • read_parts()
      • run_status()
      • Manifest
      • combination_id()
      • expand_grid()
      • restore_tuples()
      • slice_bounds()
      • Unit
      • build_units()
      • chunk()
      • expand_run_dirs()
      • quarantine()
      • read_plan_list()
      • read_units()
      • select_run_dirs()
      • shuffled()
      • write_queues()
      • artefact_path()
      • completed_ids()
      • jsonable()
      • read_artefact()
      • run_slice()
      • task_index_from_env()
      • Interval
      • confidence_interval()
      • student_t_quantile()
      • Sweep
      • estimate_runtime()
      • read_config()
      • research_helpers.sweep.stats
      • research_helpers.sweep.queue
Research Helpers
  • Guides
  • Edit on GitHub

Guides

  • Adding a generated table
  • Numbers in the prose
  • Several documents
  • Figures
  • LaTeX tables
  • Parameter sweeps
  • Many sweeps through few arrays
  • Cluster jobs
  • arXiv and Zenodo
  • Logging

The guides are task-focused. For the complete API see the Reference.

Previous Next

© Copyright 2026, Gabe Pizzorno.