maum-ai/CostNav

# CostNav Assets This directory contains Omniverse USD assets used by CostNav. ## For Open Source Users (Recommended) ### 1. Download Assets from Hugging Face ```bash make download-assets-hf ``` This downloads all required assets to `assets/Users/`. ### 2. Initialize and Start Local Nucleus Server **Prerequisites:** - Docker and Docker Compose installed - `.env` file with NGC credentials **Step 1:** Set up NGC credentials in `.env`: ```bash cp .env.example .env # Edit .env and set NGC_PASS to your NGC API key # Get your API key at: https://org.ngc.nvidia.com/setup/api-keys ``` **Step 2:** Run the nucleus server: ```bash make start-nucleus ``` The script will configure Nucleus and copy assets. After starting, assets will be served at `omniverse://localhost`. ### 3. Set OMNI_URL in dotenv ```bash OMNI_USER=omniverse OMNI_PASS=costnav123 OMNI_URL=omniverse://localhost ``` ## For Internal Developers ### Download from Internal Omniverse Server ```bash make download-assets-omniverse ``` ### Upload to Hugging Face ```bash make upload-assets-hf ```# CostNav 资产集 该目录包含CostNav所使用的Omniverse USD资产文件。 ## 开源用户使用指南（推荐） ### 1. 从Hugging Face下载资产 bash make download-assets-hf 该命令会将所有所需资产下载至`assets/Users/`目录下。 ### 2. 初始化并启动本地Omniverse Nucleus服务器 **前置依赖：** - 已安装Docker与Docker Compose - 包含NGC凭证的`.env`配置文件 **步骤1：在`.env`中配置NGC凭证** bash cp .env.example .env # 编辑.env文件，将NGC_PASS设置为您的NGC API密钥 # 可通过以下地址获取API密钥：https://org.ngc.nvidia.com/setup/api-keys **步骤2：启动Nucleus服务器** bash make start-nucleus 该脚本将完成Nucleus的配置并完成资产拷贝。启动完成后，资产将通过`omniverse://localhost`地址提供服务。 ### 3. 在dotenv中配置OMNI_URL bash OMNI_USER=omniverse OMNI_PASS=costnav123 OMNI_URL=omniverse://localhost ## 内部开发者使用指南 ### 从内部Omniverse服务器下载资产 bash make download-assets-omniverse ### 上传至Hugging Face bash make upload-assets-hf