小学隔离计算建模（COMPASS）

此Python实现尝试根据Schelling（1971年）和Stoica & Flache（2014年）的工作来模拟学校选择和由此产生的学校隔离。

用法

安装和运行

首先需要在您的计算机上安装GDAL。

要安装软件包，请运行pip install compass-school。

要运行基于Web GUI的演示，请从项目的根目录运行python run.py。这将在本地启动服务器，自动打开您的网络浏览器并显示程序作为网页。如果网页没有打开，请手动在链接栏中输入http://localhost:5004/。

更新文档

如果您尚未安装，请安装pdoc3。在终端中浏览到compassproject文件夹，并运行pdoc3 --html --force --output-dir docs compass。现在应该已更新文档。

概述

存储库包含以下内容

• run.py：一个交互式运行模型并带有可视化（浏览器）的脚本
• testrun.py：一个测试脚本（工作正在进行中）
• household.py：家庭类
• student.py：学生类
• neighbourhood.py：邻里类
• school.py：学校类
• allocator.py：将学生分配到他们选择的学校
• agents_base.py：用于继承的通用代理
• model.py：初始化整个系统及其所有组件
• parameters.py：包含模拟的所有参数值
• scheduler.py: 负责所有代理的激活、顺序和放置
• visualisation.py: 基于浏览器的可视化
• utils.py: 包含所有测量
• functions.py: 包含一些用于类的一些数学函数

模拟

在此处运行代码的信息。

测试和开发

使用所需的依赖项设置一个虚拟环境。

$ python -m venv env
$ . env/bin/activate
$ pip install -r requirements.txt

本地安装包（在开发或编辑模式下）

$ pip install -e .

然后运行测试

$ pytest

性能分析

一些性能分析结果可以在本 笔记本 中找到。还可以在此 笔记本 中找到一些缩放图。