Reorganize advanced examples: wolf_sheep and sugarscape_g1mt (#2410)

Author: quaquel

mesa/examples/advanced/sugarscape_g1mt/Readme.md

@@ -34,51 +34,28 @@ cross over one another otherwise *end*.
 (Epstein and Axtell, 1996, p. 105)
 
 The model demonstrates several Mesa concepts and features:
- - MultiGrid
+ - OrthogonalMooreGrid
  - Multiple agent types (traders, sugar, spice)
  - Dynamically removing agents from the grid and schedule when they die
  - Data Collection at the model and agent level
- - Batchrunner (i.e. parameter sweeps)
+ - custom solara matplotlib space visualization
 
-## Installation
-
-To install the dependencies use pip and the requirements.txt in this directory. e.g.
-
-```
-  $ pip install -r requirements.txt
-```
 
 ## How to Run
-
-To run the model a single instance of the model:
-
-```
-  $ python run.py -s
-```
-
-To run the model with BatchRunner:
-
-```
-  $ python run.py -b
-```
-
 To run the model interactively:
 
 ```
-  $ mesa runserver
+  $ solara run app.py
 ```
 
 Then open your browser to [http://127.0.0.1:8521/](http://127.0.0.1:8521/) and press Reset, then Run.
 
 ## Files
 
-* `sugarscape_g1mt/trader_agents.py`: Defines the Trader agent class.
-* `sugarscape_g1mt/resource_agents.py`: Defines the Resource agent class which contains an amount of sugar and spice.
-* `sugarscape_g1mt/model.py`: Manages the Sugarscape Constant Growback with Traders model.
-* `sugarscape_g1mt/sugar_map.txt`: Provides sugar and spice landscape in raster type format.
-* `server.py`: Sets up an interactive visualization server.
-* `run.py`: Runs Server, Single Run or Batch Run  with data collection and basic analysis.
+* `model.py`: The Sugarscape Constant Growback with Traders model.
+* `agents.py`: Defines the Trader agent class and the Resource agent class which contains an amount of sugar and spice.
 * `app.py`: Runs a visualization server via Solara (`solara run app.py`).
+* `sugar_map.txt`: Provides sugar and spice landscape in raster type format.
 * `tests.py`: Has tests to ensure that the model reproduces the results in shown in Growing Artificial Societies.
 
 ## Additional Resources

mesa/examples/advanced/sugarscape_g1mt/sugarscape_g1mt/__init__.py mesa/examples/advanced/sugarscape_g1mt/__init__.py

@@ -1,8 +1,8 @@
 import math
 
 from mesa.experimental.cell_space import CellAgent
+from mesa.experimental.cell_space import FixedAgent
 
-from .resource_agents import Resource
 
 
 # Helper function
@@ -18,6 +18,32 @@ def get_distance(cell_1, cell_2):
     dx = x1 - x2
     dy = y1 - y2
     return math.sqrt(dx**2 + dy**2)
+class Resource(FixedAgent):
+    """
+    Resource:
+    - contains an amount of sugar and spice
+    - grows 1 amount of sugar at each turn
+    - grows 1 amount of spice at each turn
+    """
+
+    def __init__(self, model, max_sugar, max_spice, cell):
+        super().__init__(model)
+        self.sugar_amount = max_sugar
+        self.max_sugar = max_sugar
+        self.spice_amount = max_spice
+        self.max_spice = max_spice
+        self.cell = cell
+
+    def step(self):
+        """
+        Growth function, adds one unit of sugar and spice each step up to
+        max amount
+        """
+        self.sugar_amount = min([self.max_sugar, self.sugar_amount + 1])
+        self.spice_amount = min([self.max_spice, self.spice_amount + 1])
+
+
+
 
 
 class Trader(CellAgent):

mesa/examples/advanced/sugarscape_g1mt/sugarscape_g1mt/trader_agents.py mesa/examples/advanced/sugarscape_g1mt/agents.py

@@ -1,7 +1,13 @@
+import sys
+import os.path
+sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '../../../../')))
+
+
 import numpy as np
 import solara
 from matplotlib.figure import Figure
 from mesa.visualization import SolaraViz, make_plot_measure
+
 from sugarscape_g1mt.model import SugarscapeG1mt
 from sugarscape_g1mt.trader_agents import Trader
 
@@ -14,19 +20,19 @@ def portray(g):
             "trader": {"x": [], "y": [], "c": "tab:red", "marker": "o", "s": 10},
         }
 
-        for content, (i, j) in g.coord_iter():
-            for agent in content:
-                if isinstance(agent, Trader):
-                    layers["trader"]["x"].append(i)
-                    layers["trader"]["y"].append(j)
-                else:
-                    # Don't visualize resource with value <= 1.
-                    layers["sugar"][i][j] = (
-                        agent.sugar_amount if agent.sugar_amount > 1 else np.nan
-                    )
-                    layers["spice"][i][j] = (
-                        agent.spice_amount if agent.spice_amount > 1 else np.nan
-                    )
+        for agent in g.all_cells.agents:
+            i, j = agent.cell.coordinate
+            if isinstance(agent, Trader):
+                layers["trader"]["x"].append(i)
+                layers["trader"]["y"].append(j)
+            else:
+                # Don't visualize resource with value <= 1.
+                layers["sugar"][i][j] = (
+                    agent.sugar_amount if agent.sugar_amount > 1 else np.nan
+                )
+                layers["spice"][i][j] = (
+                    agent.spice_amount if agent.spice_amount > 1 else np.nan
+                )
         return layers
 
     fig = Figure()

mesa/examples/advanced/sugarscape_g1mt/app.py

@@ -4,8 +4,8 @@
 import numpy as np
 from mesa.experimental.cell_space import OrthogonalVonNeumannGrid
 
-from .resource_agents import Resource
-from .trader_agents import Trader
+from mesa.examples.advanced.sugarscape_g1mt.agents import Resource, Trader
+
 
 
 # Helper Functions
@@ -53,8 +53,9 @@ def __init__(
         vision_min=1,
         vision_max=5,
         enable_trade=True,
+        seed=None
     ):
-        super().__init__()
+        super().__init__(seed=seed)
         # Initiate width and height of sugarscape
         self.width = width
         self.height = height

mesa/examples/advanced/sugarscape_g1mt/sugarscape_g1mt/model.py mesa/examples/advanced/sugarscape_g1mt/model.py

@@ -1,11 +1,7 @@
-import random
-
 import numpy as np
 from scipy import stats
-from sugarscape_g1mt.model import SugarscapeG1mt, flatten
-from sugarscape_g1mt.trader_agents import Trader
-
-random.seed(1)
+from .model import SugarscapeG1mt, flatten
+from .agents import Trader
 
 
 def check_slope(y, increasing):
@@ -19,7 +15,7 @@ def check_slope(y, increasing):
 def test_decreasing_price_variance():
     # The variance of the average trade price should decrease over time (figure IV-3)
     # See Growing Artificial Societies p. 109.
-    model = SugarscapeG1mt()
+    model = SugarscapeG1mt(42)
     model.datacollector._new_model_reporter(
         "price_variance",
         lambda m: np.var(