ActivitySim 开源项目使用教程

ActivitySim 开源项目使用教程

activitysim An Open Platform for Activity-Based Travel Modeling 项目地址: https://gitcode.com/gh_mirrors/ac/activitysim

1. 项目的目录结构及介绍

ActivitySim 项目的目录结构如下：

activitysim/
├── conda-environments/
├── docs/
├── other_resources/
├── test/
├── bumpversion.cfg
├── .gitignore
├── pre-commit-config.yaml
├── pylintrc
├── AAA-BreakingChanges.md
├── HOW_TO_RELEASE.md
├── LICENSE.txt
├── README.md
├── pyproject.toml
└── release_notes.txt

目录结构介绍

• conda-environments/: 包含用于创建 Conda 环境的配置文件。
• docs/: 包含项目的文档文件。
• other_resources/: 包含其他资源文件。
• test/: 包含项目的测试文件。
• bumpversion.cfg: 用于版本管理的配置文件。
• .gitignore: Git 忽略文件配置。
• pre-commit-config.yaml: 预提交钩子的配置文件。
• pylintrc: Pylint 代码检查工具的配置文件。
• AAA-BreakingChanges.md: 记录重大变更的文档。
• HOW_TO_RELEASE.md: 发布指南文档。
• LICENSE.txt: 项目许可证文件。
• README.md: 项目介绍和使用说明文档。
• pyproject.toml: Python 项目配置文件。
• release_notes.txt: 发布日志文件。

2. 项目的启动文件介绍

ActivitySim 项目的启动文件通常是 activitysim 模块中的主脚本。具体启动文件的位置和名称可能因版本和配置而异，但通常可以通过以下方式启动项目：

python -m activitysim

启动文件介绍

• activitysim: 这是项目的核心模块，包含了主要的逻辑和功能。
• main.py: 通常是项目的入口文件，负责初始化配置、加载数据和启动模型。

3. 项目的配置文件介绍

ActivitySim 项目的配置文件主要用于定义模型的参数、数据路径和其他运行时配置。常见的配置文件包括：

• config.yaml: 主配置文件，定义了模型的各种参数和选项。
• settings.py: Python 脚本，用于设置环境变量和全局配置。
• data_paths.yaml: 数据路径配置文件，定义了数据文件的位置。

配置文件介绍

• config.yaml:

  • model_parameters: 定义模型的参数，如迭代次数、收敛阈值等。
  • data_paths: 定义数据文件的路径，如输入数据、输出数据等。
  • logging: 定义日志记录的配置，如日志级别、输出路径等。

• settings.py:

  • ENV_VARS: 定义环境变量，如数据库连接字符串、API 密钥等。
  • GLOBAL_CONFIG: 定义全局配置，如默认语言、时区等。

• data_paths.yaml:

  • input_data: 定义输入数据文件的路径。
  • output_data: 定义输出数据文件的路径。

通过这些配置文件，用户可以灵活地调整项目的运行环境和参数，以适应不同的需求和场景。

activitysim An Open Platform for Activity-Based Travel Modeling 项目地址: https://gitcode.com/gh_mirrors/ac/activitysim