projectmesa · Corvince · Oct 18, 2024 · Oct 18, 2024 · Oct 18, 2024 · Oct 18, 2024
diff --git a/docs/tutorials/visualization_tutorial.ipynb b/docs/tutorials/visualization_tutorial.ipynb
@@ -48,7 +48,7 @@
     "\n",
     "# You can either define the BoltzmannWealthModel (aka MoneyModel) or install it\n",
     "\n",
-    "from mesa.examples.basic import BoltzmannWealthModel"
+    "from mesa.examples import BoltzmannWealthModel"
    ]
   },
   {
@@ -87,7 +87,7 @@
    "outputs": [],
    "source": [
     "model_params = {\n",
-    "    \"N\": {\n",
+    "    \"n\": {\n",
     "        \"type\": \"SliderInt\",\n",
     "        \"value\": 50,\n",
     "        \"label\": \"Number of agents:\",\n",

diff --git a/examples/basic/__init__.py b/examples/basic/__init__.py
diff --git a/mesa/__init__.py b/mesa/__init__.py
@@ -5,7 +5,6 @@
 
 import datetime
 
-import mesa.examples as examples
 import mesa.experimental as experimental
 import mesa.space as space
 import mesa.time as time
@@ -22,7 +21,6 @@
     "DataCollector",
     "batch_run",
     "experimental",
-    "examples",
 ]
 
 __title__ = "mesa"

diff --git a/mesa/examples.py b/mesa/examples.py
diff --git a/examples/README.md → mesa/examples/README.md b/examples/README.md → mesa/examples/README.md
diff --git a/mesa/examples/__init__.py b/mesa/examples/__init__.py
@@ -0,0 +1,13 @@
+from mesa.examples.basic.boid_flockers.model import BoidFlockers
+from mesa.examples.basic.boltzmann_wealth_model.model import BoltzmannWealthModel
+from mesa.examples.basic.conways_game_of_life.model import ConwaysGameOfLife
+from mesa.examples.basic.schelling.model import Schelling
+from mesa.examples.basic.virus_on_network.model import VirusOnNetwork
+
+__all__ = [
+    "BoidFlockers",
+    "BoltzmannWealthModel",
+    "ConwaysGameOfLife",
+    "Schelling",
+    "VirusOnNetwork",
+]
diff --git a/examples/__init__.py → mesa/examples/advanced/__init__.py b/examples/__init__.py → mesa/examples/advanced/__init__.py
diff --git a/...vil_violence/Epstein Civil Violence.ipynb → ...vil_violence/Epstein Civil Violence.ipynb b/...vil_violence/Epstein Civil Violence.ipynb → ...vil_violence/Epstein Civil Violence.ipynb
diff --git a/...advanced/epstein_civil_violence/Readme.md → ...advanced/epstein_civil_violence/Readme.md b/...advanced/epstein_civil_violence/Readme.md → ...advanced/epstein_civil_violence/Readme.md
diff --git a/examples/advanced/__init__.py → ...olence/epstein_civil_violence/__init__.py b/examples/advanced/__init__.py → ...olence/epstein_civil_violence/__init__.py
diff --git a/..._violence/epstein_civil_violence/agent.py → ..._violence/epstein_civil_violence/agent.py b/..._violence/epstein_civil_violence/agent.py → ..._violence/epstein_civil_violence/agent.py
diff --git a/..._violence/epstein_civil_violence/model.py → ..._violence/epstein_civil_violence/model.py b/..._violence/epstein_civil_violence/model.py → ..._violence/epstein_civil_violence/model.py
diff --git a/...lence/epstein_civil_violence/portrayal.py → ...lence/epstein_civil_violence/portrayal.py b/...lence/epstein_civil_violence/portrayal.py → ...lence/epstein_civil_violence/portrayal.py
diff --git a/...violence/epstein_civil_violence/server.py → ...violence/epstein_civil_violence/server.py b/...violence/epstein_civil_violence/server.py → ...violence/epstein_civil_violence/server.py
diff --git a/...d/epstein_civil_violence/requirements.txt → ...d/epstein_civil_violence/requirements.txt b/...d/epstein_civil_violence/requirements.txt → ...d/epstein_civil_violence/requirements.txt
diff --git a/...es/advanced/epstein_civil_violence/run.py → ...es/advanced/epstein_civil_violence/run.py b/...es/advanced/epstein_civil_violence/run.py → ...es/advanced/epstein_civil_violence/run.py
diff --git a/examples/advanced/pd_grid/analysis.ipynb → .../examples/advanced/pd_grid/analysis.ipynb b/examples/advanced/pd_grid/analysis.ipynb → .../examples/advanced/pd_grid/analysis.ipynb
diff --git a/...olence/epstein_civil_violence/__init__.py → ...ples/advanced/pd_grid/pd_grid/__init__.py b/...olence/epstein_civil_violence/__init__.py → ...ples/advanced/pd_grid/pd_grid/__init__.py
diff --git a/examples/advanced/pd_grid/pd_grid/agent.py → ...xamples/advanced/pd_grid/pd_grid/agent.py b/examples/advanced/pd_grid/pd_grid/agent.py → ...xamples/advanced/pd_grid/pd_grid/agent.py
diff --git a/examples/advanced/pd_grid/pd_grid/model.py → ...xamples/advanced/pd_grid/pd_grid/model.py b/examples/advanced/pd_grid/pd_grid/model.py → ...xamples/advanced/pd_grid/pd_grid/model.py
diff --git a/...les/advanced/pd_grid/pd_grid/portrayal.py → ...les/advanced/pd_grid/pd_grid/portrayal.py b/...les/advanced/pd_grid/pd_grid/portrayal.py → ...les/advanced/pd_grid/pd_grid/portrayal.py
diff --git a/examples/advanced/pd_grid/pd_grid/server.py → ...amples/advanced/pd_grid/pd_grid/server.py b/examples/advanced/pd_grid/pd_grid/server.py → ...amples/advanced/pd_grid/pd_grid/server.py
diff --git a/examples/advanced/pd_grid/readme.md → mesa/examples/advanced/pd_grid/readme.md b/examples/advanced/pd_grid/readme.md → mesa/examples/advanced/pd_grid/readme.md
diff --git a/examples/advanced/pd_grid/requirements.txt → ...xamples/advanced/pd_grid/requirements.txt b/examples/advanced/pd_grid/requirements.txt → ...xamples/advanced/pd_grid/requirements.txt
diff --git a/examples/advanced/pd_grid/run.py → mesa/examples/advanced/pd_grid/run.py b/examples/advanced/pd_grid/run.py → mesa/examples/advanced/pd_grid/run.py
diff --git a/examples/advanced/sugarscape_g1mt/Readme.md → ...amples/advanced/sugarscape_g1mt/Readme.md b/examples/advanced/sugarscape_g1mt/Readme.md → ...amples/advanced/sugarscape_g1mt/Readme.md
diff --git a/examples/advanced/sugarscape_g1mt/app.py → .../examples/advanced/sugarscape_g1mt/app.py b/examples/advanced/sugarscape_g1mt/app.py → .../examples/advanced/sugarscape_g1mt/app.py
diff --git a/...advanced/sugarscape_g1mt/requirements.txt → ...advanced/sugarscape_g1mt/requirements.txt b/...advanced/sugarscape_g1mt/requirements.txt → ...advanced/sugarscape_g1mt/requirements.txt
diff --git a/examples/advanced/sugarscape_g1mt/run.py → .../examples/advanced/sugarscape_g1mt/run.py b/examples/advanced/sugarscape_g1mt/run.py → .../examples/advanced/sugarscape_g1mt/run.py
diff --git a/...ples/advanced/pd_grid/pd_grid/__init__.py → ...garscape_g1mt/sugarscape_g1mt/__init__.py b/...ples/advanced/pd_grid/pd_grid/__init__.py → ...garscape_g1mt/sugarscape_g1mt/__init__.py
diff --git a/.../sugarscape_g1mt/sugarscape_g1mt/model.py → .../sugarscape_g1mt/sugarscape_g1mt/model.py b/.../sugarscape_g1mt/sugarscape_g1mt/model.py → .../sugarscape_g1mt/sugarscape_g1mt/model.py
diff --git a/...e_g1mt/sugarscape_g1mt/resource_agents.py → ...e_g1mt/sugarscape_g1mt/resource_agents.py b/...e_g1mt/sugarscape_g1mt/resource_agents.py → ...e_g1mt/sugarscape_g1mt/resource_agents.py
diff --git a/...sugarscape_g1mt/sugarscape_g1mt/server.py → ...sugarscape_g1mt/sugarscape_g1mt/server.py b/...sugarscape_g1mt/sugarscape_g1mt/server.py → ...sugarscape_g1mt/sugarscape_g1mt/server.py
diff --git a/...rscape_g1mt/sugarscape_g1mt/sugar-map.txt → ...rscape_g1mt/sugarscape_g1mt/sugar-map.txt b/...rscape_g1mt/sugarscape_g1mt/sugar-map.txt → ...rscape_g1mt/sugarscape_g1mt/sugar-map.txt
diff --git a/...ape_g1mt/sugarscape_g1mt/trader_agents.py → ...ape_g1mt/sugarscape_g1mt/trader_agents.py b/...ape_g1mt/sugarscape_g1mt/trader_agents.py → ...ape_g1mt/sugarscape_g1mt/trader_agents.py
diff --git a/examples/advanced/sugarscape_g1mt/tests.py → ...xamples/advanced/sugarscape_g1mt/tests.py b/examples/advanced/sugarscape_g1mt/tests.py → ...xamples/advanced/sugarscape_g1mt/tests.py
diff --git a/examples/advanced/wolf_sheep/Readme.md → mesa/examples/advanced/wolf_sheep/Readme.md b/examples/advanced/wolf_sheep/Readme.md → mesa/examples/advanced/wolf_sheep/Readme.md
diff --git a/...garscape_g1mt/sugarscape_g1mt/__init__.py → .../examples/advanced/wolf_sheep/__init__.py b/...garscape_g1mt/sugarscape_g1mt/__init__.py → .../examples/advanced/wolf_sheep/__init__.py
diff --git a/...ples/advanced/wolf_sheep/requirements.txt → ...ples/advanced/wolf_sheep/requirements.txt b/...ples/advanced/wolf_sheep/requirements.txt → ...ples/advanced/wolf_sheep/requirements.txt
diff --git a/examples/advanced/wolf_sheep/run.py → mesa/examples/advanced/wolf_sheep/run.py b/examples/advanced/wolf_sheep/run.py → mesa/examples/advanced/wolf_sheep/run.py
diff --git a/examples/advanced/wolf_sheep/__init__.py → ...dvanced/wolf_sheep/wolf_sheep/__init__.py b/examples/advanced/wolf_sheep/__init__.py → ...dvanced/wolf_sheep/wolf_sheep/__init__.py
diff --git a/.../advanced/wolf_sheep/wolf_sheep/agents.py → .../advanced/wolf_sheep/wolf_sheep/agents.py b/.../advanced/wolf_sheep/wolf_sheep/agents.py → .../advanced/wolf_sheep/wolf_sheep/agents.py
diff --git a/...s/advanced/wolf_sheep/wolf_sheep/model.py → ...s/advanced/wolf_sheep/wolf_sheep/model.py b/...s/advanced/wolf_sheep/wolf_sheep/model.py → ...s/advanced/wolf_sheep/wolf_sheep/model.py
diff --git a/...wolf_sheep/wolf_sheep/resources/sheep.png → ...wolf_sheep/wolf_sheep/resources/sheep.png b/...wolf_sheep/wolf_sheep/resources/sheep.png → ...wolf_sheep/wolf_sheep/resources/sheep.png
diff --git a/.../wolf_sheep/wolf_sheep/resources/wolf.png → .../wolf_sheep/wolf_sheep/resources/wolf.png b/.../wolf_sheep/wolf_sheep/resources/wolf.png → .../wolf_sheep/wolf_sheep/resources/wolf.png
diff --git a/.../advanced/wolf_sheep/wolf_sheep/server.py → .../advanced/wolf_sheep/wolf_sheep/server.py b/.../advanced/wolf_sheep/wolf_sheep/server.py → .../advanced/wolf_sheep/wolf_sheep/server.py
diff --git a/...dvanced/wolf_sheep/wolf_sheep/__init__.py → mesa/examples/basic/__init__.py b/...dvanced/wolf_sheep/wolf_sheep/__init__.py → mesa/examples/basic/__init__.py
diff --git a/examples/basic/boid_flockers/Readme.md → mesa/examples/basic/boid_flockers/Readme.md b/examples/basic/boid_flockers/Readme.md → mesa/examples/basic/boid_flockers/Readme.md
diff --git a/mesa/examples/basic/boid_flockers/__init__.py b/mesa/examples/basic/boid_flockers/__init__.py
diff --git a/examples/basic/boid_flockers/agents.py → mesa/examples/basic/boid_flockers/agents.py b/examples/basic/boid_flockers/agents.py → mesa/examples/basic/boid_flockers/agents.py
diff --git a/examples/basic/boid_flockers/app.py → mesa/examples/basic/boid_flockers/app.py b/examples/basic/boid_flockers/app.py → mesa/examples/basic/boid_flockers/app.py
diff --git a/examples/basic/boid_flockers/model.py → mesa/examples/basic/boid_flockers/model.py b/examples/basic/boid_flockers/model.py → mesa/examples/basic/boid_flockers/model.py
diff --git a/...es/basic/boltzmann_wealth_model/Readme.md → ...es/basic/boltzmann_wealth_model/Readme.md b/...es/basic/boltzmann_wealth_model/Readme.md → ...es/basic/boltzmann_wealth_model/Readme.md
diff --git a/mesa/examples/basic/boltzmann_wealth_model/__init__.py b/mesa/examples/basic/boltzmann_wealth_model/__init__.py
diff --git a/...es/basic/boltzmann_wealth_model/agents.py → ...es/basic/boltzmann_wealth_model/agents.py b/...es/basic/boltzmann_wealth_model/agents.py → ...es/basic/boltzmann_wealth_model/agents.py
diff --git a/examples/basic/boltzmann_wealth_model/app.py → ...mples/basic/boltzmann_wealth_model/app.py b/examples/basic/boltzmann_wealth_model/app.py → ...mples/basic/boltzmann_wealth_model/app.py
diff --git a/...les/basic/boltzmann_wealth_model/model.py → ...les/basic/boltzmann_wealth_model/model.py b/...les/basic/boltzmann_wealth_model/model.py → ...les/basic/boltzmann_wealth_model/model.py
diff --git a/...es/basic/boltzmann_wealth_model/st_app.py → ...es/basic/boltzmann_wealth_model/st_app.py b/...es/basic/boltzmann_wealth_model/st_app.py → ...es/basic/boltzmann_wealth_model/st_app.py
diff --git a/...ples/basic/conways_game_of_life/Readme.md → ...ples/basic/conways_game_of_life/Readme.md b/...ples/basic/conways_game_of_life/Readme.md → ...ples/basic/conways_game_of_life/Readme.md
diff --git a/mesa/examples/basic/conways_game_of_life/__init__.py b/mesa/examples/basic/conways_game_of_life/__init__.py
diff --git a/...ples/basic/conways_game_of_life/agents.py → ...ples/basic/conways_game_of_life/agents.py b/...ples/basic/conways_game_of_life/agents.py → ...ples/basic/conways_game_of_life/agents.py
diff --git a/examples/basic/conways_game_of_life/model.py → ...mples/basic/conways_game_of_life/model.py b/examples/basic/conways_game_of_life/model.py → ...mples/basic/conways_game_of_life/model.py
diff --git a/...s/basic/conways_game_of_life/portrayal.py → ...s/basic/conways_game_of_life/portrayal.py b/...s/basic/conways_game_of_life/portrayal.py → ...s/basic/conways_game_of_life/portrayal.py
diff --git a/...sic/conways_game_of_life/requirements.txt → ...sic/conways_game_of_life/requirements.txt b/...sic/conways_game_of_life/requirements.txt → ...sic/conways_game_of_life/requirements.txt
diff --git a/...ples/basic/conways_game_of_life/server.py → ...ples/basic/conways_game_of_life/server.py b/...ples/basic/conways_game_of_life/server.py → ...ples/basic/conways_game_of_life/server.py
diff --git a/...ples/basic/conways_game_of_life/st_app.py → ...ples/basic/conways_game_of_life/st_app.py b/...ples/basic/conways_game_of_life/st_app.py → ...ples/basic/conways_game_of_life/st_app.py
diff --git a/examples/basic/schelling/README.md → mesa/examples/basic/schelling/README.md b/examples/basic/schelling/README.md → mesa/examples/basic/schelling/README.md
diff --git a/mesa/examples/basic/schelling/__init__.py b/mesa/examples/basic/schelling/__init__.py
diff --git a/examples/basic/schelling/agents.py → mesa/examples/basic/schelling/agents.py b/examples/basic/schelling/agents.py → mesa/examples/basic/schelling/agents.py
diff --git a/examples/basic/schelling/analysis.ipynb → mesa/examples/basic/schelling/analysis.ipynb b/examples/basic/schelling/analysis.ipynb → mesa/examples/basic/schelling/analysis.ipynb
diff --git a/examples/basic/schelling/app.py → mesa/examples/basic/schelling/app.py b/examples/basic/schelling/app.py → mesa/examples/basic/schelling/app.py
diff --git a/examples/basic/schelling/model.py → mesa/examples/basic/schelling/model.py b/examples/basic/schelling/model.py → mesa/examples/basic/schelling/model.py
diff --git a/examples/basic/virus_on_network/README.md → ...examples/basic/virus_on_network/README.md b/examples/basic/virus_on_network/README.md → ...examples/basic/virus_on_network/README.md
diff --git a/mesa/examples/basic/virus_on_network/__init__.py b/mesa/examples/basic/virus_on_network/__init__.py
diff --git a/examples/basic/virus_on_network/agents.py → ...examples/basic/virus_on_network/agents.py b/examples/basic/virus_on_network/agents.py → ...examples/basic/virus_on_network/agents.py
diff --git a/examples/basic/virus_on_network/app.py → mesa/examples/basic/virus_on_network/app.py b/examples/basic/virus_on_network/app.py → mesa/examples/basic/virus_on_network/app.py
diff --git a/examples/basic/virus_on_network/model.py → .../examples/basic/virus_on_network/model.py b/examples/basic/virus_on_network/model.py → .../examples/basic/virus_on_network/model.py
diff --git a/pyproject.toml b/pyproject.toml
@@ -87,7 +87,7 @@ repository = "https://github.com/projectmesa/mesa"
 mesa = "mesa.main:cli"
 
 [tool.hatch.build.targets.wheel]
-packages = ["mesa", "examples"]
+packages = ["mesa"]
 
 [tool.hatch.version]
 path = "mesa/__init__.py"
@@ -97,7 +97,7 @@ path = "mesa/__init__.py"
 # Hardcode to Python 3.10.
 # Reminder to update mesa-examples if the value below is changed.
 target-version = "py310"
-extend-exclude = ["docs", "build", "examples/advanced"]  # TODO: Remove examples/advanced
+extend-exclude = ["docs", "build", "mesa/examples/advanced"]  # TODO: Remove examples/advanced
 
 [tool.ruff.lint]
 select = [
@@ -149,7 +149,7 @@ extend-ignore = [
   "S311",   # Standard pseudo-random generators are not suitable for cryptographic purposes
 ]
 # Ignore all docstring errors in examples
-per-file-ignores = {"examples/*"= ["D"]}
+per-file-ignores = {"mesa/examples/*"= ["D"]}
 
 [tool.ruff.lint.pydocstyle]
 convention = "google"
diff --git a/tests/test_examples.py b/tests/test_examples.py
@@ -8,7 +8,7 @@
 
 def test_examples_imports():
     """Test examples imports."""
-    from mesa.examples.basic import (
+    from mesa.examples import (
         BoidFlockers,
         BoltzmannWealthModel,
         ConwaysGameOfLife,
@@ -38,7 +38,9 @@ class TestExamples(unittest.TestCase):
     details of each example's model.
     """
 
-    EXAMPLES = os.path.abspath(os.path.join(os.path.dirname(__file__), "../examples"))
+    EXAMPLES = os.path.abspath(
+        os.path.join(os.path.dirname(__file__), "../mesa/examples")
+    )
 
     @contextlib.contextmanager
     def active_example_dir(self, example):