examples: Convert to using Slider UserParam class

rht · tpike3 · commit 8000dfb460cd · 2022-05-25T05:54:49.000-04:00
diff --git a/examples/bank_reserves/Readme.md b/examples/bank_reserves/Readme.md
@@ -7,7 +7,7 @@ A highly abstracted, simplified model of an economy, with only one type of agent
 The model demonstrates the following Mesa features:
  - MultiGrid for creating shareable space for agents
  - DataCollector for collecting data on individual model runs
- - UserSettableParameters for adjusting initial model parameters
+ - Slider for adjusting initial model parameters
  - ModularServer for visualization of agent interaction
  - Agent object inheritance
  - Using a BatchRunner to collect data on multiple combinations of model parameters
diff --git a/examples/bank_reserves/bank_reserves/agents.py b/examples/bank_reserves/bank_reserves/agents.py
@@ -20,8 +20,8 @@ def __init__(self, unique_id, model, reserve_percent=50):
         super().__init__(unique_id, model)
         # for tracking total value of loans outstanding
         self.bank_loans = 0
-        """percent of deposits the bank must keep in reserves - this is a
-           UserSettableParameter in server.py"""
+        """percent of deposits the bank must keep in reserves - this is set via
+           Slider in server.py"""
         self.reserve_percent = reserve_percent
         # for tracking total value of deposits
         self.deposits = 0
diff --git a/examples/bank_reserves/bank_reserves/model.py b/examples/bank_reserves/bank_reserves/model.py
@@ -103,7 +103,7 @@ class BankReserves(mesa.Model):
     grid_w = 20
 
     """init parameters "init_people", "rich_threshold", and "reserve_percent"
-       are all UserSettableParameters"""
+       are all set via Slider"""
 
     def __init__(
         self,
diff --git a/examples/bank_reserves/bank_reserves/server.py b/examples/bank_reserves/bank_reserves/server.py
@@ -50,19 +50,17 @@ def person_portrayal(agent):
 
 # dictionary of user settable parameters - these map to the model __init__ parameters
 model_params = {
-    "init_people": mesa.visualization.UserSettableParameter(
-        "slider", "People", 25, 1, 200, description="Initial Number of People"
+    "init_people": mesa.visualization.Slider(
+        "People", 25, 1, 200, description="Initial Number of People"
     ),
-    "rich_threshold": mesa.visualization.UserSettableParameter(
-        "slider",
+    "rich_threshold": mesa.visualization.Slider(
         "Rich Threshold",
         10,
         1,
         20,
         description="Upper End of Random Initial Wallet Amount",
     ),
-    "reserve_percent": mesa.visualization.UserSettableParameter(
-        "slider",
+    "reserve_percent": mesa.visualization.Slider(
         "Reserves",
         50,
         1,
diff --git a/examples/bank_reserves/batch_run.py b/examples/bank_reserves/batch_run.py
@@ -114,7 +114,7 @@ class BankReservesModel(mesa.Model):
     grid_w = 20
 
     """init parameters "init_people", "rich_threshold", and "reserve_percent"
