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.
run_tardis allows users to specify a list of callbacks to be run at each iteration of the simulation. The current version does not allow a user to specify any extra arguments or access any attributes of the simulation itself.
Description
when run_tardis allocates callbacks, it now adds them using the *unpacking syntax to allow for arguments to be passed along with the callback function. This allows users to specify functions that can act on the simulation object itself as well as provide extra arguments.
Motivation and Context
The ability to use callbacks with the tardis model was severely limited. Now callbacks can give live feedback on the simulation as it runs.
How Has This Been Tested?
I ran through the test modules and none of the failed. I also wrote a few functions to perform various simple tasks like printing the iteration number at each iteration. The examples in the documentation offer a test of the changes.
Types of changes
Checklist: