Updating CLI and Acceptance Tests for non-default scale factors. - #2374
Conversation
mo-kbogue
left a comment
There was a problem hiding this comment.
I ran the acceptance test with no issues, though looking at the unit tests in improver_tests/uv_index/test_uv_index.py, I think that it may be worth adding some additional unit tests. There is already a unit test for non-default scale factor (in which 10 is used), but it might be worth taking other possibilities into account, such as including the case where a scale factor of 0 is received.
I would also like to have a better understanding and written record of where the 0.1 factor come from. From reading the previous tickets, it seems as is this possibly ported over from SPSS, but where did the 0.1 arise from in SPSS? If the justification is not clear, it may be worth revisiting if this is going to produce the best UV index for users. I do see that the jupyter notebook in the associated PR (#530) tests this 0.1 scaling and it does appear to give a reasonable answer, but is this enough of a scientific justification for its use? If we are confident in the 0.1 scaling factor, we should make sure that the reasons for this are clear and accessible.
|
In reference to the 0.1 scaling factor, the comment linked below adds some more context. |
mo-kbogue
left a comment
There was a problem hiding this comment.
Looks good to me, thanks for including that additional warning.
mo-kbogue
left a comment
There was a problem hiding this comment.
Just one small typo, but otherwise this is great - thanks for this!
| scale_factor: | ||
| The uv scale factor. Default is 3.6 (m2 W-1). This factor has | ||
| been empirically derived and should not be | ||
| been empirically derived, or Met Office UM UV data, and should not be |
There was a problem hiding this comment.
| been empirically derived, or Met Office UM UV data, and should not be | |
| been empirically derived, for Met Office UM UV data, and should not be |
|
In order to maintain a backlog of relevant PRs, we automatically label them as stale after 60 days of inactivity. If this PR is still important to you, then please comment on this PR and the stale label will be removed. Otherwise this PR will be automatically closed in 30 days time. |
|
These PRs (improver and improver_test_data changes) have been added to the board separately, so it can be second reviewed and merged independently. As the other UV Index PR (improver_aux) needs more work and investigation. |
maxwhitemet
left a comment
There was a problem hiding this comment.
Thanks @mo-jbeaver. I have made a small suggestion to the warning output.
| f"The scale_factor is not the default 3.6 (m2 W-1) but {scale_factor}. " | ||
| "This default factor has been empirically derived and should not be " | ||
| "changed except if there are scientific reasons to do so." |
There was a problem hiding this comment.
Perhaps the following
| f"The scale_factor is not the default 3.6 (m2 W-1) but {scale_factor}. " | |
| "This default factor has been empirically derived and should not be " | |
| "changed except if there are scientific reasons to do so." | |
| f"The scale_factor is not the default 3.6 (m2 W-1) but {scale_factor}. " | |
| "This default factor has been empirically derived and should not be " | |
| "changed except if there are scientific reasons to do so." | |
| "For more information, see this function's 'References' section." |
maxwhitemet
left a comment
There was a problem hiding this comment.
Happy with the changes made. Approved 👍
Addresses #1151
Test Data: metoppv/improver_test_data#132
This PR implements changes to the uv_index CLI and Acceptance Test.
This provides the option to use a non-default scale-factor via the CLI.
Testing: