feat: DiscreteModeChoiceModule writes utilities as an output #3448
Conversation
This file contains 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.
This PR allows a the DiscreteModeChoice Module, part of the discrete_mode_choice contrib, to output a file
dmc_utilities.csvduring iterations and at the end of the simulations. This file contains the utilities computed by the DMC models for each person, it has a headerperson_id;utility.The generation interval of this file during the iterations can be specified through the
writeUtilitiesIntervalparameter in the DiscreteModeChoice config group.This functionality is achieved by storing the utility as a plan attribute. This means that output population files also contain the utility. To generate the CSV file containing the utitlies from a population file, the
modules.utils.ExtractPlanUtilitiescan be used.