Skip to content

WIP: Summary PDF rework#145

Draft
mtlam wants to merge 7 commits intomainfrom
feature/summary_pdf_rework
Draft

WIP: Summary PDF rework#145
mtlam wants to merge 7 commits intomainfrom
feature/summary_pdf_rework

Conversation

@mtlam
Copy link
Copy Markdown
Member

@mtlam mtlam commented Jan 26, 2026

From our discussions, this PR is intended to revamp the summary PDFs. Not all of the information will transfer to a new PDF, and some is moved to either a revamped par_checker or CI. This uses a spiritual successor to report.py, but instead of logging information as it streams in, the report must be actively built.

Included files:

  • markdownreport.py - includes the MarkdownSection and MarkdownReport classes. These act more generically and are used to store and generate the appropriate information.
  • summarizer.py - include the Summarizer class used to generate the report. These include timing-specific calls and glues everything together.

To-dos:

  • Finish transferring items from old pdf_writer()
  • Remove or deprecate old pdf_writer()
  • Unit testing
    • markdownreport
    • summarizer

@mtlam mtlam added enhancement New feature or request discussed Discussed during a NANOGrav GitFlowers Meeting. labels Jan 26, 2026
@mtlam mtlam added this to the NG20 v2.0 requirements milestone Jan 26, 2026
@mtlam mtlam self-assigned this Jan 26, 2026
@mtlam mtlam mentioned this pull request Feb 7, 2026
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

discussed Discussed during a NANOGrav GitFlowers Meeting. enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant