Skip to content

Comments

Move reference_results.metadata into reference-results/ directory#721

Open
Geethapranay1 wants to merge 1 commit intoprecice:developfrom
Geethapranay1:fix/move-metadata-into-reference-results
Open

Move reference_results.metadata into reference-results/ directory#721
Geethapranay1 wants to merge 1 commit intoprecice:developfrom
Geethapranay1:fix/move-metadata-into-reference-results

Conversation

@Geethapranay1
Copy link

@Geethapranay1 Geethapranay1 commented Feb 24, 2026

Fixes #537

Moves reference_results.metadata from the tutorial root directory into the reference-results/ directory, colocating it with the .tar.gz reference result files it describes.

Before

tutorial/
├── reference-results/
│   └── results.tar.gz
└── reference_results.metadata

After

tutorial/
└── reference-results/
    ├── results.tar.gz
    └── reference_results.metadata

Changes

  • moved metadata files into reference-results/ for all tutorials:
    • elastic-tube-1d
    • flow-over-heated-plate
    • multiple-perpendicular-flaps
    • perpendicular-flap
  • updated tools/tests/generate_reference_results.py to write metadata inside the reference-results/ directory
  • updated .github/workflows/generate_reference_results_workflow.yml to use the new git add pattern.

Checklist

  • I added a summary of any user-facing changes (compared to the last release) in the changelog-entries/537.md.
  • I will remember to squash-and-merge, providing a useful summary of the changes of this PR.

fixes precice#537

Moved reference_results.metadata from tutorial root into the
reference-results/ directory to colocate it with the .tar.gz
files it describes.

Changes:
- moved metadata files into reference-results/ for all tutorials
- updated generate_reference_results.py to write to new location
- updated gitHub workflow git add pattern to match new location
@Geethapranay1 Geethapranay1 force-pushed the fix/move-metadata-into-reference-results branch from a4ad032 to 771aecb Compare February 24, 2026 09:11
@MakisH MakisH self-assigned this Feb 24, 2026
@MakisH MakisH added systemtests GSoC Contributed in the context of the Google Summer of Code labels Feb 24, 2026
@MakisH MakisH requested a review from Copilot February 24, 2026 09:41
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR reorganizes the reference results metadata files by moving them from tutorial root directories into their respective reference-results/ subdirectories, colocating them with the .tar.gz reference result archives they describe. This addresses issue #537 which noted that having the metadata files outside the reference results directory "just looks odd."

Changes:

  • Modified generate_reference_results.py to write metadata files inside reference-results/ directories
  • Updated GitHub workflow to use the new git add pattern for metadata files
  • Moved metadata files for 4 tutorials into their reference-results/ directories

Reviewed changes

Copilot reviewed 3 out of 7 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
tools/tests/generate_reference_results.py Updated to create and write metadata files in reference-results/ subdirectory instead of tutorial root
.github/workflows/generate_reference_results_workflow.yml Updated git add pattern to match new metadata file location
perpendicular-flap/reference-results/reference_results.metadata Added metadata file in new location
multiple-perpendicular-flaps/reference-results/reference_results.metadata Added metadata file in new location
flow-over-heated-plate/reference-results/reference_results.metadata Added metadata file in new location
elastic-tube-1d/reference-results/reference_results.metadata Added metadata file in new location
changelog-entries/537.md Documented the change in changelog

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

for tutorial in reference_result_per_tutorial.keys():
with open(tutorial.path / "reference_results.metadata", 'w') as file:
reference_results_dir = tutorial.path / "reference-results"
reference_results_dir.mkdir(parents=True, exist_ok=True)
Copy link

Copilot AI Feb 24, 2026

Choose a reason for hiding this comment

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

This line contains trailing whitespace. Please remove the trailing spaces after exist_ok=True).

Suggested change
reference_results_dir.mkdir(parents=True, exist_ok=True)
reference_results_dir.mkdir(parents=True, exist_ok=True)

Copilot uses AI. Check for mistakes.
@MakisH
Copy link
Member

MakisH commented Feb 24, 2026

@Geethapranay1 how have you tested this? Any logs would help.

@Geethapranay1
Copy link
Author

1.files moved to new location:
image

2. generation script updated:

3. workflow pattern updated:

the changes only affect file paths the metadata content, format, and generation logic remain unchanged. The script correctly writes to the new location and the workflow pattern picks up files from there.

running the full docker-based generation test to confirm end-to-end. Will update with logs once complete.

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

Labels

GSoC Contributed in the context of the Google Summer of Code systemtests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Reference results metadata is outside the reference_results directory

2 participants