docs: improve Boltzmann Wealth Model README structure and clarity#3229
Merged
docs: improve Boltzmann Wealth Model README structure and clarity#3229
Conversation
tpike3
reviewed
Feb 2, 2026
|
|
||
| This example follows Mesa’s standard separation of concerns: | ||
|
|
||
| - Individual agent behavior is defined independently from system-level rules. |
Member
There was a problem hiding this comment.
Could you tie this to the files list above, such as:
model.py: Manages the model by, instating, agents, space, and data collection.
agents.py: ...
Contributor
Author
|
I've updated the section to tie each explanation directly to its corresponding file. I'm happy to make any other changes as per your preferences. |
quaquel
approved these changes
Feb 4, 2026
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
3 participants
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.
Summary
Improves the Boltzmann Wealth Model README by adding structural clarification and explaining the Gini coefficient output.
Motive
The existing README did not explain:
This made it harder for newcomers to understand the example's structure when following the tutorial.
Implementation
Added two new sections to the README:
"How the Model Is Structured" - Explains Mesa's separation of concerns (agents.py, model.py, app.py) and how they interact
"Understanding the Output" - Brief explanation of the Gini coefficient (0 = equality, 1 = inequality) and notes that it's computed by DataCollector in model.py
Usage Examples
N/A - This is a documentation-only change.
Additional Notes
This change only affects the README and does not modify any code or functionality. The additions are intentionally minimal to avoid duplicating Mesa's existing tutorial documentation.