install-python-api

Installs the CARLA Python client package into a chosen interpreter from bundled wheels, PyPI, or eggs.

3|Updated Jul 20, 2026
One-click install
npx skills add https://github.com/carla-simulator/carla-agentic-tools --skill install-python-api-carla-simulator
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: install-python-api
Source: https://github.com/carla-simulator/carla-agentic-tools/tree/main/skills/setup/install-python-api
Command: npx skills add https://github.com/carla-simulator/carla-agentic-tools --skill install-python-api-carla-simulator

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve? Getting an importable carla Python package that matches your simulator version is error-prone: PyPI only has wheels for some Python versions, bundled wheels are tagged to specific interpreters, and agents running under uvx/pipx often install into the wrong environment entirely. This Skill detects what is present, picks the right source, installs it, and verifies the client/server version match. ## Core Features & Use Cases - Multi-source installation: Installs from a wheel bundled with your CARLA release or checkout, from PyPI (pip install carla==X.Y.Z), or by placing an older release's .egg on PYTHONPATH, auto-picking the source guaranteed to match your simulator. - Interpreter targeting and verification: Installs into the interpreter you choose via PYTHON, pins numpy<2, verifies import carla actually works, and compares client vs server versions when a simulator is reachable. - Use Case: A user downloads CARLA 0.9.16 and asks to set up the Python API. The Skill finds the bundled cp310 wheel, installs it into their venv, and confirms the client version matches the running simulator. ## Quick Start Ask the agent to install the CARLA Python API into your virtual environment and verify it can connect to your simulator.

Frequently Asked Questions about install-python-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I install the CARLA Python API package?▼

Run the install script, which auto-picks the best source: a wheel bundled with your CARLA release, PyPI via pip install carla==X.Y.Z, or an egg on PYTHONPATH for older releases. It verifies import carla works in the target interpreter afterward.

How to fix 'cannot import carla' in Python?▼

The error means the carla package is not importable by the interpreter running your code. Run detect to see the target interpreter, then install; if the interpreter is inside a uv or pipx cache path, set PYTHON to your real environment first.

Does the carla PyPI package support Python 3.13 or macOS?▼

No. PyPI has carla wheels only for cp310-cp312 (0.9.16) on Linux and Windows, with no macOS wheels at all. For unsupported interpreters, use a bundled wheel from your release or build from source with make PythonAPI.

Why does CARLA warn about client and simulator version mismatch?▼

CARLA expects the client and simulator to be the same version and prints a warning on every connection when they differ. The skill treats this as a warning, not a failure; prefer the wheel bundled with your release or install the server's exact version from PyPI.

Why does pip install carla fail with externally-managed-environment?▼

System interpreters on Ubuntu 24.04+ and Debian are marked externally managed under PEP 668, so pip refuses direct installs. Install into a virtual environment and point the PYTHON variable at it instead.