Setup Instructions

1. Clone the repository

git clone --recurse-submodules https://github.com/OpenEnvision/WorldAtlas.git WorldAtlas
cd WorldAtlas

If you already cloned without submodules:

git submodule update --init --recursive

See thirdparty/README.md for the full submodule ↔ model config map.

2. Configure environment paths

Create a .env file in the repository root before running evaluation or model adapters. The variables below are the ones WorldAtlas actually reads:

# Required only when ckpt/ lives outside the checkout
WORLDATLAS_CHECKPOINT_ROOT=/path/to/ckpt

# Recommended for the tested CUDA 12.1 stack
CUDA_HOME=/path/to/cuda-12.1

WORLDATLAS_CHECKPOINT_ROOT is the single checkpoint root. When unset, all checkpoint-like paths resolve under WorldAtlas/ckpt. When set, the same directory layout must be preserved (huggingface/, torch/, official_metrics/, model-specific folders, and so on).

Recommended cache exports (also set automatically when using worldatlas CLI helpers):

export HF_HOME="${WORLDATLAS_CHECKPOINT_ROOT:-ckpt}/huggingface"
export HUGGINGFACE_HUB_CACHE="${HF_HOME}/hub"
export TRANSFORMERS_CACHE="${HF_HOME}/hub"
export TORCH_HOME="${WORLDATLAS_CHECKPOINT_ROOT:-ckpt}/torch"

3. Export the environment variables

After creating .env, export the variables in every shell that will run WorldAtlas:

Repeat in every new terminal

This step must be repeated in every new terminal session.

set -a
source .env
set +a
export $(grep -v '^#' .env | xargs)

4. API access (optional)

If you evaluate API-backed models from config/models/, put provider keys in a local .secrets file or export them in your shell. WorldAtlas does not commit API credentials.