Google Digital Buildings 项目教程

Google Digital Buildings 项目教程

digitalbuildings Digital Buildings (ontology and SDK) currently being used by Google internally to manage our own buildings. 项目地址: https://gitcode.com/gh_mirrors/di/digitalbuildings

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

Google Digital Buildings 项目的目录结构如下：

digitalbuildings/
├── ontology/
│   ├── styles/
│   └── tools/
├── tools/
│   ├── dockerignore
│   ├── gitignore
│   ├── CONTRIBUTING.md
│   ├── Dockerfile
│   ├── LICENSE
│   ├── README.md
│   └── _config.yml
├── README.md
└── ...

目录结构介绍

• ontology/: 该目录包含了数字建筑的语义数据模型的定义（“术语框”）以及用于构建、验证和关联实际设备的工具。

  • styles/: 包含样式文件。
  • tools/: 包含工具文件。

• tools/: 该目录包含了各种工具，如ABEL（用于简化建筑配置构造）、Explorer（允许用户探索本体类型字段并比较本体类型）、Instance Validator（验证具体应用）等。

  • dockerignore: Docker 忽略文件。
  • gitignore: Git 忽略文件。
  • CONTRIBUTING.md: 贡献指南。
  • Dockerfile: Docker 配置文件。
  • LICENSE: 许可证文件。
  • README.md: 项目介绍文件。
  • _config.yml: 配置文件。

• README.md: 项目的主介绍文件。

2. 项目的启动文件介绍

在 Google Digital Buildings 项目中，没有明确的“启动文件”，因为该项目主要是一个本体和工具集，而不是一个传统的应用程序。然而，如果你想要启动某些工具或验证器，你可以参考以下步骤：

1. 安装依赖: 首先，确保你已经安装了所有必要的依赖项。通常，这些依赖项会在 README.md 文件中列出。

2. 运行工具: 你可以通过命令行运行特定的工具。例如，如果你想运行 Instance Validator，你可以使用以下命令：

   python tools/instance_validator.py
   

3. 配置文件: 在运行工具之前，确保你已经正确配置了相关的配置文件（如 _config.yml）。

3. 项目的配置文件介绍

在 Google Digital Buildings 项目中，主要的配置文件是 _config.yml。这个文件通常用于配置项目的各种设置，如工具的路径、验证器的参数等。

_config.yml 配置文件示例

# 项目配置文件
project:
  name: "Digital Buildings"
  version: "1.0.0"

tools:
  instance_validator:
    enabled: true
    log_level: "info"

ontology:
  path: "ontology/"
  format: "yaml"

配置文件介绍

• project: 项目的基本信息，如名称和版本。
• tools: 工具的配置，如 instance_validator 的启用状态和日志级别。
• ontology: 本体文件的路径和格式。

通过配置文件，你可以自定义项目的运行环境和工具的行为。

---

以上是 Google Digital Buildings 项目的教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容对你有所帮助！

digitalbuildings Digital Buildings (ontology and SDK) currently being used by Google internally to manage our own buildings. 项目地址: https://gitcode.com/gh_mirrors/di/digitalbuildings