Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proposal: MetoceanReport writer class to modularize automatic report writing #71

Open
efvik opened this issue Dec 9, 2024 · 0 comments

Comments

@efvik
Copy link
Collaborator

efvik commented Dec 9, 2024

I suggest we make a class representing a general metocean report. We can have methods which add sections or sub-sections at a time, to allow us to modularize the content. In order to make any numbering (sections, figures, tables, TOC) automatic, the actual docx report should only be compiled at the end, even if the tables and figures are generated on the fly.

An example of how I imagine the api:

  • report = MetoceanReport(title, author, titlepage_info)
  • report.add_meteorology_section(data, customization_params)
  • report.add_oceanography_section(data, customization_params)
  • report.compile("automatic_report.docx")
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant