> ## Documentation Index
> Fetch the complete documentation index at: https://docs.generalrobotics.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Install GRID Enterprise on your system

This guide walks you through installing GRID Enterprise on your own hardware.

***

## Requirements

<CardGroup cols={2}>
  <Card title="Operating System" icon="linux">
    Ubuntu 22.04 or 24.04 (officially supported)
  </Card>

  <Card title="GPU" icon="microchip">
    NVIDIA GPU with 8GB+ VRAM (16GB+ recommended), drivers 535+
  </Card>

  <Card title="Docker" icon="docker">
    Docker Engine with NVIDIA Container Toolkit
  </Card>

  <Card title="Python" icon="python">
    Python 3.11 or higher
  </Card>
</CardGroup>

### Detailed Requirements

* **Operating System**: Ubuntu 22.04 / 24.04. Other distributions may work but are not officially supported.

* **NVIDIA GPU + Drivers**: Required for simulation and AI models. Minimum 8GB VRAM, ideally 16GB+. Install drivers version 535 or later.

* **Docker**: [Install Docker Engine](https://docs.docker.com/engine/install/ubuntu/) to run GRID containers.

* **NVIDIA Container Runtime**: Required for GPU-accelerated containers. Follow the [NVIDIA Container Toolkit Installation Guide](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html#installing-with-apt).

* **Python 3.11+**: We recommend using [Miniconda](https://docs.anaconda.com/miniconda/#quick-command-line-install) or a virtual environment manager.

***

## Installation

<Steps>
  <Step title="Create Python Environment">
    ```bash theme={null}
    conda create -n grid python=3.11
    conda activate grid
    ```
  </Step>

  <Step title="Install GRID Enterprise">
    ```bash theme={null}
    pip install grid-enterprise
    ```
  </Step>

  <Step title="Configure GRID_DATA_DIR">
    Set the directory where GRID stores assets, credentials, and logs:

    ```bash theme={null}
    export GRID_DATA_DIR=$HOME/.grid
    mkdir -p "$GRID_DATA_DIR"
    ```

    Add the `export` line to your `~/.bashrc` to persist across sessions.
  </Step>

  <Step title="Add License File">
    Place the license file from your onboarding package:

    ```bash theme={null}
    cp /path/to/license.json "$GRID_DATA_DIR/license.json"
    ```

    <Note>The CLI reads registry credentials and other secrets from this file.</Note>
  </Step>

  <Step title="Configure Resources (Optional)">
    The CLI creates a default `resource_config.json` on first run. If you received a custom configuration:

    ```bash theme={null}
    cp /path/to/resource_config.json ~/.grid/resource_config.json
    ```

    Default configuration:

    ```json theme={null}
    {
      "serve": true,
      "servers": [
        {
          "id": "local",
          "ip": "127.0.0.1"
        }
      ]
    }
    ```

    Set `"serve": true` for host mode (runs containers locally) or `"serve": false` for client mode (orchestrates remote nodes only).
  </Step>
</Steps>

***

## Verify Installation

Launch the GRID CLI:

```bash theme={null}
grid
```

<Accordion title="Show Expected Output">
  ```text theme={null}
   .d8888b.  8888888b.  8888888 8888888b.
  d88P  Y88b 888   Y88b   888   888  "Y88b
  888    888 888    888   888   888    888
  888        888   d88P   888   888    888
  888  88888 8888888P"    888   888    888
  888    888 888 T88b     888   888    888
  Y88b  d88P 888  T88b    888   888  .d88P
   "Y8888P88 888   T88b 8888888 8888888P"

  General Robot Intelligence Development Platform - Enterprise version
  General Robotics Technology, Inc.

  Type help for list of commands.

  GRID #
  ```
</Accordion>

***

## Next Steps

<CardGroup cols={2}>
  <Card title="Hello GRID Tutorial" icon="rocket" href="../hello-grid">
    Step-by-step guide to your first simulation session.
  </Card>

  <Card title="CLI Reference" icon="terminal" href="./cli">
    Complete command reference for the GRID CLI.
  </Card>

  <Card title="Remote Nodes" icon="server" href="./remote-nodes">
    Configure multi-machine deployments.
  </Card>

  <Card title="VS Code Integration" icon="code" href="./vscode-containers">
    Develop inside GRID containers with VS Code.
  </Card>
</CardGroup>