Neural Graph Mapping 项目使用教程

Neural Graph Mapping 项目使用教程

neural_graph_mapping Neural Graph Mapping for Dense SLAM with Efficient Loop Closure 项目地址: https://gitcode.com/gh_mirrors/ne/neural_graph_mapping

1. 项目目录结构及介绍

neural_graph_mapping/
├── src/
│   └── neural_graph_mapping/
├── .gitignore
├── pixi.sh
├── LICENSE
├── README.md
├── pixi.lock
├── pixi.toml
├── pyproject.toml
├── requirements-dev.txt

目录结构说明

• src/: 项目的主要代码文件夹，包含 neural_graph_mapping 模块。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 追踪。
• pixi.sh: 启动脚本，用于快速运行项目。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的基本介绍和使用说明。
• pixi.lock: 依赖锁定文件，确保项目依赖的版本一致性。
• pixi.toml: 项目配置文件，定义了项目的依赖和运行环境。
• pyproject.toml: Python 项目配置文件，定义了项目的构建系统和依赖。
• requirements-dev.txt: 开发环境所需的依赖列表。

2. 项目启动文件介绍

pixi.sh

pixi.sh 是一个启动脚本，用于快速运行项目。以下是脚本的基本使用方法：

# 安装项目依赖并运行示例场景
pixi run nrgbd_br --rerun_vis True

# 运行所有场景和数据集
pixi run all

可选参数

可以通过设置 NGM_EXTRA_ARGS 环境变量来添加额外的参数：

# 启用可视化和保存功能
NGM_EXTRA_ARGS="--rerun_vis True --rerun_save True" pixi run all

3. 项目配置文件介绍

pixi.toml

pixi.toml 是项目的配置文件，定义了项目的依赖和运行环境。以下是配置文件的基本结构：

[package]
name = "neural_graph_mapping"
version = "0.1.0"
description = "Neural Graph Mapping for Dense SLAM with Efficient Loop Closure"
authors = ["Leonard Bruns", "Jun Zhang", "Patric Jensfelt"]
license = "MIT"

[dependencies]
torch = "2.2.*"
# 其他依赖项

[scripts]
nrgbd_br = "python -m neural_graph_mapping.nrgbd_br"
all = "python -m neural_graph_mapping.all"

pyproject.toml

pyproject.toml 是 Python 项目的配置文件，定义了项目的构建系统和依赖。以下是配置文件的基本结构：

[build-system]
requires = ["setuptools>=42", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "neural_graph_mapping"
version = "0.1.0"
description = "Neural Graph Mapping for Dense SLAM with Efficient Loop Closure"
authors = [
    { name="Leonard Bruns", email="leonard.bruns@example.com" },
    { name="Jun Zhang", email="jun.zhang@example.com" },
    { name="Patric Jensfelt", email="patric.jensfelt@example.com" }
]
license = { text = "MIT" }
dependencies = [
    "torch==2.2.*",
    # 其他依赖项
]

[tool.setuptools]
packages = ["neural_graph_mapping"]

requirements-dev.txt

requirements-dev.txt 是开发环境所需的依赖列表，通常包含测试、文档生成等工具的依赖项。

pytest
sphinx
# 其他开发依赖项

通过以上配置文件和启动脚本，您可以快速配置和运行 neural_graph_mapping 项目。

neural_graph_mapping Neural Graph Mapping for Dense SLAM with Efficient Loop Closure 项目地址: https://gitcode.com/gh_mirrors/ne/neural_graph_mapping