Skip to content

Commit

Permalink
Repo move: Replace adamamer20 with projectmesa (#93)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
EwoutH and adamamer20 authored Sep 2, 2024
1 parent 3c284e4 commit 73a5024
Show file tree
Hide file tree
Showing 8 changed files with 32 additions and 30 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,29 +11,30 @@ DataFrames are optimized for simultaneous operations through [SIMD processing](h

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

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

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

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

## Installation

### Install from PyPI

```bash
pip install mesa-frames
```

### Install from Source

To install the most updated version of mesa-frames, you can clone the respository and install the package in editable mode.
To install the most updated version of mesa-frames, you can clone the repository and install the package in editable mode.

#### Cloning the Repository

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

```bash
git clone https://github.com/adamamer20/mesa_frames.git
git clone https://github.com/projectmesa/mesa-frames.git
cd mesa_frames
```

Expand Down Expand Up @@ -82,7 +83,7 @@ pip install -e .

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

You can find the API documentation [here](https://adamamer20.github.io/mesa-frames/api).
You can find the API documentation [here](https://projectmesa.github.io/mesa-frames/api).

### Creation of an Agent

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

For the full license text, see the [LICENSE](https://github.com/adamamer20/mesa_frames/blob/main/LICENSE) file in the GitHub repository.
For the full license text, see the [LICENSE](https://github.com/projectmesa/mesa-frames/blob/main/LICENSE) file in the GitHub repository.
6 changes: 3 additions & 3 deletions docs/api/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

# -- Project information -----------------------------------------------------
project = "mesa-frames"
author = "Adam Amer"
author = ["Project Mesa", "Adam Amer"]
copyright = f"2023, {author}"

# -- General configuration ---------------------------------------------------
Expand Down Expand Up @@ -56,8 +56,8 @@
autodoc_default_options = {"special-members": True, "exclude-members": "__weakref__"}

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

html_theme_options = {
"external_links": [
Expand Down
10 changes: 5 additions & 5 deletions docs/general/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ DataFrames are optimized for simultaneous operations through [SIMD processing](h

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

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

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

## Quick Start 🚀

Expand All @@ -32,7 +32,7 @@ pip install mesa-frames
#### Installing from Source

```bash
git clone https://github.com/adamamer20/mesa_frames.git
git clone https://github.com/projectmesa/mesa-frames.git
cd mesa_frames
pip install -e .
```
Expand Down Expand Up @@ -83,8 +83,8 @@ class MoneyModelDF(ModelDF):

## Get Involved! 🤝

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

## License

mesa-frames is available under the MIT License. See the [LICENSE](https://github.com/adamamer20/mesa_frames/blob/main/LICENSE) file for full details.
mesa-frames is available under the MIT License. See the [LICENSE](https://github.com/projectmesa/mesa-frames/blob/main/LICENSE) file for full details.
2 changes: 1 addition & 1 deletion docs/general/user-guide/0_getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Users can choose the backend that best suits their needs:
```

Currently, there are two implementations of AgentSetDF and GridDF, one for each backend implementation: AgentSetPandas and AgentSetPolars, and GridPandas and GridPolars.
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!
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!

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

Expand Down
10 changes: 5 additions & 5 deletions docs/general/user-guide/4_benchmarks.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@ mesa-frames offers significant performance improvements over the original mesa f

## Boltzmann Wealth Model 💰

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

### Comparison with mesa

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

### Comparison of mesa-frames implementations

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

## SugarScape with Instantaneous Growback 🍬

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

![Performance Graph SS IG](https://github.com/adamamer20/mesa-frames/raw/main/examples/benchmark_plot_0.png)
![Performance Graph SS IG](https://github.com/projectmesa/mesa-frames/raw/main/examples/benchmark_plot_0.png)
4 changes: 2 additions & 2 deletions mesa_frames/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ def __init__(self, width, height):
For more detailed information, refer to the full documentation and API reference.
Developed by: Adam Amer
Developed by: Project Mesa, Adam Amer
License: MIT
GitHub: https://github.com/adamamer20/mesa_frames
GitHub: https://github.com/projectmesa/mesa-frames
"""

from mesa_frames.concrete.agents import AgentsDF
Expand Down
10 changes: 5 additions & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Project information
site_name: mesa-frames
site_url: https://adamamer20.github.io/mesa-frames
repo_url: https://github.com/adamamer20/mesa-frames
repo_name: adamamer20/mesa-frames
site_url: https://projectmesa.github.io/mesa-frames
repo_url: https://github.com/projectmesa/mesa-frames
repo_name: projectmesa/mesa-frames
docs_dir: docs/general

# Theme configuration
Expand Down Expand Up @@ -73,7 +73,7 @@ markdown_extensions:
- pymdownx.keys
- pymdownx.magiclink:
repo_url_shorthand: true
user: adamamer20
user: projectmesa
repo: mesa-frames
- pymdownx.mark
- pymdownx.smartsymbols
Expand All @@ -97,7 +97,7 @@ extra_javascript:
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/adamamer20
link: https://github.com/projectmesa
- icon: fontawesome/brands/python
link: https://pypi.org/project/mesa-frames/

Expand Down
5 changes: 3 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ build-backend = "hatchling.build"
name = "mesa_frames"
description = "An extension to the Mesa framework which uses pandas/Polars DataFrames for enhanced performance"
authors = [
{ name = "Project Mesa Team", email = "projectmesa@googlegroups.com" },
{ name = "Adam Amer"},
]
license = { text = "MIT" }
Expand Down Expand Up @@ -50,8 +51,8 @@ dynamic = [


[project.urls]
Documentation = "https://adamamer20.github.io/mesa-frames"
Repository = "https://github.com/adamamer20/mesa-frames.git"
Documentation = "https://projectmesa.github.io/mesa-frames"
Repository = "https://github.com/projectmesa/mesa-frames.git"

[project.optional-dependencies]
mkdocs = [
Expand Down

0 comments on commit 73a5024

Please sign in to comment.