ukaea / ukaea/PROCESS

Output file format

Open
#1,096 9 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

The output format of the MFILE.DAT and OUT.DAT is currently plain text. It could be advantageous to output these as TOML or similar, to standardise the output format whilst maintaining human readability.

This ties in with also being able to "dump" the final state of the program into a format that can be loaded again for analysis etc. Perhaps pickling is a better (if non-human readable) option here, as Python objects can be serialised with pickle. Perhaps this should be a different, if closely related, issue.

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 the code that writes MFILE.DAT and OUT.DAT, then review the discussion of TOML, other human-readable formats, and Python pickle serialization. Done requires an agreed output format and a defined way to save and reload the program’s final state.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.