Update tutorials to use create_agents and rng.integers

[DarshPareek]

O### Summary
Updates the tutorials to align with Mesa 3.1's recommended practices for agent creation and random number generation.

Motive

The changes make the tutorials consistent with Mesa 3.1 by:

• Using the create_agents class method instead of individual agent creation in loops
• Replacing random.randrange with rng.integers for position generation
• Improving performance by generating all agent positions at once instead of one at a time

Implementation

Made consistent updates across intro_tutorial.ipynb and MoneyModel.py:

1. Agent Creation:
   Old approach:

for _ in range(self.num_agents):
    a = MoneyAgent(self)

New approach:

agents = MoneyAgent.create_agents(model=self, n=n)

2. Position Generation:
   Old approach:

x = self.random.randrange(self.grid.width)
y = self.random.randrange(self.grid.height)

New approach:

x = self.rng.integers(0, self.grid.width, size=(n,))
y = self.rng.integers(0, self.grid.height, size=(n,))

Usage Examples

Example of the updated model initialization:

class MoneyModel(mesa.Model):
    def __init__(self, n, width, height, seed=None):
        super().__init__(seed=seed)
        self.num_agents = n
        self.grid = mesa.space.MultiGrid(width, height, True)
        
        # Create agents all at once
        agents = MoneyAgent.create_agents(model=self, n=n)
        
        # Generate all positions at once
        x = self.rng.integers(0, self.grid.width, size=(n,))
        y = self.rng.integers(0, self.grid.height, size=(n,))
        
        # Place agents efficiently using zip
        for a, i, j in zip(agents, x, y):
            self.grid.place_agent(a, (i, j))

Closes #2537.

[github-actions]

Performance benchmarks:

Model	Size	Init time [95% CI]	Run time [95% CI]
BoltzmannWealth	small	🔵 +0.8% [+0.2%, +1.3%]	🔵 +0.2% [+0.0%, +0.3%]
BoltzmannWealth	large	🔵 +1.2% [+0.8%, +1.5%]	🔵 +0.3% [-0.3%, +0.9%]
Schelling	small	🔵 +0.8% [+0.5%, +1.1%]	🔵 +0.3% [+0.1%, +0.4%]
Schelling	large	🔵 +0.9% [+0.5%, +1.3%]	🔵 +3.6% [+2.5%, +4.8%]
WolfSheep	small	🔵 +3.2% [+2.8%, +3.5%]	🔵 +0.9% [+0.7%, +1.0%]
WolfSheep	large	🔴 +3.7% [+3.5%, +4.0%]	🔴 +7.0% [+5.5%, +8.5%]
BoidFlockers	small	🔴 +8.0% [+7.5%, +8.6%]	🔵 +0.6% [-0.3%, +1.4%]
BoidFlockers	large	🔴 +7.4% [+6.7%, +8.2%]	🔵 +0.6% [-0.0%, +1.2%]

[EwoutH]

Thanks for the PR!

[EwoutH]

I did assign @ashish-nagmoti to issue #2537 by the way. Next time please do check if an issue is assigned, and if it is, ask first.

@ashish-nagmoti would you like to review this PR instead?

[DarshPareek]

In the latest update I have changed the arguments to be more explicit in create_agents function and added

x = self.rng.integers(0, self.grid.width, size=(n,)) 
y = self.rng.integers(0, self.grid.height, size=(n,))

to make positioning of agents better

[EwoutH]

I’m good, but let’s see if Jan also is.

[quaquel]

I am fine with this, although I personally would prefer to move self.grid.place_agent(a, (i, j)) into the MoneyAgent.

[EwoutH]

Personally I won't bother with updating the old spaces, we will replace them soon anyways.

@DarshPareek Could you make your PR title and description a bit more clear/descriptive?

[DarshPareek]

Personally I won't bother with updating the old spaces, we will replace them soon anyways.

@DarshPareek Could you make your PR title and description a bit more clear/descriptive?

Thank you for the suggestion! I'll revise the PR title and description to better reflect the changes made. Please let me know if there’s anything specific you'd like included.

[EwoutH]

Sorry, I totally missed this in earlier reviews. Why are we excluding all notebooks from Codespell?

If there’s a certain word you would like to use, you can add it to .codespellignore

[DarshPareek]

okay i will change that

[quaquel]

Could you please remove all changes to .codespellignore?

[DarshPareek]

If i don't add words to .codespellignore the pre-commit check fails on the branch, If I remove them is there any workaround the check?

[EwoutH]

This still needs to be cleaned up

[DarshPareek]

I have cleaned it up.

[EwoutH]

Final things done in f4b7eb6.

[DarshPareek]

I have cleared the outputs and removed the words from .codespellignore, let me know if any further changes are needed.

[EwoutH]

Cleaned up the final things, merging.

Thanks @DarshPareek!

[DarshPareek]

Cleanup the final things, merging.

Thanks @DarshPareek!

Thanks! I would love to contribute in future.