Update boltzmann example for mesa `3.1.5` #247

Spartan-71 · 2025-03-16T10:28:43Z

Changes:

separated model and agent class in different files.
added solara support for network visualization.
updated requirements.txt

Issue reference: #246

tpike3 · 2025-03-19T13:24:01Z

@Spartan-71 can you update tests please to pass.

for more information, see https://pre-commit.ci

coderabbitai · 2025-04-14T17:35:54Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

sanika-n

Thanks for the PR! There are some changes that I have mentioned in the review, but other than that it looks good to go:)

sanika-n · 2025-04-15T09:45:18Z

examples/boltzmann_wealth_model_network/boltzmann_wealth_model_network/agent.py

@@ -0,0 +1,20 @@
+from mesa.experimental.cell_space import CellAgent


Could you change line this to "from mesa.discrete_space.cell_agent import CellAgent"?
cell_space has been moved out of experimental to the stable version, however, your version will continue to work as the changes were designed to be backward compatible. So just to avoid any ambiguity I think I'd prefer if it were changed

cell_space has been moved out of experimental to the stable version

It doesn't look like it, based on the API references for the stable version.

Check latest for the correct API. stable is the current release.

Hey @sanika-n, I made the changes, but the pytests are failing for some reason.
The error messages are also not correct. Looks like something is going wrong.

Oh, I will look into it later today

sanika-n · 2025-04-15T09:50:01Z

examples/boltzmann_wealth_model_network/boltzmann_wealth_model_network/model.py

@@ -1,5 +1,8 @@
 import mesa
 import networkx as nx
+from mesa.experimental.cell_space import Network


Same here, this should be replaced with "from mesa.discrete_space.network import Network"

examples/boltzmann_wealth_model_network/requirements.txt

sanika-n · 2025-04-15T10:09:32Z

examples/boltzmann_wealth_model_network/README.md


 ## Further Reading

-The full tutorial describing how the model is built can be found at:
-https://mesa.readthedocs.io/en/latest/tutorials/intro_tutorial.html
-
 This model is drawn from econophysics and presents a statistical mechanics approach to wealth distribution. Some examples of further reading on the topic can be found at:

 [Milakovic, M. A Statistical Equilibrium Model of Wealth Distribution. February, 2001.](https://editorialexpress.com/cgi-bin/conference/download.cgi?db_name=SCE2001&paper_id=214)


I don't think the link to the paper is working, I keep getting this error:

Yeah, even I'm getting the same error. Should I consider removing the same?

Yes, go ahead

Can we find another working link instead?

@quaquel I searched for the same paper on different websites, but all of them are showing "NO DOWNLOADS AVAILABLE".

References:
https://econpapers.repec.org/paper/scescecf1/214.htm
https://ideas.repec.org/p/sce/scecf1/214.html

Here is the link --- https://arxiv.org/abs/cond-mat/0211175

sanika-n · 2025-04-15T10:32:20Z

examples/boltzmann_wealth_model_network/app.py

+model_params = {
+    "num_agents": Slider(
+        label="Number of agents",
+        value=10,
+        min=5,
+        max=20,
+        step=1,
+    ),
+    "num_nodes": Slider(
+        label="Number of nodes",
+        value=10,
+        min=5,
+        max=20,
+        step=1,
+    ),
+}


I noticed that you handled the case where the number of agents is more than the number of nodes in the code (as one node only supports one agent) by ignoring the given value of number of nodes, which I think is a good approach. I would prefer that you let the user know that you are doing this though, by butting some sort of warning when the user does set the number of nodes<number of agents. I am saying this as the visualization will be counter intuitive if the user hasn't read the code. For instance, I set the number of nodes to 8 here but the visualization shows 18

I would prefer it if the warning were given in the GUI, but if that's too hard I think a terminal message should do it

Yes seems very natural! Just added a simple terminal message.

sanika-n · 2025-04-15T10:52:16Z

examples/boltzmann_wealth_model_network/boltzmann_wealth_model_network/model.py


        self.datacollector = mesa.DataCollector(
            model_reporters={"Gini": compute_gini},
-            agent_reporters={"Wealth": lambda _: _.wealth},


I understand that agent_reporters is not used explicitly in the code, but do you think we should just leave it in if the user wants to do post-simulation analysis?

Yes, I feel it should be the user's choice

sanika-n · 2025-04-22T11:56:15Z

examples/boltzmann_wealth_model_network/boltzmann_wealth_model_network/model.py

@@ -1,6 +1,6 @@
 import mesa
 import networkx as nx
-from mesa.experimental.cell_space import Network
+from mesa.discrete_space import Network


It should be "mesa.discrete_space.network import Network"

Spartan-71 added 5 commits March 16, 2025 15:32

refactor: adapt boltzmman example for mesa 3.1.4

13b5c8a

chore: updated requirements.txt for Mesa 3.1.4 compatibility

863cc10

chore: updated readme for new file structure

db3c30f

style: format code using Black

fce8682

chore: fix pre-commit errors

96edde4

Spartan-71 and others added 4 commits March 19, 2025 19:54

chore: restructured file structure

009a8cc

[pre-commit.ci] auto fixes from pre-commit.com hooks

9657b57

for more information, see https://pre-commit.ci

style: formatted using ruff

4ae6426

[pre-commit.ci] auto fixes from pre-commit.com hooks

0c38d34

for more information, see https://pre-commit.ci

Sahil-Chhoker requested a review from sanika-n April 14, 2025 06:38

chore: resturcutred

c3d3754

sanika-n suggested changes Apr 15, 2025

View reviewed changes

Spartan-71 changed the title ~~Update boltzmann example for mesa 3.1.4~~ Update boltzmann example for mesa 3.1.5 Apr 21, 2025

Spartan-71 mentioned this pull request Apr 21, 2025

Update bank reserves example #250

Closed

chore: fix imports and add warning msg

2c9a720

sanika-n suggested changes Apr 22, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update boltzmann example for mesa `3.1.5` #247

Update boltzmann example for mesa `3.1.5` #247

Spartan-71 commented Mar 16, 2025 •

edited

Loading

tpike3 commented Mar 19, 2025

coderabbitai bot commented Apr 14, 2025 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

sanika-n left a comment

sanika-n Apr 15, 2025

Spartan-71 Apr 21, 2025

quaquel Apr 21, 2025

Spartan-71 Apr 21, 2025

sanika-n Apr 22, 2025

sanika-n Apr 15, 2025

sanika-n Apr 15, 2025

Spartan-71 Apr 21, 2025

sanika-n Apr 21, 2025

quaquel Apr 21, 2025

Spartan-71 Apr 21, 2025

tpike3 May 4, 2025

sanika-n Apr 15, 2025

Spartan-71 Apr 21, 2025

sanika-n Apr 15, 2025

Spartan-71 Apr 21, 2025

sanika-n Apr 22, 2025

		@@ -0,0 +1,20 @@
		from mesa.experimental.cell_space import CellAgent

Update boltzmann example for mesa 3.1.5 #247

Are you sure you want to change the base?

Update boltzmann example for mesa 3.1.5 #247

Conversation

Spartan-71 commented Mar 16, 2025 • edited Loading

tpike3 commented Mar 19, 2025

coderabbitai bot commented Apr 14, 2025 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

sanika-n left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Update boltzmann example for mesa `3.1.5` #247

Update boltzmann example for mesa `3.1.5` #247

Spartan-71 commented Mar 16, 2025 •

edited

Loading

coderabbitai bot commented Apr 14, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)