Move core example models back (v2) #2358

EwoutH · 2024-10-15T08:54:37Z

This PR moves several core examples back to the main Mesa repository, organized into Basic and Advanced categories:

Basic Examples:

Boltzmann Wealth
Boid Flockers
Conway's Game of Life
Virus on Network
Schelling Segregation

Advanced Examples:

Epstein Civil Violence
Sugarscape with Traders
Wolf-Sheep Predation
Demographic Prisoner's Dilemma on Grid

It uses some ideas discussed in #2330 (comment), and the division of models originates from #2349 (comment).

It keeps the git history, with the only side effect that the PR numbers now link to the wrong repo (there's no easy way to fix this).

Moving these examples back into the main Mesa repository:

Allows opening PRs that show how both code and models change in tandem
Removes the need for two PRs for each feature (but still allows it)
Simplifies version control, ensuring each example works with the exact commit/release of Mesa
Enables more comprehensive testing of these examples within our CI pipeline, including batch runs and visualizations
These diverse, high-quality examples will directly help users test a model after installing Mesa.

After this PR is merged, these examples can be updated further to become fully exemplary.

@projectmesa/maintainers, like with the previous PR, I kindly request your review.

Additionally: - Include interactive version with single run, batch run and server options - Update .gitignore to ignore IDE environment files

* - Add sugarcape_g1mt that is consistent with complexity tutorial - Include interactive version with single run, batch run and server options - Update .gitignore to ignore IDE environment files * - update eat function based on user identified bug in Complexity Explorer Tutorial - update Readme so batch run does not get an argument error - update run so data processing of batchrunner does not get a key error

…t of unnecessary dependencies

* Use Pathlib Code by Phil Robare (versilimidude2) * Use pre-commit * Dropped unused imports * used pre-commit to run pyupgrade, trim whitespace * Remove pathlib changes These belong in a separate PR. * remove redundant black, move comment as per rht's suggestions --------- Co-authored-by: Catherine Devlin <[email protected]>

…ojectmesa#30) Co-authored-by: Jeremy Silver <[email protected]>

* fix bug where agent gives money to itself in the boltzmann model example * [pre-commit.ci] auto fixes from pre-commit.com hooks --------- Co-authored-by: Houssam Kherraz <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

… option; modified most other examples in the same way

…a#33) - update maybe_sell_spice() so calculate_MRS() takes potential sugar and spice based on trade - update calculate_MRS() with kwargs so it can take potential trade but defaults to agents sugar and spice Update increases agent_reporter due to number of trades creating memory issues - Update data collection so non-relevant data rmeoved on each step (i.e. sugar and spice agents don't have trade partners)

* Implement Streamlit UI for Boltzmann wealth model * change slider text * change slider text * update readme --------- Co-authored-by: Ankit Kumar <[email protected]>

See PR projectmesa#36 for the app.py implementation if it. * Initialize Game of Life example * set slider text * udpate readme * Implement Streamlit UI for Boltzmann wealth model * resolve merge conflicts --------- Co-authored-by: Ankit Kumar <[email protected]>

Replace shuffle().do() in 18 models with the performance optimized shuffle_do() method.

…mesa#202) This PR completes the migration from schedulers to AgentSet functionality across the mesa-examples repository for all regular (non-`gis`/-`rl`) examples. Key changes include: - Replaced `RandomActivation`, `SimultaneousActivation`, and `RandomActivationByType` schedulers with appropriate AgentSet methods - Updated `Model.step()` implementations to use AgentSet activation - Removed references to `schedule.steps`, `schedule.agents`, and `schedule.agents_by_type` - Updated agent addition/removal logic to work with AgentSets - Adjusted data collection and visualization code to use `Model.steps` and `Model.agents` For more details on migrating from schedulers to AgentSets, see the migration guide: https://mesa.readthedocs.io/en/latest/migration_guide.html#time-and-schedulers

* refactor: Simplify Schelling code 1. Remove unused model attributes 2. Make `similar` calculation more natural language readable * Remove unused argument doc * Add type hints to agent class * refactor: Simplify self.running expression

Add a Readme for the Example folder, largely taken from the mesa-examples Readme.

Don't run ruff on the examples for now, and fix the remaining pre-commit issues (mainly codespell).

quaquel

changes look good.

I guess all the requirements.txt files can be removed since from now on these will be up to date?

EwoutH · 2024-10-15T09:46:18Z

Thanks!

I guess all the requirements.txt files can be removed since from now on these will be up to date?

Yes, I will open a tracking issues with things that can be improved / cleaned up, and try to tick as many of boxes feasible once this is merged.

Corvince · 2024-10-15T10:26:22Z

Approved the PR itself, but not sure if all the discussion points from v1 have been resolved?

EwoutH · 2024-10-15T10:43:45Z

Thanks!

but not sure if all the discussion points from v1 have been resolved?

Define resolved ;)

Full consensus among 7 maintainer (on very little detail)? No. Majority agrees on major points? Yes. Clear plan to move forward? I also believe so.

But yeah, I would like to get a little more alignment in today’s meeting.

EwoutH · 2024-10-15T13:24:42Z

