Split population generation from running the model.#134
Open
plietar wants to merge 1 commit into
Open
Conversation
Member
Author
|
This should allow implementing #133 |
Generating the population data (eg. assigning individuals to locations) can take significant amounts of time. By refactoring the interface a little bit, we can split off the generation step into its own function, which allows it to be re-used, saving time along the way. This is especially useful during development or benchmarking of the main model. For producing scientifically useful results it may be preferable to keep generating population data each time. By default `run_simulation` will generate a new population each time it is called, but it can be passed a `population_data` argument to avoid this. The `population_data` is obtained by calling `generate_population_data`. The population data object is free of any objects from the individual package: it has normal value semantics and it can be serialized to a file. I've imported strict_list from [reside.utils](reside.utils) and used it to define the parameter and variable list. It made refactoring much easier and I think is a good addition, though it could of course be removed. [reside.utils]: https://github.com/reside-ic/reside.utils
Collaborator
|
Huge thank you for this @plietar - things are hectic with the move atm, but will get to this over the weekend or early next week. From a quick skim, looks like it will be very helpful, thank you! |
Collaborator
|
@claude can you review this for me and let me know what you think please? |
|
I'll analyze this and get back to you. |
Collaborator
|
@claude can you review this for me and let me know what you think please? |
|
I'll analyze this and get back to you. |
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.

Generating the population data (eg. assigning individuals to locations) can take significant amounts of time. By refactoring the interface a little bit, we can split off the generation step into its own function, which allows it to be re-used, saving time along the way.
This is especially useful during development or benchmarking of the main model. For producing scientifically useful results it may be preferable to keep generating population data each time.
By default
run_simulationwill generate a new population each time it is called, but it can be passed apopulation_dataargument to avoid this. Thepopulation_datais obtained by callinggenerate_population_data.The population data object is free of any objects from the individual package: it has normal value semantics and it can be serialized to a file.
I've imported strict_list from reside.utils and used it to define the parameter and variable list. It made refactoring much easier and I think is a good addition, though it could of course be removed.