-       are all UserSettableParameters"""
+       are all set via Slider"""
 
     def __init__(
         self,
diff --git a/examples/boltzmann_wealth_model/boltzmann_wealth_model/server.py b/examples/boltzmann_wealth_model/boltzmann_wealth_model/server.py
@@ -22,8 +22,7 @@ def agent_portrayal(agent):
 )
 
 model_params = {
-    "N": mesa.visualization.UserSettableParameter(
-        "slider",
+    "N": mesa.visualization.Slider(
         "Number of agents",
         100,
         2,
diff --git a/examples/boltzmann_wealth_model_network/boltzmann_wealth_model_network/server.py b/examples/boltzmann_wealth_model_network/boltzmann_wealth_model_network/server.py
@@ -33,17 +33,15 @@ def network_portrayal(G):
 )
 
 model_params = {
-    "num_agents": mesa.visualization.UserSettableParameter(
-        "slider",
+    "num_agents": mesa.visualization.Slider(
         "Number of agents",
         7,
         2,
         10,
         1,
         description="Choose how many agents to include in the model",
     ),
-    "num_nodes": mesa.visualization.UserSettableParameter(
-        "slider",
+    "num_nodes": mesa.visualization.Slider(
         "Number of nodes",
         10,
         3,
diff --git a/examples/charts/charts/agents.py b/examples/charts/charts/agents.py
@@ -20,8 +20,8 @@ def __init__(self, unique_id, model, reserve_percent=50):
         super().__init__(unique_id, model)
         # for tracking total value of loans outstanding
         self.bank_loans = 0
-        """percent of deposits the bank must keep in reserves - this is a
-           UserSettableParameter in server.py"""
+        """percent of deposits the bank must keep in reserves - this is set via
+           Slider in server.py"""
         self.reserve_percent = reserve_percent
         # for tracking total value of deposits
         self.deposits = 0
diff --git a/examples/charts/charts/model.py b/examples/charts/charts/model.py
@@ -87,7 +87,7 @@ class Charts(mesa.Model):
     grid_w = 20
 
     """init parameters "init_people", "rich_threshold", and "reserve_percent"
-       are all UserSettableParameters"""
+       are all set via Slider"""
 
     def __init__(
         self,
diff --git a/examples/charts/charts/server.py b/examples/charts/charts/server.py
@@ -50,19 +50,17 @@ def person_portrayal(agent):
 
 # dictionary of user settable parameters - these map to the model __init__ parameters
 model_params = {
-    "init_people": mesa.visualization.UserSettableParameter(
-        "slider", "People", 25, 1, 200, description="Initial Number of People"
+    "init_people": mesa.visualization.Slider(
+        "People", 25, 1, 200, description="Initial Number of People"
     ),
-    "rich_threshold": mesa.visualization.UserSettableParameter(
-        "slider",
+    "rich_threshold": mesa.visualization.Slider(
         "Rich Threshold",
         10,
         1,
         20,
         description="Upper End of Random Initial Wallet Amount",
     ),
-    "reserve_percent": mesa.visualization.UserSettableParameter(
-        "slider",
+    "reserve_percent": mesa.visualization.Slider(
         "Reserves",
         50,
         1,
diff --git a/examples/forest_fire/forest_fire/server.py b/examples/forest_fire/forest_fire/server.py
@@ -29,9 +29,7 @@ def forest_fire_portrayal(tree):
 model_params = {
     "height": 100,
     "width": 100,
-    "density": mesa.visualization.UserSettableParameter(
-        "slider", "Tree density", 0.65, 0.01, 1.0, 0.01
-    ),
+    "density": mesa.visualization.Slider("Tree density", 0.65, 0.01, 1.0, 0.01),
 }
 server = mesa.visualization.ModularServer(
     ForestFire, [canvas_element, tree_chart, pie_chart], "Forest Fire", model_params
diff --git a/examples/schelling/server.py b/examples/schelling/server.py
@@ -39,15 +39,9 @@ def schelling_draw(agent):
 model_params = {
     "height": 20,
     "width": 20,
-    "density": mesa.visualization.UserSettableParameter(
-        "slider", "Agent density", 0.8, 0.1, 1.0, 0.1
-    ),
-    "minority_pc": mesa.visualization.UserSettableParameter(
-        "slider", "Fraction minority", 0.2, 0.00, 1.0, 0.05
-    ),
-    "homophily": mesa.visualization.UserSettableParameter(
-        "slider", "Homophily", 3, 0, 8, 1
-    ),
+    "density": mesa.visualization.Slider("Agent density", 0.8, 0.1, 1.0, 0.1),
+    "minority_pc": mesa.visualization.Slider("Fraction minority", 0.2, 0.00, 1.0, 0.05),
+    "homophily": mesa.visualization.Slider("Homophily", 3, 0, 8, 1),
 }
 
 server = mesa.visualization.ModularServer(
diff --git a/examples/virus_on_network/virus_on_network/server.py b/examples/virus_on_network/virus_on_network/server.py
@@ -71,56 +71,50 @@ def render(self, model):
 
 
 model_params = {
-    "num_nodes": mesa.visualization.UserSettableParameter(
-        "slider",
+    "num_nodes": mesa.visualization.Slider(
         "Number of agents",
         10,
         10,
         100,
         1,
         description="Choose how many agents to include in the model",
     ),
-    "avg_node_degree": mesa.visualization.UserSettableParameter(
-        "slider", "Avg Node Degree", 3, 3, 8, 1, description="Avg Node Degree"
+    "avg_node_degree": mesa.visualization.Slider(
+        "Avg Node Degree", 3, 3, 8, 1, description="Avg Node Degree"
     ),
-    "initial_outbreak_size": mesa.visualization.UserSettableParameter(
-        "slider",
+    "initial_outbreak_size": mesa.visualization.Slider(
         "Initial Outbreak Size",
         1,
         1,
         10,
         1,
         description="Initial Outbreak Size",
     ),
-    "virus_spread_chance": mesa.visualization.UserSettableParameter(
-        "slider",
+    "virus_spread_chance": mesa.visualization.Slider(
         "Virus Spread Chance",
         0.4,
         0.0,
         1.0,
         0.1,
         description="Probability that susceptible neighbor will be infected",
     ),
-    "virus_check_frequency": mesa.visualization.UserSettableParameter(
-        "slider",
+    "virus_check_frequency": mesa.visualization.Slider(
         "Virus Check Frequency",
         0.4,
         0.0,
         1.0,
         0.1,
         description="Frequency the nodes check whether they are infected by " "a virus",
     ),
-    "recovery_chance": mesa.visualization.UserSettableParameter(
-        "slider",
+    "recovery_chance": mesa.visualization.Slider(
         "Recovery Chance",
         0.3,
         0.0,
         1.0,
         0.1,
         description="Probability that the virus will be removed",
     ),
-    "gain_resistance_chance": mesa.visualization.UserSettableParameter(
-        "slider",
+    "gain_resistance_chance": mesa.visualization.Slider(
         "Gain Resistance Chance",
         0.5,
         0.0,

Original file line number	Diff line number	Diff line change
`@@ -22,8 +22,7 @@ def agent_portrayal(agent):`
`22`	`22`	`)`
`23`	`23`
`24`	`24`	`model_params = {`
`25`		`- "N": mesa.visualization.UserSettableParameter(`
`26`		`- "slider",`
	`25`	`+ "N": mesa.visualization.Slider(`
`27`	`26`	`"Number of agents",`
`28`	`27`	`100,`
`29`	`28`	`2,`