Skip to content

Commit 63d02a6

Browse files
committed
breaking change: Rename mesa-viz-tornado namespace to visualization_old
1 parent f4ae953 commit 63d02a6

20 files changed

+159
-159
lines changed

docs/mesa.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Subpackages
44

55
```{toctree}
6-
mesa.visualization
6+
mesa.visualization_old
77
```
88

99
## Submodules

docs/mesa.visualization.md

Lines changed: 0 additions & 46 deletions
This file was deleted.

docs/mesa.visualization.modules.md

Lines changed: 0 additions & 76 deletions
This file was deleted.

docs/mesa.visualization_old.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# mesa.visualization_old package
2+
3+
## Subpackages
4+
5+
```{toctree}
6+
mesa.visualization_old.modules
7+
```
8+
9+
## Submodules
10+
11+
## mesa.visualization_old.ModularVisualization module
12+
13+
```{eval-rst}
14+
.. automodule:: mesa.visualization_old.ModularVisualization
15+
:members:
16+
:undoc-members:
17+
:show-inheritance:
18+
```
19+
20+
## mesa.visualization_old.TextVisualization module
21+
22+
```{eval-rst}
23+
.. automodule:: mesa.visualization_old.TextVisualization
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
```
28+
29+
## mesa.visualization_old.UserParam module
30+
31+
```{eval-rst}
32+
.. automodule:: mesa.visualization_old.UserParam
33+
:members:
34+
:undoc-members:
35+
:show-inheritance:
36+
37+
```
38+
39+
## Module contents
40+
41+
```{eval-rst}
42+
.. automodule:: mesa.visualization_old
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
```
Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# mesa.visualization_old.modules package
2+
3+
## Submodules
4+
5+
## mesa.visualization_old.modules.BarChartVisualization module
6+
7+
```{eval-rst}
8+
.. automodule:: mesa.visualization_old.modules.BarChartVisualization
9+
:members:
10+
:undoc-members:
11+
:show-inheritance:
12+
```
13+
14+
## mesa.visualization_old.modules.CanvasGridVisualization module
15+
16+
```{eval-rst}
17+
.. automodule:: mesa.visualization_old.modules.CanvasGridVisualization
18+
:members:
19+
:undoc-members:
20+
:show-inheritance:
21+
```
22+
23+
## mesa.visualization_old.modules.ChartVisualization module
24+
25+
```{eval-rst}
26+
.. automodule:: mesa.visualization_old.modules.ChartVisualization
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
```
31+
32+
## mesa.visualization_old.modules.HexGridVisualization module
33+
34+
```{eval-rst}
35+
.. automodule:: mesa.visualization_old.modules.HexGridVisualization
36+
:members:
37+
:undoc-members:
38+
:show-inheritance:
39+
```
40+
41+
## mesa.visualization_old.modules.NetworkVisualization module
42+
43+
```{eval-rst}
44+
.. automodule:: mesa.visualization_old.modules.NetworkVisualization
45+
:members:
46+
:undoc-members:
47+
:show-inheritance:
48+
```
49+
50+
## mesa.visualization_old.modules.PieChartVisualization module
51+
52+
```{eval-rst}
53+
.. automodule:: mesa.visualization_old.modules.PieChartVisualization
54+
:members:
55+
:undoc-members:
56+
:show-inheritance:
57+
```
58+
59+
## mesa.visualization_old.modules.TextVisualization module
60+
61+
```{eval-rst}
62+
.. automodule:: mesa.visualization_old.modules.TextVisualization
63+
:members:
64+
:undoc-members:
65+
:show-inheritance:
66+
67+
```
68+
69+
## Module contents
70+
71+
```{eval-rst}
72+
.. automodule:: mesa.visualization_old.modules
73+
:members:
74+
:undoc-members:
75+
:show-inheritance:
76+
```

docs/modular-visualization.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Modular Visualization - An In-Depth Look
1+
# Modular Visualization - An In-Depth Look (Deprecated)
22

33
Modular visualization is one of Mesa's core features. Mesa is designed
44
to provide predefined visualization modules, which can be easily
@@ -127,7 +127,7 @@ Suppose we want a module which can get an arbitrary variable out of a
127127
model, and display its name and value. Let's create a new subclass:
128128

129129
```python
130-
from mesa.visualization.ModularTextVisualization import TextElement
130+
from mesa.visualization_old.ModularTextVisualization import TextElement
131131

132132
class AttributeElement(TextElement):
133133
def __init__(self, attr_name):
@@ -205,7 +205,7 @@ Now let's take a look at the TextModule's Python counterpart,
205205
here's the whole thing:
206206

207207
```python
208-
from mesa.visualization.ModularVisualization import VisualizationElement
208+
from mesa.visualization_old.ModularVisualization import VisualizationElement
209209

210210
class TextElement(VisualizationElement):
211211
js_includes = ["TextModule.js"]
@@ -240,8 +240,8 @@ the list, the code passes that element of the data to the *render*
240240
function of the corresponding element, in the elements array.
241241

242242
Currently, module JavaScript files live in the
243-
*mesa/visualization/templates* directory, and the Python files live in
244-
*mesa/visualization/modules*.
243+
*mesa/visualization_old/templates* directory, and the Python files live in
244+
*mesa/visualization_old/modules*.
245245

246246
When creating a new module, the Python and JavaScript code need to be
247247
written in synch: the module Python-side **render** method needs to

docs/overview.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -119,8 +119,8 @@ batch_df = batch_run.get_model_vars_dataframe()
119119

120120
Finally, you may want to directly observe your model as it runs. Mesa's main visualization tool uses a small local web server to render the model in a browser, using JavaScript. There are different components for drawing different types of data: for example, grids for drawing agents moving around on a grid, or charts for showing how some data changes as the model runs. A few core modules are:
121121

122-
- mesa.visualization.ModularVisualization
123-
- mesa.visualization.modules
122+
- mesa.visualization_old.ModularVisualization
123+
- mesa.visualization_old.modules
124124

125125
To quickly spin up a model visualization, you might do something like:
126126

@@ -135,8 +135,8 @@ def agent_portrayal(agent):
135135
"r": 0.5}
136136
return portrayal
137137

138-
grid = mesa.visualization.CanvasGrid(agent_portrayal, 10, 10, 500, 500)
139-
server = mesa.visualization.ModularServer(MyModel,
138+
grid = mesa.visualization_old.CanvasGrid(agent_portrayal, 10, 10, 500, 500)
139+
server = mesa.visualization_old.ModularServer(MyModel,
140140
[grid],
141141
"My Model",
142142
{'n_agents': 10})

0 commit comments

Comments
 (0)