Mesa 3.1.0__tar.gz → 3.1.0.dev0__tar.gz

{mesa-3.1.0 → mesa-3.1.0.dev0}/.codespellignore

@@ -7,4 +7,3 @@ ue
 fpr
 falsy
 assertIn
-nD

{mesa-3.1.0 → mesa-3.1.0.dev0}/.github/PULL_REQUEST_TEMPLATE/bug.md

@@ -1,16 +1,16 @@
-### Summary
+## Summary
 <!-- Provide a brief summary of the bug and its impact. -->
 
-### Bug / Issue
+## Bug / Issue
 <!-- Link to the related issue(s) and describe the bug. Include details like the context, what was expected, and what actually happened. -->
 
-### Implementation
+## Implementation
 <!-- Describe the changes made to resolve the issue. Highlight any important parts of the code that were modified. -->
 
-### Testing
+## Testing
 <!-- Detail the testing performed to verify the fix. Include information on test cases, steps taken, and any relevant results.
 
 If you're fixing the visualisation, add before/after screenshots. -->
 
-### Additional Notes
+## Additional Notes
 <!-- Add any additional information that may be relevant for the reviewers, such as potential side effects, dependencies, or related work.

{mesa-3.1.0 → mesa-3.1.0.dev0}/.github/PULL_REQUEST_TEMPLATE/feature.md

@@ -1,16 +1,16 @@
-### Summary
+## Summary
 <!-- Provide a concise summary of the feature and its purpose. -->
 
-### Motive
+## Motive
 <!-- Explain the reasoning behind this feature. Include details on the problem it addresses or the enhancement it provides. -->
 
-### Implementation
+## Implementation
 <!-- Describe how the feature was implemented. Include details on the approach taken, important decisions made, and code changes. -->
 
-### Usage Examples
+## Usage Examples
 <!-- Provide code snippets or examples demonstrating how to use the new feature. Highlight key scenarios where this feature will be beneficial.
 
 If you're modifying the visualisation, add before/after screenshots. -->
 
-### Additional Notes
+## Additional Notes
 <!-- Add any additional information that may be relevant for the reviewers, such as potential side effects, dependencies, or related work. -->

{mesa-3.1.0 → mesa-3.1.0.dev0}/.github/workflows/build_lint.yml

@@ -57,7 +57,7 @@ jobs:
       run: pytest --durations=10 --cov=mesa tests/ --cov-report=xml
     - if: matrix.os == 'ubuntu'
       name: Codecov
-      uses: codecov/codecov-action@v5
+      uses: codecov/codecov-action@v4
       with:
         fail_ci_if_error: true
         token: ${{ secrets.CODECOV_TOKEN }}

{mesa-3.1.0 → mesa-3.1.0.dev0}/.pre-commit-config.yaml

@@ -4,7 +4,7 @@ ci:
 repos:
 - repo: https://github.com/astral-sh/ruff-pre-commit
   # Ruff version.
-  rev: v0.8.1
+  rev: v0.7.2
   hooks:
     # Run the linter.
     - id: ruff

{mesa-3.1.0 → mesa-3.1.0.dev0}/Dockerfile

@@ -1,12 +1,14 @@
 # We can't use slim because we need either git/wget/curl to
 # download mesa-examples, and so installing them requires
 # updating the system anyway.
+# We can't use alpine because NumPy doesn't support musllinux yet.
+# But it's in the RC version https://github.com/numpy/numpy/issues/20089.
 FROM python:bookworm
-LABEL maintainer="projectmesa maintainers@projectmesa.dev"
+LABEL maintainer="rht <rhtbot@protonmail.com>"
 
 # To use this Dockerfile:
-# 1. `docker build . -t mesa_image`
-# 2. `docker run --name mesa_instance -p 8765:8765 -it mesa_image`
+# 1. `docker build . -t mymesa_image`
+# 2. `docker run --name mymesa_instance -p 8765:8765 -it mymesa_image`
 # 3. In your browser, visit http://127.0.0.1:8765
 #
 # Currently, this Dockerfile defaults to running the Schelling model, as an
