Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Yaml config files #355

Merged
merged 13 commits into from
Nov 19, 2024
Merged

Yaml config files #355

merged 13 commits into from
Nov 19, 2024

Conversation

dodu94
Copy link
Member

@dodu94 dodu94 commented Nov 6, 2024

Description

TO BE REVIEWED AFTER MERGE OF #333

This PR implements a change in the configuration files for computational benchmarks which will now be in .yaml format instead of .xlsx. Eventually, all configuration files should move to either .yaml of .toml format as .xlsx are not correctly tracked by git.

The legacy behaviour is mantained for all non-computational benchmarks.

Additional dependencies introduced.

  • pyyaml

Type of change

Please select what type of change this is.

  • Bug fix (non-breaking change which fixes an issue)
  • New benchmark
    • Non-breaking change which entirely uses exisiting classes, structure etc
    • Breaking change which has implemented new/modified classes etc
  • New feature
    • Non-breaking change which adds functionality
    • Breaking change fix or feature that would cause existing functionality to not work as expected

Other changes

  • This change requires a documentation update
  • (If Benchmark) This requires additional data that can be obtained from:
    • Benchmark data 1
    • Benchamrk data 2

Testing

Suitable tests have been added to the CI suite.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • General testing
    • New and existing unit tests pass locally with my changes
    • Coverage is >80%

Copy link

codecov bot commented Nov 7, 2024

Codecov Report

Attention: Patch coverage is 96.29630% with 6 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
jade/output.py 94.44% 4 Missing ⚠️
jade/configuration.py 97.01% 2 Missing ⚠️
Files with missing lines Coverage Δ
jade/plotter.py 95.97% <100.00%> (-0.09%) ⬇️
jade/configuration.py 80.55% <97.01%> (+14.32%) ⬆️
jade/output.py 93.03% <94.44%> (+0.24%) ⬆️

... and 1 file with indirect coverage changes


🚨 Try these New Features:

@dodu94 dodu94 marked this pull request as ready for review November 18, 2024 14:55

# Example of an extract from a benchmark configuration file, Excel section
Excel:
4.0:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Some cases the tally number is a float, other cases just an integer. Minor, I guess just by product of conversion script?

Copy link
Member Author

Choose a reason for hiding this comment

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

correct, I kept both to be sure that it works in both cases just to be sure

identifier: 244
plot_type: Ratio graph
quantity: Photon Flux
unit: '#/cc/n_s'
Copy link
Collaborator

Choose a reason for hiding this comment

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

some units contained in apostrophes, others not. Reflected in the output?

Copy link
Member Author

Choose a reason for hiding this comment

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

I double checked, they are both read as string independently of the use of quotes fortunately

11:
identifier: 11
plot_type: Grouped bars
quantity: 'Neutron current '
Copy link
Collaborator

Choose a reason for hiding this comment

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

Some quantities (Neutron current) are in quotes. Others note. Reflected in ouput?

Copy link
Member Author

Choose a reason for hiding this comment

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

I double checked, they are both read as string independently of the use of quotes fortunately

Copy link
Collaborator

@alexvalentine94 alexvalentine94 left a comment

Choose a reason for hiding this comment

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

Thanks Davide, a nice enhancement. Happy to approve, outstanding comments minor and looks to me not be impactful. Leave to you to merge if happy.

@dodu94 dodu94 merged commit c35d668 into developing Nov 19, 2024
9 checks passed
@dodu94 dodu94 deleted the yaml_config_files branch November 19, 2024 13:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants