#!/bin/bash set -e # Parse arguments HELP=false NEW_ENV=false OMNIGIBSON=false BDDL=false JOYLO=false DATASET=false PRIMITIVES=false EVAL=false ASSET_PIPELINE=false DEV=false CUDA_VERSION="12.4" ACCEPT_CONDA_TOS=false ACCEPT_NVIDIA_EULA=false ACCEPT_DATASET_TOS=false CONFIRM_NO_CONDA=false [ "$#" -eq 0 ] && HELP=true while [[ $# -gt 0 ]]; do case $1 in -h|--help) HELP=true; shift ;; --new-env) NEW_ENV=true; shift ;; --omnigibson) OMNIGIBSON=true; shift ;; --bddl) BDDL=true; shift ;; --joylo) JOYLO=true; shift ;; --dataset) DATASET=true; shift ;; --primitives) PRIMITIVES=true; shift ;; --eval) EVAL=true; shift ;; --asset-pipeline) ASSET_PIPELINE=true; shift ;; --dev) DEV=true; shift ;; --cuda-version) CUDA_VERSION="\$2"; shift 2 ;; --accept-conda-tos) ACCEPT_CONDA_TOS=true; shift ;; --accept-nvidia-eula) ACCEPT_NVIDIA_EULA=true; shift ;; --accept-dataset-tos) ACCEPT_DATASET_TOS=true; shift ;; --confirm-no-conda) CONFIRM_NO_CONDA=true; shift ;; *) echo "Unknown option: \$1"; exit 1 ;; esac done if [ "$HELP" = true ]; then cat << EOF BEHAVIOR-1K Installation Script (Linux) Usage: ./setup.sh [OPTIONS] Options: -h, --help Display this help message --new-env Create a new conda environment 'behavior' --omnigibson Install OmniGibson (core physics simulator) --bddl Install BDDL (Behavior Domain Definition Language) --joylo Install JoyLo (teleoperation interface) --dataset Download BEHAVIOR datasets (requires --omnigibson) --primitives Install OmniGibson with primitives support --eval Install evaluation dependencies --asset-pipeline Install the 3D scene and object asset pipeline --dev Install development dependencies --cuda-version VERSION Specify CUDA version (default: 12.4) --accept-conda-tos Automatically accept Conda Terms of Service --accept-nvidia-eula Automatically accept NVIDIA Isaac Sim EULA --accept-dataset-tos Automatically accept BEHAVIOR Dataset Terms --confirm-no-conda Skip confirmation prompt when not in a conda environment Example: ./setup.sh --new-env --omnigibson --bddl --joylo --dataset Example (non-interactive): ./setup.sh --new-env --omnigibson --dataset --accept-conda-tos --accept-nvidia-eula --accept-dataset-tos EOF exit 0 fi # Validate dependencies [ "$OMNIGIBSON" = true ] && [ "$BDDL" = false ] && { echo "ERROR: --omnigibson requires --bddl"; exit 1; } [ "$PRIMITIVES" = true ] && [ "$OMNIGIBSON" = false ] && { echo "ERROR: --primitives requires --omnigibson"; exit 1; } [ "$EVAL" = true ] && [ "$OMNIGIBSON" = false ] && { echo "ERROR: --eval requires --omnigibson"; exit 1; } [ "$EVAL" = true ] && [ "$JOYLO" = false ] && { echo "ERROR: --eval requires --joylo"; exit 1; } [ "$NEW_ENV" = true ] && [ "$CONFIRM_NO_CONDA" = true ] && { echo "ERROR: --new-env and --confirm-no-conda are mutually exclusive"; exit 1; } WORKDIR=$(pwd) # Check conda environment condition early (unless creating new environment) if [ "$NEW_ENV" = false ]; then if [ -z "$CONDA_PREFIX" ]; then if [ "$CONFIRM_NO_CONDA" = false ]; then echo "" echo "WARNING: You are not in a conda environment." echo "Currently using Python from: $(which python)" echo "" echo "Continue? [y/n] (or rerun with --confirm-no-conda to skip this prompt)" read -r response if [[ ! "$response" =~ ^[Yy]$ ]]; then echo "Installation cancelled." exit 1 fi fi echo "Proceeding without conda environment..." fi fi # Function to prompt for terms acceptance prompt_for_terms() { echo "" echo "=== TERMS OF SERVICE AND LICENSING AGREEMENTS ===" echo "" # Check what terms need to be accepted NEEDS_CONDA_TOS=false NEEDS_NVIDIA_EULA=false NEEDS_DATASET_TOS=false if [ "$NEW_ENV" = true ] && [ "$ACCEPT_CONDA_TOS" = false ]; then NEEDS_CONDA_TOS=true fi if [ "$OMNIGIBSON" = true ] && [ "$ACCEPT_NVIDIA_EULA" = false ]; then NEEDS_NVIDIA_EULA=true fi if [ "$DATASET" = true ] && [ "$ACCEPT_DATASET_TOS" = false ]; then NEEDS_DATASET_TOS=true fi # If nothing needs acceptance, return early if [ "$NEEDS_CONDA_TOS" = false ] && [ "$NEEDS_NVIDIA_EULA" = false ] && [ "$NEEDS_DATASET_TOS" = false ]; then return 0 fi echo "This installation requires acceptance of the following terms:" echo "" if [ "$NEEDS_CONDA_TOS" = true ]; then cat << EOF 1. CONDA TERMS OF SERVICE - Required for creating conda environment - By accepting, you agree to Anaconda's Terms of Service - See: https://legal.anaconda.com/policies/en/ EOF fi if [ "$NEEDS_NVIDIA_EULA" = true ]; then cat << EOF 2. NVIDIA ISAAC SIM EULA - Required for OmniGibson installation - By accepting, you agree to NVIDIA Isaac Sim End User License Agreement - See: https://www.nvidia.com/en-us/agreements/enterprise-software/nvidia-software-license-agreement EOF fi if [ "$NEEDS_DATASET_TOS" = true ]; then cat << EOF 3. BEHAVIOR DATA BUNDLE END USER LICENSE AGREEMENT Last revision: December 8, 2022 This License Agreement is for the BEHAVIOR Data Bundle (“Data”). It works with OmniGibson (“Software”) which is a software stack licensed under the MIT License, provided in this repository: https://github.com/StanfordVL/BEHAVIOR-1K. The license agreements for OmniGibson and the Data are independent. This BEHAVIOR Data Bundle contains artwork and images (“Third Party Content”) from third parties with restrictions on redistribution. It requires measures to protect the Third Party Content which we have taken such as encryption and the inclusion of restrictions on any reverse engineering and use. Recipient is granted the right to use the Data under the following terms and conditions of this License Agreement (“Agreement”): 1. Use of the Data is permitted after responding "Yes" to this agreement. A decryption key will be installed automatically. 2. Data may only be used for non-commercial academic research. You may not use a Data for any other purpose. 3. The Data has been encrypted. You are strictly prohibited from extracting any Data from OmniGibson or reverse engineering. 4. You may only use the Data within OmniGibson. 5. You may not redistribute the key or any other Data or elements in whole or part. 6. THE DATA AND SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE DATA OR SOFTWARE OR THE USE OR OTHER DEALINGS IN THE DATA OR SOFTWARE. EOF fi echo "Do you accept ALL of the above terms? (y/N)" read -r response if [[ ! "$response" =~ ^[Yy]$ ]]; then echo "Terms not accepted. Installation cancelled." echo "You can bypass these prompts by using --accept-conda-tos, --accept-nvidia-eula, and --accept-dataset-tos flags." exit 1 fi # Set acceptance flags [ "$NEEDS_CONDA_TOS" = true ] && ACCEPT_CONDA_TOS=true [ "$NEEDS_NVIDIA_EULA" = true ] && ACCEPT_NVIDIA_EULA=true [ "$NEEDS_DATASET_TOS" = true ] && ACCEPT_DATASET_TOS=true echo "" echo "✓ All terms accepted. Proceeding with installation..." echo "" } # Prompt for terms acceptance at the beginning prompt_for_terms # Create conda environment if [ "$NEW_ENV" = true ]; then echo "Creating conda environment 'behavior'..." command -v conda >/dev/null || { echo "ERROR: Conda not found"; exit 1; } # Set auto-accept environment variable if user agreed to TOS if [ "$ACCEPT_CONDA_TOS" = true ]; then export CONDA_PLUGINS_AUTO_ACCEPT_TOS=yes echo "✓ Conda TOS auto-acceptance enabled" fi source "$(conda info --base)/etc/profile.d/conda.sh" # Check if environment already exists and exit with instructions if conda env list | grep -q "^behavior "; then echo "" echo "ERROR: Conda environment 'behavior' already exists!" echo "" echo "Please remove or rename the existing environment and re-run this script." echo "" exit 1 fi # Create environment with only Python 3.10 conda create -n behavior python=3.10 -c conda-forge -y conda activate behavior [[ "$CONDA_DEFAULT_ENV" != "behavior" ]] && { echo "ERROR: Failed to activate environment"; exit 1; } # Install numpy and setuptools via pip echo "Installing numpy and setuptools..." pip install "numpy<2" "setuptools<=79" # Install PyTorch via pip with CUDA support echo "Installing PyTorch with CUDA $CUDA_VERSION support..." # Determine the CUDA version string for pip URL (e.g., cu126, cu124, etc.) CUDA_VER_SHORT=$(echo $CUDA_VERSION | sed 's/\.//g') # e.g. convert 12.6 to 126 pip install torch==2.6.0 torchvision==0.21.0 torchaudio==2.6.0 --index-url https://download.pytorch.org/whl/cu${CUDA_VER_SHORT} echo "✓ PyTorch installation completed" fi # Install BDDL if [ "$BDDL" = true ]; then echo "Installing BDDL..." [ ! -d "bddl" ] && { echo "ERROR: bddl directory not found"; exit 1; } pip install -e "$WORKDIR/bddl" fi # Install OmniGibson with Isaac Sim if [ "$OMNIGIBSON" = true ]; then echo "Installing OmniGibson..." [ ! -d "OmniGibson" ] && { echo "ERROR: OmniGibson directory not found"; exit 1; } # Check Python version PYTHON_VERSION=$(python -c "import sys; print(f'{sys.version_info.major}.{sys.version_info.minor}')") [ "$PYTHON_VERSION" != "3.10" ] && { echo "ERROR: Python 3.10 required, found $PYTHON_VERSION"; exit 1; } # Check for conflicting environment variables if [[ -n "$EXP_PATH" || -n "$CARB_APP_PATH" || -n "$ISAAC_PATH" ]]; then echo "ERROR: Found existing Isaac Sim environment variables." echo "Please unset EXP_PATH, CARB_APP_PATH, and ISAAC_PATH and restart." exit 1 fi # Build extras EXTRAS="" if [ "$DEV" = true ]; then EXTRAS="${EXTRAS}dev," fi if [ "$PRIMITIVES" = true ]; then EXTRAS="${EXTRAS}primitives," fi if [ "$EVAL" = true ]; then EXTRAS="${EXTRAS}eval," fi # Remove trailing comma, if any, and add brackets only if EXTRAS is not empty if [ -n "$EXTRAS" ]; then EXTRAS="[${EXTRAS%,}]" fi pip install -e "$WORKDIR/OmniGibson$EXTRAS" # Install pre-commit for dev setup if [ "$DEV" = true ]; then echo "Setting up pre-commit..." conda install -c conda-forge pre-commit -y cd "$WORKDIR/OmniGibson" pre-commit install cd "$WORKDIR" fi # Isaac Sim installation via pip if [ "$ACCEPT_NVIDIA_EULA" = true ]; then export OMNI_KIT_ACCEPT_EULA=YES else echo "ERROR: NVIDIA EULA not accepted. Cannot install Isaac Sim." exit 1 fi # Check if already installed if python -c "import isaacsim" 2>/dev/null; then echo "Isaac Sim already installed, skipping..." else echo "Installing Isaac Sim via pip..." # Helper functions check_glibc_old() { ldd --version 2>&1 | grep -qE "2\.(31|32|33)" } install_isaac_packages() { local temp_dir=$(mktemp -d) local packages=( "omniverse_kit-106.5.0.162521" "isaacsim_kernel-4.5.0.0" "isaacsim_app-4.5.0.0" "isaacsim_core-4.5.0.0" "isaacsim_gui-4.5.0.0" "isaacsim_utils-4.5.0.0" "isaacsim_storage-4.5.0.0" "isaacsim_asset-4.5.0.0" "isaacsim_sensor-4.5.0.0" "isaacsim_robot_motion-4.5.0.0" "isaacsim_robot-4.5.0.0" "isaacsim_benchmark-4.5.0.0" "isaacsim_code_editor-4.5.0.0" "isaacsim_ros1-4.5.0.0" "isaacsim_cortex-4.5.0.0" "isaacsim_example-4.5.0.0" "isaacsim_replicator-4.5.0.0" "isaacsim_rl-4.5.0.0" "isaacsim_robot_setup-4.5.0.0" "isaacsim_ros2-4.5.0.0" "isaacsim_template-4.5.0.0" "isaacsim_test-4.5.0.0" "isaacsim-4.5.0.0" "isaacsim_extscache_physics-4.5.0.0" "isaacsim_extscache_kit-4.5.0.0" "isaacsim_extscache_kit_sdk-4.5.0.0" ) local wheel_files=() for pkg in "${packages[@]}"; do local pkg_name=${pkg%-*} local filename="${pkg}-cp310-none-manylinux_2_34_x86_64.whl" local url="https://pypi.nvidia.com/${pkg_name//_/-}/$filename" local filepath="$temp_dir/$filename" echo "Downloading $pkg..." if ! curl -sL "$url" -o "$filepath"; then echo "ERROR: Failed to download $pkg" rm -rf "$temp_dir" return 1 fi # Rename for older GLIBC if check_glibc_old; then local new_filepath="${filepath/manylinux_2_34/manylinux_2_31}" mv "$filepath" "$new_filepath" filepath="$new_filepath" fi wheel_files+=("$filepath") done echo "Installing Isaac Sim packages..." pip install "${wheel_files[@]}" rm -rf "$temp_dir" # Verify installation if ! python -c "import isaacsim" 2>/dev/null; then echo "ERROR: Isaac Sim installation verification failed" return 1 fi } install_isaac_packages || { echo "ERROR: Isaac Sim installation failed"; exit 1; } # Fix cryptography conflict - remove conflicting version if [ -n "$ISAAC_PATH" ] && [ -d "$ISAAC_PATH/exts/omni.pip.cloud/pip_prebundle/cryptography" ]; then echo "Fixing cryptography conflict..." rm -rf "$ISAAC_PATH/exts/omni.pip.cloud/pip_prebundle/cryptography" fi fi echo "OmniGibson installation completed successfully!" fi # Install JoyLo if [ "$JOYLO" = true ]; then echo "Installing JoyLo..." [ ! -d "joylo" ] && { echo "ERROR: joylo directory not found"; exit 1; } pip install -e "$WORKDIR/joylo" fi # Install Eval if [ "$EVAL" = true ]; then # get torch version via pip and install corresponding torch-cluster TORCH_VERSION=$(pip show torch | grep Version | cut -d " " -f 2) pip install torch-cluster -f https://data.pyg.org/whl/torch-${TORCH_VERSION}.html # install av and ffmpeg conda install av "numpy<2" -c conda-forge -y fi # Install asset pipeline if [ "$ASSET_PIPELINE" = true ]; then echo "Installing asset pipeline..." [ ! -d "asset_pipeline" ] && { echo "ERROR: asset_pipeline directory not found"; exit 1; } pip install -r "$WORKDIR/asset_pipeline/requirements.txt" fi # Install datasets if [ "$DATASET" = true ]; then python -c "import omnigibson" || { echo "ERROR: OmniGibson import failed, please make sure you have omnigibson installed before downloading datasets" exit 1 } echo "Installing datasets..." # Determine if we should accept dataset license automatically DATASET_ACCEPT_FLAG="" if [ "$ACCEPT_DATASET_TOS" = true ]; then DATASET_ACCEPT_FLAG="True" else DATASET_ACCEPT_FLAG="False" fi export OMNI_KIT_ACCEPT_EULA=YES echo "Downloading OmniGibson robot assets..." python -c "from omnigibson.utils.asset_utils import download_omnigibson_robot_assets; download_omnigibson_robot_assets()" || { echo "ERROR: OmniGibson robot assets installation failed" exit 1 } echo "Downloading BEHAVIOR-1K assets..." python -c "from omnigibson.utils.asset_utils import download_behavior_1k_assets; download_behavior_1k_assets(accept_license=${DATASET_ACCEPT_FLAG})" || { echo "ERROR: Dataset installation failed" exit 1 } echo "Downloading 2025 BEHAVIOR Challenge Task Instances..." python -c "from omnigibson.utils.asset_utils import download_2025_challenge_task_instances; download_2025_challenge_task_instances()" || { echo "ERROR: 2025 BEHAVIOR Challenge Task Instances installation failed" exit 1 } fi echo "" echo "=== Installation Complete! ===" if [ "$NEW_ENV" = true ]; then echo "✓ Created conda environment 'behavior'"; fi if [ "$OMNIGIBSON" = true ]; then echo "✓ Installed OmniGibson + Isaac Sim"; fi if [ "$BDDL" = true ]; then echo "✓ Installed BDDL"; fi if [ "$JOYLO" = true ]; then echo "✓ Installed JoyLo"; fi if [ "$PRIMITIVES" = true ]; then echo "✓ Installed OmniGibson with primitives support"; fi if [ "$EVAL" = true ]; then echo "✓ Installed evaluation support"; fi if [ "$DATASET" = true ]; then echo "✓ Downloaded datasets"; fi echo "" if [ "$NEW_ENV" = true ]; then echo "To activate: conda activate behavior"; fi