@@ -17,7 +19,7 @@ LABEL maintainer="projectmesa maintainers@projectmesa.dev"
 # `docker run --name mymesa_instance -p 8765:8765 -e MODEL_DIR=/mesa-examples/examples/sugarscape_cg -it mymesa_image`
 # Note: the model directory MUST contain an app.py file.
 
-ENV MODEL_DIR=/opt/mesa/mesa/examples/basic/schelling
+ENV MODEL_DIR=/mesa-examples/examples/schelling_experimental
 
 # Don't buffer output:
 # https://docs.python.org/3.10/using/cmdline.html?highlight=pythonunbuffered#envvar-PYTHONUNBUFFERED
@@ -27,11 +29,10 @@ WORKDIR /opt/mesa
 
 COPY . /opt/mesa
 
+RUN cd / && git clone https://github.com/projectmesa/mesa-examples.git
+
 EXPOSE 8765/tcp
 
-RUN pip3 install -e /opt/mesa[rec]
+RUN pip3 install -e /opt/mesa
 
 CMD ["sh", "-c", "cd $MODEL_DIR && solara run app.py --host=0.0.0.0"]
-
-# To check file system:
-# docker exec -it mesa_instance bash

{mesa-3.1.0 → mesa-3.1.0.dev0}/HISTORY.md

@@ -1,81 +1,6 @@
 ---
 title: Release History
 ---
