Closed xylar closed 1 year ago
I have run all test cases except 1 and 4 km RPE tests and made sure results are BFB with main
.
I don't plan on updating the documentation here. Instead, I will do that in #117
@cbegeman, thanks very much for the review. These are all great suggestions, which I will make tomorrow.
@cbegeman, I believe I've addressed your 3 requested changes. Please have another look when you have time.
@cbegeman, thanks for looking it over again. I think we're good for now. Let's see what @sbrus89 says.
@sbrus89, thanks so much for your comments! I appreciate you taking a look. Let me know if I've addressed your comments or if you'd like to see more changes.
Thanks so much!
This merge adds support to the polaris framework for shared steps (steps that can belong to more than one task). Existing tasks and steps are modified to accommodate the changes to the framework but tasks and steps are not yet reorganized to take advantage of shared steps so that bit-for-bit comparison with
main
can still be made with this branch.Changes to
Step
include:subdir
attribute to be relative to the component work directory, not the task work directoryindir
parameter to the constructor to easily construct asubdir
that joinsindir
andname
. Ifindir
is the task work directory, this is the same as the old default behavior whensubdir
was not specified.Changes to
Component
include:add_step()
andremove_step()
methodsChanges to
Task
include:add_step()
method to perform error checking (e.g. make sure a different step with the same path hasn't already been added) and then add the step to the component and the task. This method also includes a newsymlink
parameter that can be used to make a local symlink in the task's work directory to a shared step if it resides outside the task.remove_step()
methodsOther changes include:
polaris list --verbose
is calledpolaris_step_complete.log
file once a step has run to indicate that it is complete (and should not be run again)--clean
flags topolaris setup
andpolaris suite
to remove the base work directory before setting up tasks. (This is sometimes useful when debugging because steps that have already run will now be skipped, rather than running again, which may not be what the developer wants.)resolution_to_subdir()
function to the ocean framework for conveniently converting a float resolution to a string.Checklist and changes look as expected
Testing
comment in the PR documents testing used to verify the changes