虚拟家庭模拟器（VirtualHome）使用教程

虚拟家庭模拟器（VirtualHome）使用教程

virtualhome API to run VirtualHome, a Multi-Agent Household Simulator 项目地址: https://gitcode.com/gh_mirrors/vi/virtualhome

1. 项目目录结构及介绍

虚拟家庭模拟器（VirtualHome）的目录结构如下：

virtualhome/
├── assets/             # 存储项目资源文件，如图像、声音等
├── demo/               # 包含演示脚本和Jupyter笔记本
├── docker/             # 存储Docker相关配置文件
├── helper_scripts/     # 辅助脚本，用于启动X服务器等
├── simulation/         # 模拟器相关代码，包括Unity模拟器和图演变模拟器
│   ├── evolving_graph/ # 图演变模拟器代码
│   └── unity_simulator/ # Unity模拟器代码
├── setup.py            # Python包设置文件
├── pyproject.toml      # Python项目配置文件
├── README.md           # 项目说明文件
├── LICENSE             # 项目许可证文件
└── .gitignore          # Git忽略文件

• assets/：存放项目所需的各种资源文件，如3D模型、纹理、声音等。
• demo/：包含用于演示项目功能的脚本和一个Jupyter笔记本。
• docker/：包含用于在Docker容器中运行Unity模拟器的配置文件。
• helper_scripts/：包含一些辅助脚本，例如用于在Linux系统上启动X服务器的脚本。
• simulation/：包含模拟器代码，分为evolving_graph/和unity_simulator/两个子目录。
• setup.py：用于安装Python包的脚本。
• pyproject.toml：包含项目元数据和依赖关系的配置文件。
• README.md：项目的自述文件，包含项目描述、安装和使用的说明。
• LICENSE：项目的许可证文件，本项目采用MIT许可证。
• .gitignore：指定Git应该忽略的文件和目录。

2. 项目的启动文件介绍

项目的启动主要依赖于simulation/目录下的模拟器代码。以下是两个主要启动文件的介绍：

• simulation/unity_simulator/UnitySimulator.py：这是Unity模拟器的主入口文件，负责启动Unity模拟器并处理与Python API的通信。
• simulation/evolving_graph/evolving_graph.py：这是图演变模拟器的主入口文件，用于在Python环境中生成和执行图演变模拟。

要启动Unity模拟器，可以双击可执行文件，或者在终端中运行以下命令（假设已下载并放置在正确的目录下）：

./path_to_exec -screen-fullscreen 0 -screen-quality 4

要启动图演变模拟器，可以在终端中运行以下命令：

python simulation/evolving_graph/evolving_graph.py

3. 项目的配置文件介绍

项目的配置文件主要有以下两个：

• pyproject.toml：Python项目配置文件，定义了项目的元数据和依赖关系。例如，以下是pyproject.toml文件的一个片段：

[tool.setuptools]
packages = find:
install_requires = [
    "numpy",
    "opencv-python",
    # 其他依赖
]

• setup.py：Python包设置文件，用于定义项目的包结构、依赖关系和其他设置。以下是setup.py文件的一个片段：

from setuptools import setup, find_packages

setup(
    name="virtualhome",
    version="0.1",
    packages=find_packages(),
    install_requires=[
        "numpy",
        "opencv-python",
        # 其他依赖
    ],
    # 其他设置
)

这些配置文件在安装项目依赖和打包项目时非常重要。使用pip安装项目时，会自动读取setup.py或pyproject.toml中的依赖信息，并安装所需的Python包。

virtualhome API to run VirtualHome, a Multi-Agent Household Simulator 项目地址: https://gitcode.com/gh_mirrors/vi/virtualhome