ukaea / ukaea/PROCESS

Output summary report

Open
#1,470 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Input/Output Files
Dominant language
Python
Stars
71
Forks
27
Avg merge
2d 18h
Merged PRs (30d)
33

Description

Process needs to output a summary report (PDF) after a run. James's output_summary.py utility should be re-instated as part of the process package and potentially refactored. This output functionality should be easily accessible from the Process package, and demonstrated in a run script.

This may also want to make use of a revised output object/file: this requires separate consideration.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating James's output_summary.py utility and the process package, then inspect an existing run script. Clarify how the PDF summary should be exposed and whether the revised output object/file is in scope; done means the utility is integrated, accessible from the package, and demonstrated in a run script.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.