ResStock 开源项目使用教程

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

ResStock 是一个用于模拟现有住宅建筑库存的高细粒度模型的项目，基于 OpenStudio 平台，使用 EnergyPlus 仿真引擎。以下是项目的目录结构及简要介绍：

resstock/
├── .github/                     # GitHub 工作流程和配置文件
├── docs/                        # 项目文档
├── measures/                    # 住房特征选项库
├── project_national/            # 表示美国住宅建筑库存的全国性项目
├── project_testing/             # 测试项目
├── resources/                   # 资源文件
├── test/                        # 测试文件
├── workflow/                    # 工作流文件
├── .gitattributes               # Git 属性文件
├── .gitignore                   # Git 忽略文件
├── .readthedocs.yml             # Read the Docs 配置文件
├── .rubocop.yml                 # RuboCop 配置文件
├── .ruby-version                # Ruby 版本文件
├── Gemfile                      # Ruby 依赖文件
├── Gemfile.lock                 # Ruby 依赖锁定文件
├── LICENSE.md                   # 项目许可证
├── README.md                    # 项目说明文件
├── Rakefile                     # Rake 任务文件
├── codecov.yml                  # CodeCov 配置文件
├── tasks.rb                     # 任务脚本文件

2. 项目的启动文件介绍

ResStock 项目的启动通常依赖于 Rakefile 文件，该文件定义了项目中的各种任务。以下是 Rakefile 的基本介绍：

• Rakefile：用于定义项目中的 Rake 任务，例如运行测试、构建文档等。

在命令行中，可以通过以下命令运行 Rake 任务：

rake task_name

例如，运行测试任务：

rake test

3. 项目的配置文件介绍

ResStock 项目中的配置文件主要用于定义项目参数和运行选项。以下是一些重要的配置文件：

• .gitignore：指定 Git 应该忽略的文件和目录，以避免将不必要的文件提交到版本库中。
• Gemfile 和 Gemfile.lock：定义 Ruby 项目的依赖关系，Gemfile.lock 文件用于确保依赖的版本一致。
• config.yml：项目配置文件，定义了项目的各种参数和设置。

在运行项目之前，可能需要编辑配置文件以适应特定的环境和需求。

以上是 ResStock 项目的目录结构、启动文件和配置文件的简要介绍，希望对您有所帮助。