Research Helpers

Documentation

  • Configuration
    • Three layers of resolution
    • Complete example
    • Subsections
      • paper
      • Units
      • figures
      • log
      • sweep
      • arxiv
    • 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
      • Figures work the same way
    • Figures
      • Profiles
      • Scoped styling
      • Saving versus rendering
      • Long tick labels
      • Checking current settings
    • LaTeX tables
      • Assembling
      • The helpers
      • Reading a table back
    • Parameter sweeps
      • Define the sweep
      • Configure the grid
      • Plan
      • Run
      • Status
      • Collect
      • Sizing the array
      • Submitting
    • arXiv and Zenodo
      • arXiv
      • Reproducible archives
    • Logging
      • Setup
      • Console and file levels
      • Colour
      • Multiple concurrent log files
      • Progress bars
  • Reference
    • research_helpers.project
      • ConfigWarning
      • ProjectRootNotFoundError
      • PaperSettings
      • FigureSettings
      • LogSettings
      • SweepSettings
      • ArxivSettings
      • Project
      • current_project()
      • resolve()
      • find_project_root()
    • research_helpers.build
      • Kind
      • Artefact
      • Drift
      • Registry
    • research_helpers.latex
      • table()
      • header()
      • half_up()
      • bare()
      • dash_range()
    • research_helpers.display
      • Row
      • Table
      • parse()
      • show()
    • research_helpers.figures
      • current_settings()
      • apply_style()
      • style()
      • save()
      • render()
      • fit_x()
    • research_helpers.arxiv
      • manifest()
      • 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
      • collect_results()
      • read_parts()
      • run_status()
      • Manifest
      • combination_id()
      • expand_grid()
      • slice_bounds()
      • completed_ids()
      • run_slice()
      • task_index_from_env()
      • Sweep
      • estimate_runtime()
      • read_config()
Research Helpers
  • Overview: module code

All modules for which code is available

  • research_helpers.archive
  • research_helpers.arxiv
  • research_helpers.build
  • research_helpers.display
  • research_helpers.figures
  • research_helpers.latex
  • research_helpers.log.config
  • research_helpers.log.formatters
  • research_helpers.log.handlers
  • research_helpers.log.tqdm_integration
  • research_helpers.project
  • research_helpers.sweep.collect
  • research_helpers.sweep.grid
  • research_helpers.sweep.runner
  • research_helpers.sweep.sweep

© Copyright 2026, Gabe Pizzorno.