You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-7Lines changed: 8 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,29 +11,30 @@ DataFrames are optimized for simultaneous operations through [SIMD processing](h
11
11
12
12
The following is a performance graph showing execution time using mesa and mesa-frames for the [Boltzmann Wealth model](https://mesa.readthedocs.io/en/stable/tutorials/intro_tutorial.html).
13
13
14
-

14
+

15
15
16
-

16
+

17
17
18
-
(The script used to generate the graph can be found [here](https://github.com/adamamer20/mesa_frames/blob/main/examples/boltzmann_wealth/performance_plot.py), but if you want to additionally compare vs Mesa, you have to uncomment `mesa_implementation` and its label)
18
+
(The script used to generate the graph can be found [here](https://github.com/projectmesa/mesa-frames/blob/main/examples/boltzmann_wealth/performance_plot.py), but if you want to additionally compare vs Mesa, you have to uncomment `mesa_implementation` and its label)
19
19
20
20
## Installation
21
21
22
22
### Install from PyPI
23
+
23
24
```bash
24
25
pip install mesa-frames
25
26
```
26
27
27
28
### Install from Source
28
29
29
-
To install the most updated version of mesa-frames, you can clone the respository and install the package in editable mode.
30
+
To install the most updated version of mesa-frames, you can clone the repository and install the package in editable mode.
30
31
31
32
#### Cloning the Repository
32
33
33
34
To get started with mesa-frames, first clone the repository from GitHub:
**Note:** mesa-frames is currently in its early stages of development. As such, the usage patterns and API are subject to change. Breaking changes may be introduced. Reports of feedback and issues are encouraged.
84
85
85
-
You can find the API documentation [here](https://adamamer20.github.io/mesa-frames/api).
86
+
You can find the API documentation [here](https://projectmesa.github.io/mesa-frames/api).
86
87
87
88
### Creation of an Agent
88
89
@@ -159,4 +160,4 @@ mesa-frames is made available under the MIT License. This license allows you to
159
160
- The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
160
161
- The software is provided "as is", without warranty of any kind.
161
162
162
-
For the full license text, see the [LICENSE](https://github.com/adamamer20/mesa_frames/blob/main/LICENSE) file in the GitHub repository.
163
+
For the full license text, see the [LICENSE](https://github.com/projectmesa/mesa-frames/blob/main/LICENSE) file in the GitHub repository.
Copy file name to clipboardExpand all lines: docs/general/index.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,9 +15,9 @@ DataFrames are optimized for simultaneous operations through [SIMD processing](h
15
15
16
16
Check out our performance graphs comparing mesa and mesa-frames for the [Boltzmann Wealth model](https://mesa.readthedocs.io/en/stable/tutorials/intro_tutorial.html):
17
17
18
-

18
+

19
19
20
-

20
+

mesa-frames is in its early stages, and we welcome your feedback and contributions! Check out our [GitHub repository](https://github.com/adamamer20/mesa_frames) to get started.
86
+
mesa-frames is in its early stages, and we welcome your feedback and contributions! Check out our [GitHub repository](https://github.com/projectmesa/mesa-frames) to get started.
87
87
88
88
## License
89
89
90
-
mesa-frames is available under the MIT License. See the [LICENSE](https://github.com/adamamer20/mesa_frames/blob/main/LICENSE) file for full details.
90
+
mesa-frames is available under the MIT License. See the [LICENSE](https://github.com/projectmesa/mesa-frames/blob/main/LICENSE) file for full details.
Copy file name to clipboardExpand all lines: docs/general/user-guide/0_getting-started.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -87,7 +87,7 @@ Users can choose the backend that best suits their needs:
87
87
```
88
88
89
89
Currently, there are two implementations of AgentSetDF and GridDF, one for each backend implementation: AgentSetPandas and AgentSetPolars, and GridPandas and GridPolars.
90
-
We encourage you to use the Polars implementation for increased performance. We are working on creating a unique interface [here](https://github.com/adamamer20/mesa-frames/discussions/12). Let us know what you think!
90
+
We encourage you to use the Polars implementation for increased performance. We are working on creating a unique interface [here](https://github.com/projectmesa/mesa-frames/discussions/12). Let us know what you think!
91
91
92
92
Soon we will also have multiple other backends like Dask, cuDF, and Dask-cuDF!
0 commit comments