feat: Add a named model for Molineaux model. - #458
Draft
b-s-code wants to merge 1 commit into
Draft
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
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.
Problem
When a user wants to use the Molineaux model, they must somehow obtain a parameterisation of it and a list of appropriate model options.
The problem this PR solves is eliminating the need to track down such model options and parameter values in order to use the Molineaux model.
It's hoped this will improve reproducibility and save on communication, by making clear the provenance of the values used.
Solution
In #419, the ability to hardcode a collection of model options and parameter values, identifiable by some string name was added.
Thus users can use a pre-defined collection of model options and parameter values, if they reference that collection by name in their scenario. This PR adds such a collection of values under the name
molineaux_original.A user can select this pre-defined collection of model options/parameters by specifying the value
molineaux_originalfor thenameattribute on the<ModelName>tag:The collection of model options and values being added is consistent with those values found in the papers/accompanying workflow code referenced below.
Points of note:
<weight>under<human>under<model>. TODO : is that all?Testing
Added one new test to cover the newly added combination of ModelName/Parameters/ModelOptions.
All existing tests continue to pass.
Documentation
Wiki
References