@tpike3 @jackiekazil we discussed it in the meeting, but could you give your formal approval, mainly for historical reference?

tpike3

Per 15 Oct Dev session I agree

EwoutH · 2024-10-15T13:45:53Z

With jackie also in approval in the meeting, we have 5 core maintainers in agreement.

Thanks for the quick and insightful discussion everyone!

EwoutH · 2024-10-15T14:25:10Z

The big checklist to start working on:

Tracking issue: Full integration of Example models #2364

jackiekazil and others added 30 commits December 5, 2022 02:29

Move examples from mesa repo to mesa-examples repo.

9d4781e

Move examples from mesa repo to mesa-examples repo.

d3aee92

Add sugarcape_g1mt that is consistent with complexity tutorial (#18)

b88486d

Additionally: - Include interactive version with single run, batch run and server options - Update .gitignore to ignore IDE environment files

requirements: Pin Mesa version to 1.x

579521c

requirements: Pin Mesa version to 1.x

15d279c

Fixed consistent capitalization of files.

bfadd93

Fixed consistent capitalization of files.

dcd6132

Update outdated readme to be more accurate + clean up requirements.tx…

a95df26

…t of unnecessary dependencies

Update examples to version 1.2 (using SingleGrid instead of Grid) (pr…

36a407e

…ojectmesa#30) Co-authored-by: Jeremy Silver <[email protected]>

Update examples to version 1.2 (using SingleGrid instead of Grid) (pr…

8b2295d

…ojectmesa#30) Co-authored-by: Jeremy Silver <[email protected]>

Add a 'headless' option to run.py to allow wolf_sheep to run headless

1b03752

check to make sure sys.argv actually has two or more items

13331fe

modified wolf_sheep edits to just include the one liine explicit true…

4b19116

… option; modified most other examples in the same way

modified wolf_sheep edits to just include the one liine explicit true…

b903296

… option; modified most other examples in the same way

Apply Black to boid_flockers

ff30c87

Implement Streamlit UI for Boltzmann wealth model (projectmesa#36)

803e412

* Implement Streamlit UI for Boltzmann wealth model * change slider text * change slider text * update readme --------- Co-authored-by: Ankit Kumar <[email protected]>

Package Schelling and civil_violence examples

7345199

Package Schelling and civil_violence examples

bd91c31

Package wolf_sheep example

c999c7a

boltzmann wealth model: Apply isort to app.py

0eefba9

Apply isort

afd8e17

Apply ruff --fix

6d037b5

Apply isort

de4e17b

Fix remaining Ruff errors manually

656abaf

EwoutH and others added 10 commits September 21, 2024 10:43

Use performance optimized shuffle_do() method (projectmesa#201)

0f4b939

Replace shuffle().do() in 18 models with the performance optimized shuffle_do() method.

merge experimental schelling into schelling example

8000505

merge experimental boltzmann wealth into boltzmann wealth example

0a77f58

Moving examples to use the new discrete spaces (projectmesa#198)

e897839

Add basic example models

3773e4d

Add advanced example models

2270116

Add Readme for examples

9d0d6c0

Add a Readme for the Example folder, largely taken from the mesa-examples Readme.

EwoutH added feature Release notes label docs Release notes label example Changes the examples or adds to them. labels Oct 15, 2024

EwoutH added this to the v3.0 milestone Oct 15, 2024

This comment was marked as off-topic.

Sign in to view

Exclude examples from ruff, fix remaining stuff

9c8a581

Don't run ruff on the examples for now, and fix the remaining pre-commit issues (mainly codespell).

EwoutH force-pushed the add-examples branch from 9ba1be2 to 9c8a581 Compare October 15, 2024 09:03

quaquel approved these changes Oct 15, 2024

View reviewed changes

Corvince approved these changes Oct 15, 2024

View reviewed changes

tpike3 approved these changes Oct 15, 2024

View reviewed changes

EwoutH merged commit 6a60350 into projectmesa:main Oct 15, 2024
10 of 12 checks passed

This was referenced Oct 15, 2024

Move core example model back #2349

Closed

Tracking issue: Full integration of Example models #2364

Open

EwoutH deleted the add-examples branch October 26, 2024 13:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move core example models back (v2) #2358

Move core example models back (v2) #2358

EwoutH commented Oct 15, 2024

This comment was marked as off-topic.

quaquel left a comment

EwoutH commented Oct 15, 2024

Corvince commented Oct 15, 2024

EwoutH commented Oct 15, 2024

EwoutH commented Oct 15, 2024

tpike3 left a comment

EwoutH commented Oct 15, 2024

EwoutH commented Oct 15, 2024

Move core example models back (v2) #2358

Move core example models back (v2) #2358

Conversation

EwoutH commented Oct 15, 2024

This comment was marked as off-topic.

quaquel left a comment

Choose a reason for hiding this comment

EwoutH commented Oct 15, 2024

Corvince commented Oct 15, 2024

EwoutH commented Oct 15, 2024

EwoutH commented Oct 15, 2024

tpike3 left a comment

Choose a reason for hiding this comment

EwoutH commented Oct 15, 2024

EwoutH commented Oct 15, 2024