Skip to content

Simplify the reference-results-metadata file - #894

Open
MakisH wants to merge 6 commits into
developfrom
update-reference-results-metadata
Open

Simplify the reference-results-metadata file#894
MakisH wants to merge 6 commits into
developfrom
update-reference-results-metadata

Conversation

@MakisH

@MakisH MakisH commented Aug 9, 2026

Copy link
Copy Markdown
Member

The current metadata file is named reference-results-metadata.txt, but it is a Markdown file.

Some information in that file is not particularly useful: once the host is known, the CPU information is automatically known, and reproducibility across systems is not intended.

There is currently a missing blank line:

| PRECICE_UID | 1003 |
| PRECICE_GID | 1003 |
## Information about the machine

### uname -a

This PR:

Follow-up of #882.

Tested in https://github.com/precice/tutorials/actions/runs/31333057244, leads to:

<!---
This file has been generated by the generate_reference_results.py script and should not be manually modified
-->

# Reference results

- Archive: `fluid-openfoam_solid-cpp.tar.gz`
- Generated at: `2026-08-09 22:03:44`
- Host: `Linux precice-tests 5.15.0-186-generic #196-Ubuntu SMP Sat Jun 20 16:09:34 UTC 2026 x86_64 x86_64 x86_64 GNU/Linux
`

## System tests arguments used to generate the results

| name | value |
| --- | --- |
| `PLATFORM` | `ubuntu_2404` |
| `CALCULIX_VERSION` | `2.20` |
...

@MakisH
MakisH marked this pull request as ready for review August 9, 2026 20:07
@MakisH
MakisH requested a review from PranjalManhgaye August 9, 2026 20:07
shutil.copytree(exports_dir, exports_staging)
try:
(exports_staging / "reference-results-metadata.txt").write_text(metadata)
(exports_staging / "reference-results-metadata.md").write_text(metadata)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, naming that .reference-results-metadata.md would place it at the top of the file list, at least for my archive manager. I can rename it tomorrow.

@PranjalManhgaye

Copy link
Copy Markdown
Collaborator

@MakisH looks good to me, and renaming to .md and dropping lscpu makes the metadata much easier to read, Thanks its much cleaner now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants