Skip to content

Commit 46a18b9

Browse files
authored
Merge pull request #30 from tpike3/main
add readme and history
2 parents a4d9242 + d7ee0f4 commit 46a18b9

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

HISTORY.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Release History
2+
3+
---
4+
5+
## 0.1 (2023-09-23)
6+
7+
---
8+
9+
Creation of separate PyPI mesa visualization package. This allows core mesa to be python based, while retaining earlier
10+
work an JS option.

README.MD

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Mesa-Viz-Tornado
2+
3+
### What is this package?
4+
5+
This package contains Mesa's (Agent Based Modeling in Python) JavaScript based
6+
visualizaton module.
7+
8+
### Uses
9+
10+
1. **Models < 2.0** Users who have Mesa models less than 2.0 can use mesa-viz-tornado to ensure their models continue
11+
to work.
12+
2. **Models with Unique Visualization Requirements** If users have a unique visualization requirements and proficiency
13+
in JavaScript those package can offer additional options for customizing graphics for their agent based models.
14+
15+
### Future State
16+
17+
As Mesa is an open source volunteer project, we always welcome contributors to aid in its development. The future state
18+
of this package will depend on Mesa user demand and contributors who can continue to improve this package.
19+
20+

0 commit comments

Comments
 (0)