-# 3.1.0 (2024-12-04)
-## Highlights
-With Mesa 3.1.0 we're back on our regular release schedule after the big Mesa 3.0 release, with some exciting new features.
-
-This release adds experimental support for Observables and Computed, enabling a more reactive and responsive programming model for agent-based simulations. The new `Observable` and `Computable` classes allow developers to declaratively define attributes that automatically emit signals when their values change, and compute derived values that update dynamically. This lays the groundwork for more advanced event handling and data visualization features in future releases (#2291).
-
-The experimental cell space module has been updated with full support for n-dimensional property layers. These allow agents to easily interact with and modify spatial properties of the environment, such as terrain, resources, or environmental conditions. The new implementation provides a more intuitive attribute-based API and ensures tight integration with the cell space architecture (#2512).
-
-Mesa now includes built-in support for logging using the standard Python `logging` module. This provides developers with a flexible and powerful way to add structured diagnostic and debug output to their simulations, without the need for custom logging solutions. The logging system is integrated throughout the library, including the new SolaraViz visualization system (#2506).
-
-Creating multiple agents with varying initialization parameters is now significantly easier with the new `Agent.create_agents` class method. This factory function supports both uniform and per-agent parameters, simplifying the code required to set up a simulation with a large number of heterogeneous agents (#2351).
-
-In addition to the major new features, this release includes a number of smaller enhancements and bug fixes that improve the overall developer experience. These include removing deprecated functionality, cleaning up examples, and addressing various edge cases reported by the community. Mesa 3.1 requires Python 3.11 or higher.
-
-## What's Changed
-### 🧪 Experimental features
-* Add support for Observables to MESA by @quaquel in https://github.com/projectmesa/mesa/pull/2291
-* Add full support for property layers to cell spaces by @quaquel in https://github.com/projectmesa/mesa/pull/2512
-### 🎉 New features added
-* Add logging to MESA by @quaquel in https://github.com/projectmesa/mesa/pull/2506
-* Add `create_agents` factory method to Agent by @quaquel in https://github.com/projectmesa/mesa/pull/2351
-### 🔍 Examples updated
-* Add seed control to all examples by @quaquel in https://github.com/projectmesa/mesa/pull/2496
-### 📜 Documentation improvements
-* doc fix for pip install error on mac by @quaquel in https://github.com/projectmesa/mesa/pull/2508
-* Refactored docs for Introductory Tutorial by @Spartan-71 in https://github.com/projectmesa/mesa/pull/2511
-* Add module-level docstring to experimental features by @EwoutH in https://github.com/projectmesa/mesa/pull/2532
-### 🔧 Maintenance
-* Remove deprecated time module by @EwoutH in https://github.com/projectmesa/mesa/pull/2476
-* Drop support for Python 3.10, require Python >= 3.11 by @EwoutH in https://github.com/projectmesa/mesa/pull/2474
-* Remove deprecated functionality by @EwoutH in https://github.com/projectmesa/mesa/pull/2483
-* Remove visualization modules from `mesa.experimental` by @quaquel in https://github.com/projectmesa/mesa/pull/2495
-* Cleanup two occurrences of removed scheduler by @EwoutH in https://github.com/projectmesa/mesa/pull/2499
-* move _setup_agent_registration into `Model.__init__` by @quaquel in https://github.com/projectmesa/mesa/pull/2501
-* remove devs related examples from devs/examples by @quaquel in https://github.com/projectmesa/mesa/pull/2507
-* added empty iterable checks and updated tests by @Sahil-Chhoker in https://github.com/projectmesa/mesa/pull/2523
-* Fix: running Mesa in Docker with Schelling model by @AdamZh0u in https://github.com/projectmesa/mesa/pull/2524
-
-## New Contributors
-* @Spartan-71 made their first contribution in https://github.com/projectmesa/mesa/pull/2511
-* @Sahil-Chhoker made their first contribution in https://github.com/projectmesa/mesa/pull/2523
-* @AdamZh0u made their first contribution in https://github.com/projectmesa/mesa/pull/2524
-
-**Full Changelog**: https://github.com/projectmesa/mesa/compare/v3.0.3...v3.1.0
-
-# 3.0.3 (2024-11-14)
-## Highlights
-A small bugfix release that fixes two bugs.
-
-## What's Changed
-### 🧪 Experimental features
-* cell_space: Allow CellCollection to be empty by @EwoutH in https://github.com/projectmesa/mesa/pull/2502
-### 🐛 Bugs fixed
-* Only set model_parameters once by @Corvince in https://github.com/projectmesa/mesa/pull/2505
-
-**Full Changelog**: https://github.com/projectmesa/mesa/compare/v3.0.2...v3.0.3
-
-# 3.0.2 (2024-11-11)
-## Highlighst
-Mesa 3.0.2 is a small follow-up patch release, in which we fixed a lot of small bugs in the example models their visualisation, and improved their testing.
-
-## What's Changed
-### 🐛 Bugs fixed
-* allow components as a positional argument again by @Corvince in https://github.com/projectmesa/mesa/pull/2488
-### 🔍 Examples updated
-* examples: Add required components keyword by @EwoutH in https://github.com/projectmesa/mesa/pull/2485
-* examples: Fix boid_flockers viz by @EwoutH in https://github.com/projectmesa/mesa/pull/2492
-* examples: Fix schelling viz by @EwoutH in https://github.com/projectmesa/mesa/pull/2490
-* example: Add input sliders to Sugerscape viz by @EwoutH in https://github.com/projectmesa/mesa/pull/2487
-* examples/gol: Add initial fraction alive, add sliders to viz by @EwoutH in https://github.com/projectmesa/mesa/pull/2489
-### 🔧 Maintenance
-* test app init of examples by @Corvince in https://github.com/projectmesa/mesa/pull/2491
-
-**Full Changelog**: https://github.com/projectmesa/mesa/compare/v3.0.1...v3.0.2
-
 # 3.0.1 (2024-11-11)
 ## Highlights
 After our huge [3.0.0 release](https://github.com/projectmesa/mesa/releases/tag/v3.0.0), Mesa 3.0.1 follows up with two improvements to experimental features, examples and docs.

{mesa-3.1.0 → mesa-3.1.0.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: Mesa
-Version: 3.1.0
+Version: 3.1.0.dev0
 Summary: Agent-based modeling (ABM) in Python
 Project-URL: homepage, https://github.com/projectmesa/mesa
 Project-URL: repository, https://github.com/projectmesa/mesa

{mesa-3.1.0 → mesa-3.1.0.dev0}/codecov.yaml

@@ -7,6 +7,7 @@ coverage:
 
 ignore:
   - "benchmarks/**"
+  - "mesa/experimental/**"
   - "mesa/visualization/**"
 
 comment: off

{mesa-3.1.0 → mesa-3.1.0.dev0}/docker-compose.yml

@@ -16,6 +16,6 @@ services:
       # within the current directory.
       # E.g. if it is at my-model, then you specify it as
       # /opt/mesa/my-model.
-      MODEL_DIR: /opt/mesa/mesa/examples/basic/schelling
+      MODEL_DIR: /mesa-examples/examples/schelling_experimental
     ports:
       - 8765:8765

{mesa-3.1.0 → mesa-3.1.0.dev0}/docs/apis/api_main.md

@@ -10,6 +10,5 @@ space
 datacollection
 batchrunner
 visualization
-logging
 experimental
 ```

{mesa-3.1.0 → mesa-3.1.0.dev0}/docs/index.md

@@ -43,10 +43,6 @@ To also install our recommended dependencies:
 pip install -U mesa[rec]
 ```
 
-On a Mac, this command might cause an error stating `zsh: no matches found: mesa[all]`.
-In that case, change the command to `pip install -U "mesa[rec]"`.
-
-
 To install our latest pre-release:
 
 ```bash

{mesa-3.1.0 → mesa-3.1.0.dev0}/docs/tutorials/intro_tutorial.ipynb

@@ -294,17 +294,15 @@
     "    def __init__(self, n, seed=None):\n",
     "        super().__init__(seed=seed)\n",
     "        self.num_agents = n\n",
-    "\n",
+    "        \n",
     "        # Create agents\n",
     "        for _ in range(self.num_agents):\n",
-    "            a = MoneyAgent(\n",
-    "                self\n",
-    "            )  # This calls the agent class parameter n number of times\n",
+    "            a = MoneyAgent(self) # This calls the agent class parameter n number of times                         \n",
     "\n",
     "    def step(self):\n",
     "        \"\"\"Advance the model by one step.\"\"\"\n",
     "\n",
-    "        # This function psuedo-randomly reorders the list of agent objects and\n",
+    "        # This function psuedo-randomly reorders the list of agent objects and \n",
     "        # then iterates through calling the function passed in as the parameter\n",
     "        self.agents.shuffle_do(\"say_hi\")"
    ]
@@ -469,24 +467,21 @@
     "                other_agent.wealth += 1\n",
     "                self.wealth -= 1\n",
     "\n",
-    "\n",
     "class MoneyModel(mesa.Model):\n",
     "    \"\"\"A model with some number of agents.\"\"\"\n",
     "\n",
     "    def __init__(self, n):\n",
     "        super().__init__()\n",
     "        self.num_agents = n\n",
-    "\n",
+    "        \n",
     "        # Create agents\n",
     "        for _ in range(self.num_agents):\n",
-    "            a = MoneyAgent(\n",
-    "                self\n",
-    "            )  # This calls the agent class parameter n number of times\n",
+    "            a = MoneyAgent(self) # This calls the agent class parameter n number of times                         \n",
     "\n",
     "    def step(self):\n",
     "        \"\"\"Advance the model by one step.\"\"\"\n",
     "\n",
-    "        # This function psuedo-randomly reorders the list of agent objects and\n",
+    "        # This function psuedo-randomly reorders the list of agent objects and \n",
     "        # then iterates through calling the function passed in as the parameter\n",
     "        self.agents.shuffle_do(\"exchange\")"
    ]
@@ -514,10 +509,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "model = MoneyModel(10)  # Tells the model to create 10 agents\n",
-    "for _ in range(\n",
-    "    30\n",
-    "):  # Runs the model for 10 steps; an underscore is common convention for a variable that is not used\n",
+    "model = MoneyModel(10) # Tels the model to create 10 agents\n",
+    "for _ in range(30): #Runs the model for 10 steps; an underscore is common convention for a variable that is not used\n",
     "    model.step()"
    ]
   },
@@ -672,16 +665,23 @@
     "    #...\n",
     "    def give_money(self):\n",
     "        cellmates = self.model.grid.get_cell_list_contents([self.pos])\n",
-    "        # Ensure agent is not giving money to itself\n",
-    "        cellmates.pop(\n",
-    "            cellmates.index(self)\n",
-    "        )\n",
-    "        if len(cellmates) > 0:\n",
+    "        if len(cellmates) > 1:\n",
     "            other = self.random.choice(cellmates)\n",
     "            other.wealth += 1\n",
     "            self.wealth -= 1\n",
     "```\n",
     "\n",
+    "And with those two methods, the agent's ``step`` method becomes:\n",
+    "\n",
+    "```python\n",
+    "class MoneyAgent(mesa.Agent):\n",
+    "    # ...\n",
+    "    def step(self):\n",
+    "        self.move()\n",
+    "        if self.wealth > 0:\n",
+    "            self.give_money()\n",
+    "```\n",
+    "\n",
     "Now, putting that all together should look like this:"
    ]
   },
@@ -706,23 +706,22 @@
     "        self.model.grid.move_agent(self, new_position)\n",
     "\n",
     "    def give_money(self):\n",
-    "        cellmates = self.model.grid.get_cell_list_contents([self.pos])\n",
-    "        # Ensure agent is not giving money to itself\n",
-    "        cellmates.pop(cellmates.index(self))\n",
-    "        if len(cellmates) > 0:\n",
-    "            other_agent = self.random.choice(cellmates)\n",
-    "            other_agent.wealth += 1\n",
-    "            self.wealth -= 1\n",
-    "\n",
+    "        if self.wealth > 0: \n",
+    "            cellmates = self.model.grid.get_cell_list_contents([self.pos])\n",
+    "            if len(cellmates) > 1:\n",
+    "                other_agent = self.random.choice(cellmates)\n",
+    "                other_agent.wealth += 1\n",
+    "                self.wealth -= 1\n",
     "\n",
+    "       \n",
     "class MoneyModel(mesa.Model):\n",
     "    \"\"\"A model with some number of agents.\"\"\"\n",
     "\n",
-    "    def __init__(self, n, width, height, seed=None):\n",
+    "    def __init__(self, n, width, height,seed=None):\n",
     "        super().__init__(seed=seed)\n",
     "        self.num_agents = n\n",
     "        self.grid = mesa.space.MultiGrid(width, height, True)\n",
-    "\n",
+    "        \n",
     "        # Create agents\n",
     "        for _ in range(self.num_agents):\n",
     "            a = MoneyAgent(self)\n",
@@ -733,7 +732,7 @@
     "\n",
     "    def step(self):\n",
     "        self.agents.shuffle_do(\"move\")\n",
-    "        self.agents.do(\"give_money\")"
+    "        self.agents.shuffle_do(\"give_money\")"
    ]
   },
   {
@@ -792,7 +791,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# Challenge: Change from multigrid to grid (only one agent per cell)"
+    "# Challenge: Change from multigrid to grid (only one agent per cell) "
    ]
   },
   {
@@ -846,13 +845,22 @@
     "\n",
     "    def give_money(self):\n",
     "        cellmates = self.model.grid.get_cell_list_contents([self.pos])\n",
-    "        # Ensure agent is not giving money to itself\n",
-    "        cellmates.pop(cellmates.index(self))\n",
-    "        if len(cellmates) > 0:\n",
+    "        cellmates.pop(\n",
+    "            cellmates.index(self)\n",
+    "        )  # Ensure agent is not giving money to itself\n",
+    "        if len(cellmates) > 1:\n",
     "            other = self.random.choice(cellmates)\n",
     "            other.wealth += 1\n",
     "            self.wealth -= 1\n",
-    "            \n",
+    "            if other == self:\n",
+    "                print(\"I JUST GAVE MOnEY TO MYSELF HEHEHE!\")\n",
+    "\n",
+    "    # There are several ways in which one can combine functions to execute the model\n",
+    "    def agent_act(self): \n",
+    "        self.move()\n",
+    "        if self.wealth > 0:\n",
+    "            self.give_money()\n",
+    "\n",
     "\n",
     "class MoneyModel(mesa.Model):\n",
     "    \"\"\"A model with some number of agents.\"\"\"\n",
@@ -875,10 +883,10 @@
     "            y = self.random.randrange(self.grid.height)\n",
     "            self.grid.place_agent(a, (x, y))\n",
     "\n",
+    "        \n",
     "    def step(self):\n",
     "        self.datacollector.collect(self)\n",
-    "        self.agents.shuffle_do(\"move\")\n",
-    "        self.agents.do(\"give_money\")"
+    "        self.agents.shuffle_do(\"agent_act\")"
    ]
   },
   {
@@ -1118,24 +1126,22 @@
     "        self.model.grid.move_agent(self, new_position)\n",
     "\n",
     "    def give_money(self):\n",
-    "        if self.wealth > 0:\n",
+    "        if self.wealth > 0: \n",
     "            cellmates = self.model.grid.get_cell_list_contents([self.pos])\n",
-    "            # Ensure agent is not giving money to itself\n",
-    "            cellmates.pop(cellmates.index(self))\n",
-    "            if len(cellmates) > 0:\n",
+    "            if len(cellmates) > 1:\n",
     "                other_agent = self.random.choice(cellmates)\n",
     "                other_agent.wealth += 1\n",
     "                self.wealth -= 1\n",
-    "\n",
+    "  \n",
     "\n",
     "class MoneyModel(mesa.Model):\n",
     "    \"\"\"A model with some number of agents.\"\"\"\n",
     "\n",
-    "    def __init__(self, n, width, height, seed=None):\n",
+    "    def __init__(self, n, width, height,seed=None):\n",
     "        super().__init__(seed=seed)\n",
     "        self.num_agents = n\n",
     "        self.grid = mesa.space.MultiGrid(width, height, True)\n",
-    "\n",
+    "        \n",
     "        # Create agents\n",
     "        for _ in range(self.num_agents):\n",
     "            a = MoneyAgent(self)\n",
@@ -1220,11 +1226,11 @@
     "        self.wealth = 1\n",
     "\n",
     "    def give_money(self, poor_agents):\n",
-    "        if self.wealth > 0:\n",
+    "        if self.wealth > 0: \n",
     "            other_agent = self.random.choice(poor_agents)\n",
     "            other_agent.wealth += 1\n",
     "            self.wealth -= 1\n",
-    "\n",
+    "  \n",
     "\n",
     "class MoneyModel(mesa.Model):\n",
     "    \"\"\"A model with some number of agents.\"\"\"\n",
@@ -1232,7 +1238,7 @@
     "    def __init__(self, n):\n",
     "        super().__init__()\n",
     "        self.num_agents = n\n",
-    "\n",
+    "                \n",
     "        # Create agents\n",
     "        for _ in range(self.num_agents):\n",
     "            a = MoneyAgent(self)\n",
@@ -1240,17 +1246,17 @@
     "        self.datacollector = mesa.DataCollector(\n",
     "            model_reporters={\"Gini\": compute_gini}, agent_reporters={\"Wealth\": \"wealth\"}\n",
     "        )\n",
-    "\n",
+    "            \n",
     "    def step(self):\n",
     "        self.datacollector.collect(self)\n",
     "        # Get lists of rich and poor agents\n",
     "        rich_agents = model.agents.select(lambda a: a.wealth >= 3)\n",
     "        poor_agents = model.agents.select(lambda a: a.wealth < 3)\n",
     "        # When there is rich agents only have them give money to the poor agents\n",
-    "        if len(rich_agents) > 0:\n",
+    "        if len(rich_agents) > 0: \n",
     "            rich_agents.shuffle_do(\"give_money\", poor_agents)\n",
-    "        else:\n",
-    "            poor_agents.shuffle_do(\"give_money\", poor_agents)"
+    "        else: \n",
+    "            poor_agents.shuffle_do(\"give_money\", poor_agents)           "
    ]
   },
   {
@@ -1268,7 +1274,7 @@
    "source": [
     "model = MoneyModel(100)\n",
     "for _ in range(20):\n",
-    "    model.step()\n",
+    "    model.step()    \n",
     "\n",
     "\n",
     "data = model.datacollector.get_agent_vars_dataframe()\n",
@@ -1303,11 +1309,11 @@
     "        self.ethnicity = ethnicity\n",
     "\n",
     "    def give_money(self, similars):\n",
-    "        if self.wealth > 0:\n",
+    "        if self.wealth > 0: \n",
     "            other_agent = self.random.choice(similars)\n",
     "            other_agent.wealth += 1\n",
     "            self.wealth -= 1\n",
-    "\n",
+    "  \n",
     "\n",
     "class MoneyModel(mesa.Model):\n",
     "    \"\"\"A model with some number of agents.\"\"\"\n",
@@ -1315,31 +1321,29 @@
     "    def __init__(self, n):\n",
     "        super().__init__()\n",
     "        self.num_agents = n\n",
-    "\n",
+    "                \n",
     "        # Create a list of our different ethnicities\n",
     "        ethnicities = [\"Green\", \"Blue\", \"Mixed\"]\n",
-    "\n",
+    "        \n",
     "        # Create agents\n",
     "        for _ in range(self.num_agents):\n",
     "            a = MoneyAgent(self, self.random.choice(ethnicities))\n",
     "\n",
     "        self.datacollector = mesa.DataCollector(\n",
-    "            model_reporters={\"Gini\": compute_gini},\n",
-    "            agent_reporters={\"Wealth\": \"wealth\", \"Ethnicity\": \"ethnicity\"},\n",
+    "            model_reporters={\"Gini\": compute_gini}, agent_reporters={\"Wealth\": \"wealth\", \"Ethnicity\":\"ethnicity\"}\n",
     "        )\n",
-    "\n",
+    "            \n",
     "    def step(self):\n",
     "        self.datacollector.collect(self)\n",
     "        # groupby returns a dictionary of the different ethnicities with a list of agents\n",
     "        grouped_agents = model.agents.groupby(\"ethnicity\")\n",
     "\n",
-    "        for ethnic, similars in grouped_agents:\n",
-    "            if ethnic != \"Mixed\":\n",
+    "        for ethnic, similars in grouped_agents: \n",
+    "            if ethnic != \"Mixed\": \n",
     "                similars.shuffle_do(\"give_money\", similars)\n",
-    "            else:\n",
-    "                similars.shuffle_do(\n",
-    "                    \"give_money\", self.agents\n",
-    "                )  # This allows mixed to trade with anyone"
+    "            else: \n",
+    "                similars.shuffle_do(\"give_money\", self.agents) # This allows mixed to trade with anyone \n",
+    "\n"
    ]
   },
   {
@@ -1352,12 +1356,12 @@
     "model = MoneyModel(100)\n",
     "for _ in range(20):\n",
     "    model.step()\n",
-    "\n",
+    "  \n",
     "# get the data\n",
     "data = model.datacollector.get_agent_vars_dataframe()\n",
     "# assign histogram colors\n",
-    "palette = {\"Green\": \"green\", \"Blue\": \"blue\", \"Mixed\": \"purple\"}\n",
-    "sns.histplot(data=data, x=\"Wealth\", hue=\"Ethnicity\", discrete=True, palette=palette)\n",
+    "palette = {'Green': 'green', 'Blue': 'blue', 'Mixed': 'purple'} \n",
+    "sns.histplot(data=data, x='Wealth', hue='Ethnicity',discrete=True, palette=palette)\n",
     "g.set(title=\"Wealth distribution\", xlabel=\"Wealth\", ylabel=\"number of agents\");"
    ]
   },
