Sanity Checks for Input Parameters #115
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…t beign ignored: - within the `arg_config_manager.py` a new function `str2bool` ensures all types of boolean are accpeted - `setup_argsparse` has been updated to ensure if `property` is a type `bool` it is handled correctly - additional test cases to ensure that the modified `setup_argsparse` and the `str2bool` function works as intended
…s are now visible on the output
… the input parameters
jimboid
approved these changes
Jun 27, 2025
Member
jimboid
left a comment
jimboid
left a comment
There was a problem hiding this comment.
The PR reflects the changes described in the PR notes. The bug with blank output has been resolved. The validation on the inputs are a considerably tighter with the tests to back them up. If changes stand up to a manual run test then PR is fit to merge.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR aims to ensure that there are sufficent checks in place to make sure that the inputs that the users are providing are within a sensible range, this is taken from the comments within issue #83.
Changes
Additional validation checks on the user input:
CodeEntropyto ensure they fall within a sensible rangeCodeEntropyinput options visability:CodeEntropyis.Resolved issues regarding
water_entropyargument:CLIandYAMLinput didn't allow the user to change thewater_entropyargument, this has now been resolved.Impact
CodeEntropyand will lead to less failed runs as there are now sensible checks in place.water_entropyflag now works as intended and the user is able to select if they want to use thewaterEntropypart of the programCodeEntropy