Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Misleading EPR documentation #281

Open
SmolakK opened this issue Feb 9, 2024 · 0 comments
Open

Misleading EPR documentation #281

SmolakK opened this issue Feb 9, 2024 · 0 comments

Comments

@SmolakK
Copy link

SmolakK commented Feb 9, 2024

In the generate() method of the EPR class in the models.epr module the documentation states that od_matrix is computed on the fly, while this is not performed in the code. In order for the EPR to work correctly, od_matrix has to be provided.

Documentation snippet:

od_matrix : numpy array or None, optional
the origin destination matrix to use for deciding the movements of the agent (element [i,j] is the probability of one trip from location with tessellation index i to j, normalized by origin location) (element [i,j] is the probability of one trip from location with tessellation index i to j, normalized by origin location). If None, it is computed "on the fly" during the simulation. The default is None.

Recommended solutions: require od_matrix to be provided or call compute_od_matrix() function within the generate() method.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant