Move reference_results.metadata into reference-results/ directory#721
Move reference_results.metadata into reference-results/ directory#721Geethapranay1 wants to merge 1 commit intoprecice:developfrom
Conversation
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
a4ad032 to
771aecb
Compare
There was a problem hiding this comment.
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.pyto write metadata files insidereference-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) |
There was a problem hiding this comment.
This line contains trailing whitespace. Please remove the trailing spaces after exist_ok=True).
| reference_results_dir.mkdir(parents=True, exist_ok=True) | |
| reference_results_dir.mkdir(parents=True, exist_ok=True) |
|
@Geethapranay1 how have you tested this? Any logs would help. |

Fixes #537
Moves
reference_results.metadatafrom the tutorial root directory into thereference-results/directory, colocating it with the.tar.gzreference result files it describes.Before
After
Changes
reference-results/for all tutorials:elastic-tube-1dflow-over-heated-platemultiple-perpendicular-flapsperpendicular-flaptools/tests/generate_reference_results.pyto write metadata inside thereference-results/directory.github/workflows/generate_reference_results_workflow.ymlto use the newgit addpattern.Checklist
changelog-entries/537.md.