Skip to content

Commit 73a5024

Browse files
EwoutHadamamer20
andauthored
Repo move: Replace adamamer20 with projectmesa (#93)
* Replace adamamer20/mesa_frames --> projectmesa/mesa_frames * Replace adamamer20/mesa-frames --> projectmesa/mesa-frames * Replace adamamer20 --> projectmesa * added projectmesa as author * fix: point to mesa-frames instead of mesa_frames --------- Co-authored-by: Adam Amer <136176500+adamamer20@users.noreply.github.com>
1 parent 3c284e4 commit 73a5024

File tree

8 files changed

+32
-30
lines changed

8 files changed

+32
-30
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,29 +11,30 @@ DataFrames are optimized for simultaneous operations through [SIMD processing](h
1111

1212
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).
1313

14-
![Performance Graph with Mesa](https://github.com/adamamer20/mesa_frames/blob/main/examples/boltzmann_wealth/boltzmann_with_mesa.png)
14+
![Performance Graph with Mesa](https://github.com/projectmesa/mesa-frames/blob/main/examples/boltzmann_wealth/boltzmann_with_mesa.png)
1515

16-
![Performance Graph without Mesa](https://github.com/adamamer20/mesa_frames/blob/main/examples/boltzmann_wealth/boltzmann_no_mesa.png)
16+
![Performance Graph without Mesa](https://github.com/projectmesa/mesa-frames/blob/main/examples/boltzmann_wealth/boltzmann_no_mesa.png)
1717

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)
1919

2020
## Installation
2121

2222
### Install from PyPI
23+
2324
```bash
2425
pip install mesa-frames
2526
```
2627

2728
### Install from Source
2829

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.
3031

3132
#### Cloning the Repository
3233

3334
To get started with mesa-frames, first clone the repository from GitHub:
3435

3536
```bash
36-
git clone https://github.com/adamamer20/mesa_frames.git
37+
git clone https://github.com/projectmesa/mesa-frames.git
3738
cd mesa_frames
3839
```
3940

@@ -82,7 +83,7 @@ pip install -e .
8283

8384
**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.
8485

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).
8687

8788
### Creation of an Agent
8889

@@ -159,4 +160,4 @@ mesa-frames is made available under the MIT License. This license allows you to
159160
- The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
160161
- The software is provided "as is", without warranty of any kind.
161162

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.

docs/api/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
# -- Project information -----------------------------------------------------
1212
project = "mesa-frames"
13-
author = "Adam Amer"
13+
author = ["Project Mesa", "Adam Amer"]
1414
copyright = f"2023, {author}"
1515

1616
# -- General configuration ---------------------------------------------------
@@ -56,8 +56,8 @@
5656
autodoc_default_options = {"special-members": True, "exclude-members": "__weakref__"}
5757

5858
# -- GitHub link and user guide settings -------------------------------------
59-
github_root = "https://github.com/adamamer20/mesa-frames"
60-
web_root = "https://adamamer20.github.io/mesa-frames"
59+
github_root = "https://github.com/projectmesa/mesa-frames"
60+
web_root = "https://projectmesa.github.io/mesa-frames"
6161

6262
html_theme_options = {
6363
"external_links": [

docs/general/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ DataFrames are optimized for simultaneous operations through [SIMD processing](h
1515

1616
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):
1717

18-
![Performance Graph with Mesa](https://github.com/adamamer20/mesa-frames/raw/main/examples/boltzmann_wealth/boltzmann_with_mesa.png)
18+
![Performance Graph with Mesa](https://github.com/projectmesa/mesa-frames/raw/main/examples/boltzmann_wealth/boltzmann_with_mesa.png)
1919

20-
![Performance Graph without Mesa](https://github.com/adamamer20/mesa-frames/raw/main/examples/boltzmann_wealth/boltzmann_no_mesa.png)
20+
![Performance Graph without Mesa](https://github.com/projectmesa/mesa-frames/raw/main/examples/boltzmann_wealth/boltzmann_no_mesa.png)
2121

2222
## Quick Start 🚀
2323

@@ -32,7 +32,7 @@ pip install mesa-frames
3232
#### Installing from Source
3333

3434
```bash
35-
git clone https://github.com/adamamer20/mesa_frames.git
35+
git clone https://github.com/projectmesa/mesa-frames.git
3636
cd mesa_frames
3737
pip install -e .
3838
```
@@ -83,8 +83,8 @@ class MoneyModelDF(ModelDF):
8383

8484
## Get Involved! 🤝
8585

86-
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.
8787

8888
## License
8989

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.

docs/general/user-guide/0_getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Users can choose the backend that best suits their needs:
8787
```
8888

8989
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!
9191

9292
Soon we will also have multiple other backends like Dask, cuDF, and Dask-cuDF!
9393

docs/general/user-guide/4_benchmarks.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@ mesa-frames offers significant performance improvements over the original mesa f
44

55
## Boltzmann Wealth Model 💰
66

7-
[View the benchmark script](https://github.com/adamamer20/mesa-frames/blob/main/docs/scripts/readme_plot.py)
7+
[View the benchmark script](https://github.com/projectmesa/mesa-frames/blob/main/docs/scripts/readme_plot.py)
88

99
### Comparison with mesa
1010

11-
![Performance Graph BW](https://github.com/adamamer20/mesa-frames/raw/main/docs/general/images/readme_plot_0.png)
11+
![Performance Graph BW](https://github.com/projectmesa/mesa-frames/raw/main/docs/general/images/readme_plot_0.png)
1212

1313
### Comparison of mesa-frames implementations
1414

15-
![Performance Graph BW without Mesa](https://github.com/adamamer20/mesa-frames/raw/main/docs/general/images/readme_plot_1.png)
15+
![Performance Graph BW without Mesa](https://github.com/projectmesa/mesa-frames/raw/main/docs/general/images/readme_plot_1.png)
1616

1717
## SugarScape with Instantaneous Growback 🍬
1818

19-
[View the benchmark script](https://github.com/adamamer20/mesa-frames/blob/main/examples/sugarscape_ig/performance_comparison.py)
19+
[View the benchmark script](https://github.com/projectmesa/mesa-frames/blob/main/examples/sugarscape_ig/performance_comparison.py)
2020

21-
![Performance Graph SS IG](https://github.com/adamamer20/mesa-frames/raw/main/examples/benchmark_plot_0.png)
21+
![Performance Graph SS IG](https://github.com/projectmesa/mesa-frames/raw/main/examples/benchmark_plot_0.png)

mesa_frames/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ def __init__(self, width, height):
3737
3838
For more detailed information, refer to the full documentation and API reference.
3939
40-
Developed by: Adam Amer
40+
Developed by: Project Mesa, Adam Amer
4141
License: MIT
42-
GitHub: https://github.com/adamamer20/mesa_frames
42+
GitHub: https://github.com/projectmesa/mesa-frames
4343
"""
4444

4545
from mesa_frames.concrete.agents import AgentsDF

mkdocs.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Project information
22
site_name: mesa-frames
3-
site_url: https://adamamer20.github.io/mesa-frames
4-
repo_url: https://github.com/adamamer20/mesa-frames
5-
repo_name: adamamer20/mesa-frames
3+
site_url: https://projectmesa.github.io/mesa-frames
4+
repo_url: https://github.com/projectmesa/mesa-frames
5+
repo_name: projectmesa/mesa-frames
66
docs_dir: docs/general
77

88
# Theme configuration
@@ -73,7 +73,7 @@ markdown_extensions:
7373
- pymdownx.keys
7474
- pymdownx.magiclink:
7575
repo_url_shorthand: true
76-
user: adamamer20
76+
user: projectmesa
7777
repo: mesa-frames
7878
- pymdownx.mark
7979
- pymdownx.smartsymbols
@@ -97,7 +97,7 @@ extra_javascript:
9797
extra:
9898
social:
9999
- icon: fontawesome/brands/github
100-
link: https://github.com/adamamer20
100+
link: https://github.com/projectmesa
101101
- icon: fontawesome/brands/python
102102
link: https://pypi.org/project/mesa-frames/
103103

pyproject.toml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ build-backend = "hatchling.build"
66
name = "mesa_frames"
77
description = "An extension to the Mesa framework which uses pandas/Polars DataFrames for enhanced performance"
88
authors = [
9+
{ name = "Project Mesa Team", email = "projectmesa@googlegroups.com" },
910
{ name = "Adam Amer"},
1011
]
1112
license = { text = "MIT" }
@@ -50,8 +51,8 @@ dynamic = [
5051

5152

5253
[project.urls]
53-
Documentation = "https://adamamer20.github.io/mesa-frames"
54-
Repository = "https://github.com/adamamer20/mesa-frames.git"
54+
Documentation = "https://projectmesa.github.io/mesa-frames"
55+
Repository = "https://github.com/projectmesa/mesa-frames.git"
5556

5657
[project.optional-dependencies]
5758
mkdocs = [

0 commit comments

Comments
 (0)