@@ -1441,8 +1445,7 @@
     "\n",
     "    def give_money(self):\n",
     "        cellmates = self.model.grid.get_cell_list_contents([self.pos])\n",
-    "        cellmates.pop(cellmates.index(self))\n",
-    "        if len(cellmates) > 0 and self.wealth > 0:\n",
+    "        if len(cellmates) > 1 and self.wealth > 0:\n",
     "            other = self.random.choice(cellmates)\n",
     "            other.wealth += 1\n",
     "            self.wealth -= 1\n",
@@ -1495,9 +1498,7 @@
   {
    "cell_type": "markdown",
    "metadata": {},
-   "source": [
-    "**note for Windows OS users:** If you are running this tutorial in Jupyter, make sure that you set `number_processes = 1` (single process). If `number_processes` is greater than 1, it is less straightforward to set up. For details on how to use multiprocessing on windows, see [multiprocessing's programming guidelines](https://docs.python.org/3/library/multiprocessing.html#multiprocessing-programming). "
-   ]
+   "source": "**note for Windows OS users:** If you are running this tutorial in Jupyter, make sure that you set `number_processes = 1` (single process). If `number_processes` is greater than 1, it is less straightforward to set up. For details on how to use multiprocessing on windows, see [multiprocessing's programming guidelines](https://docs.python.org/3/library/multiprocessing.html#multiprocessing-programming). "
   },
   {
    "cell_type": "code",
@@ -1592,7 +1593,7 @@
    "outputs": [],
    "source": [
     "# Create a point plot with error bars\n",
-    "g = sns.pointplot(data=results_filtered, x=\"n\", y=\"Gini\", linestyle=\"None\")\n",
+    "g = sns.pointplot(data=results_filtered, x=\"n\", y=\"Gini\", linestyle='None')\n",
     "g.figure.set_size_inches(8, 4)\n",
     "g.set(\n",
     "    xlabel=\"number of agents\",\n",
@@ -1679,7 +1680,7 @@
    },
    "outputs": [],
    "source": [
-    "params = {\"seed\": None, \"width\": 10, \"height\": 10, \"n\": [5, 10, 20, 40, 80]}\n",
+    "params = {\"seed\":None,\"width\": 10, \"height\": 10, \"n\": [5, 10, 20, 40, 80]}\n",
     "\n",
     "results_5s = mesa.batch_run(\n",
     "    MoneyModel,\n",
@@ -1753,8 +1754,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# Challenge: Treat the seed as a parameter and see the impact on the Gini Coefficient.\n",
-    "# You can also plot the seeds against the Gini Coefficient by changing the \"hue\" parameter in sns.lineplot function."
+    "# Challenge: Treat the seed as a parameter and see the impact on the Gini Coefficient. \n",
+    "# You can also plot the seeds against the Gini Coefficient by changing the \"hue\" parameter in sns.lineplot function. "
    ]
   },
   {

{mesa-3.1.0 → mesa-3.1.0.dev0}/mesa/__init__.py

@@ -13,16 +13,16 @@ from mesa.datacollection import DataCollector
 from mesa.model import Model
 
 __all__ = [
+    "Model",
     "Agent",
+    "space",
     "DataCollector",
-    "Model",
     "batch_run",
     "experimental",
-    "space",
 ]
 
 __title__ = "mesa"
-__version__ = "3.1.0"
+__version__ = "3.1.0.dev"
 __license__ = "Apache 2.0"
 _this_year = datetime.datetime.now(tz=datetime.UTC).date().year
 __copyright__ = f"Copyright {_this_year} Project Mesa Team"