# CARLA Driving Simulator Client
<p align="left">
<a href="https://github.com/akshaychikhalkar/carla-driving-simulator-client/actions/workflows/build-publish-release.yml" target="_blank">
<img src="https://img.shields.io/github/actions/workflow/status/akshaychikhalkar/carla-driving-simulator-client/build-publish-release.yml?branch=master&label=CI%2FCD%20Pipeline&logo=github" alt="CI/CD Pipeline">
</a>
<a href="https://github.com/akshaychikhalkar/carla-driving-simulator-client/actions/workflows/build-publish-release.yml" target="_blank">
<img src="https://img.shields.io/github/actions/workflow/status/akshaychikhalkar/carla-driving-simulator-client/build-publish-release.yml?branch=master&label=Tests&logo=github" alt="Tests">
</a>
<a href="https://codecov.io/gh/akshaychikhalkar/carla-driving-simulator-client" target="_blank">
<img src="https://img.shields.io/codecov/c/github/akshaychikhalkar/carla-driving-simulator-client/master?logo=codecov" alt="Codecov">
</a>
<a href="https://carla-driving-simulator-client.readthedocs.io/en/latest/" target="_blank">
<img src="https://img.shields.io/readthedocs/carla-driving-simulator-client?logo=read-the-docs" alt="Documentation Status">
</a>
<a href="https://opensource.org/licenses/MIT" target="_blank">
<img src="https://img.shields.io/github/license/akshaychikhalkar/carla-driving-simulator-client" alt="License">
</a>
<a href="https://www.python.org/downloads/" target="_blank">
<img src="https://img.shields.io/badge/python-3.11-blue.svg?logo=python" alt="Python 3.11">
</a>
<a href="https://github.com/psf/black" target="_blank">
<img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black">
</a>
<a href="https://pypi.org/project/carla-driving-simulator-client/" target="_blank">
<img src="https://img.shields.io/pypi/v/carla-driving-simulator-client?logo=pypi" alt="PyPI version">
</a>
<a href="https://hub.docker.com/r/akshaychikhalkar/carla-driving-simulator-client" target="_blank">
<img src="https://img.shields.io/docker/pulls/akshaychikhalkar/carla-driving-simulator-client?logo=docker" alt="Docker Hub">
</a>
<a href="https://github.com/akshaychikhalkar/carla-driving-simulator-client/releases" target="_blank">
<img src="https://img.shields.io/github/v/release/akshaychikhalkar/carla-driving-simulator-client?logo=github" alt="GitHub release">
</a>
<a href="https://github.com/akshaychikhalkar/carla-driving-simulator-client/issues" target="_blank">
<img src="https://img.shields.io/github/issues/akshaychikhalkar/carla-driving-simulator-client" alt="GitHub issues">
</a>
<a href="https://github.com/akshaychikhalkar/carla-driving-simulator-client/pulls" target="_blank">
<img src="https://img.shields.io/github/issues-pr/akshaychikhalkar/carla-driving-simulator-client" alt="GitHub pull requests">
</a>
<a href="https://github.com/akshaychikhalkar/carla-driving-simulator-client/commits/master" target="_blank">
<img src="https://img.shields.io/github/last-commit/akshaychikhalkar/carla-driving-simulator-client/master" alt="GitHub last commit">
</a>
<a href="https://github.com/akshaychikhalkar/carla-driving-simulator-client" target="_blank">
<img src="https://img.shields.io/github/repo-size/akshaychikhalkar/carla-driving-simulator-client" alt="GitHub repo size">
</a>
</p>
A personal project for experimenting with CARLA client, featuring vehicle control, sensor management, and visualization capabilities.
## Features
- Realistic vehicle physics and control
- Multiple sensor types (Camera, GNSS, Collision, Lane Invasion)
- Dynamic weather system
- Traffic and pedestrian simulation
- Real-time visualization with HUD and minimap
- Comprehensive logging and data collection
- Support for both manual and autopilot modes
- Configurable simulation parameters
- **Automatic versioning and CI/CD pipeline**
- **Docker support with zero-configuration setup**
- **Web-based frontend and backend API**
## Requirements
- Python 3.11
- CARLA Simulator 0.10.0
- Pygame
- NumPy
- Matplotlib
- Tabulate
- PyYAML
- SQLAlchemy
- PostgreSQL (optional)
## Installation
### From Docker (Recommended)
```bash
# Pull the latest image
docker pull akshaychikhalkar/carla-driving-simulator-client:latest
# Run with Docker (frontend served by backend on port 8081)
docker run -p 8081:8000 akshaychikhalkar/carla-driving-simulator-client:latest
# Or use Docker Compose (recommended)
git clone https://github.com/AkshayChikhalkar/carla-driving-simulator-client.git
cd carla-driving-simulator-client
docker-compose -f docker-compose-prod.yml up -d
```
### From PyPI
```bash
pip install carla-driving-simulator-client
```
### From Source
1. Clone the repository:
```bash
git clone https://github.com/AkshayChikhalkar/carla-driving-simulator-client.git
cd carla-driving-simulator-client
```
2. Install in development mode:
```bash
pip install -e .
```
3. Install CARLA:
- Download CARLA 0.10.0 from [CARLA's website](https://carla.org/)
- Extract the package and set the CARLA_ROOT environment variable
- Add CARLA Python API to your PYTHONPATH:
```bash
# For Windows
set PYTHONPATH=%PYTHONPATH%;C:\path\to\carla\PythonAPI\carla\dist\carla-0.10.0-py3.11-win-amd64.egg
# For Linux
export PYTHONPATH=$PYTHONPATH:/path/to/carla/PythonAPI/carla/dist/carla-0.10.0-py3.11-linux-x86_64.egg
```
## Usage
1. Start the CARLA server:
```bash
./CarlaUE4.sh -carla-rpc-port=2000
```
2. Run the simulator client:
```bash
# If installed from PyPI
carla-simulator-client
# If installed from source
python -m carla_simulator.cli
```
## Configuration
The simulator client can be configured through the `config/simulation_config.yaml` file. Key parameters include:
- Target distance
- Maximum speed
- Simulation duration
- Vehicle model
- Sensor settings
- Weather conditions
## Project Structure
```
carla-driving-simulator-client/
├── carla_simulator/
│ ├── core/
│ ├── visualization/
│ ├── control/
│ ├── scenarios/
│ ├── database/
│ ├── utils/
│ └── cli.py
├── web/
├── tests/
├── config/
├── docs/
├── requirements/
└── README.md
```
## Testing
This project includes comprehensive testing for both backend (Python) and frontend (React) components.
### Backend Testing
```bash
# Run all Python tests
pytest tests/ --cov=carla_simulator --cov=web --cov-branch
# Run specific test modules
pytest tests/test_core.py
pytest tests/test_scenarios.py
```
### Frontend Testing
```bash
# Navigate to frontend directory
cd web/frontend
# Install dependencies
npm install
# Run tests in watch mode (development)
npm test
# Run tests in CI mode (no watch, with coverage)
npm run test:ci
```
### CI/CD Pipeline
The project uses GitHub Actions for automated testing:
- **Backend Tests**: Python tests with pytest and coverage reporting
- **Frontend Tests**: React tests with Jest and coverage reporting
- **Docker Tests**: Build and runtime validation of Docker containers
- **Integration Tests**: End-to-end testing of the complete system
All tests must pass before code can be merged to the main branch.
## Contributing
1. Fork the repository
2. Create your feature branch:
```bash
git checkout -b feature/amazing-feature
```
3. Commit your changes:
```bash
git commit -m 'Add some amazing feature'
```
4. Push to the branch:
```bash
git push origin feature/amazing-feature
```
5. Open a Pull Request
**Important**: Please ensure all tests pass before submitting a pull request. The CI/CD pipeline will automatically run both backend and frontend tests.
Note: I cannot guarantee response times or implementation of suggested features as this project is maintained in my free time.
## Support
If you need help, please check our [Support Guide](https://github.com/AkshayChikhalkar/carla-driving-simulator-client/blob/master/SUPPORT.md) for various ways to get assistance.
## Security
Please report any security issues to our [Security Policy](https://github.com/AkshayChikhalkar/carla-driving-simulator-client/blob/master/SECURITY.md).
## License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/AkshayChikhalkar/carla-driving-simulator-client/blob/master/LICENSE) file for details.
## Acknowledgments
- CARLA Simulator Team
- TH OWL for initial development
## Roadmap
Check our [Roadmap](https://github.com/AkshayChikhalkar/carla-driving-simulator-client/blob/master/ROADMAP.md) for planned features and improvements.
## Documentation
- **[Versioning Strategy](https://github.com/AkshayChikhalkar/carla-driving-simulator-client/blob/master/VERSIONING.md)** - How automatic versioning works
- **[Environment Configuration](https://github.com/AkshayChikhalkar/carla-driving-simulator-client/blob/master/ENVIRONMENT.md)** - Environment variables and configuration
- **[Support Guide](https://github.com/AkshayChikhalkar/carla-driving-simulator-client/blob/master/SUPPORT.md)** - Getting help and support
- **[Security Policy](https://github.com/AkshayChikhalkar/carla-driving-simulator-client/blob/master/SECURITY.md)** - Reporting security issues
- **[Contributing Guidelines](https://github.com/AkshayChikhalkar/carla-driving-simulator-client/blob/master/CONTRIBUTING.md)** - How to contribute to the project
#test for ci-test
## Configuration
Raw data
{
"_id": null,
"home_page": null,
"name": "carla-driving-simulator-client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "Akshay Chikhalkar <akshaychikhalkar15@gmail.com>",
"keywords": "carla, autonomous-driving, simulation, pygame, visualization, scenario-testing, vehicle-control",
"author": null,
"author_email": "Akshay Chikhalkar <akshaychikhalkar15@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/db/d0/e3ffbdc70c5ecd55124b388c9e8bdd036f38536e9be1d7570576d2218ee5/carla_driving_simulator_client-2.0.39.tar.gz",
"platform": null,
"description": "# CARLA Driving Simulator Client\n\n<p align=\"left\">\n <a href=\"https://github.com/akshaychikhalkar/carla-driving-simulator-client/actions/workflows/build-publish-release.yml\" target=\"_blank\">\n <img src=\"https://img.shields.io/github/actions/workflow/status/akshaychikhalkar/carla-driving-simulator-client/build-publish-release.yml?branch=master&label=CI%2FCD%20Pipeline&logo=github\" alt=\"CI/CD Pipeline\">\n </a>\n <a href=\"https://github.com/akshaychikhalkar/carla-driving-simulator-client/actions/workflows/build-publish-release.yml\" target=\"_blank\">\n <img src=\"https://img.shields.io/github/actions/workflow/status/akshaychikhalkar/carla-driving-simulator-client/build-publish-release.yml?branch=master&label=Tests&logo=github\" alt=\"Tests\">\n </a>\n <a href=\"https://codecov.io/gh/akshaychikhalkar/carla-driving-simulator-client\" target=\"_blank\">\n <img src=\"https://img.shields.io/codecov/c/github/akshaychikhalkar/carla-driving-simulator-client/master?logo=codecov\" alt=\"Codecov\">\n </a>\n <a href=\"https://carla-driving-simulator-client.readthedocs.io/en/latest/\" target=\"_blank\">\n <img src=\"https://img.shields.io/readthedocs/carla-driving-simulator-client?logo=read-the-docs\" alt=\"Documentation Status\">\n </a>\n <a href=\"https://opensource.org/licenses/MIT\" target=\"_blank\">\n <img src=\"https://img.shields.io/github/license/akshaychikhalkar/carla-driving-simulator-client\" alt=\"License\">\n </a>\n <a href=\"https://www.python.org/downloads/\" target=\"_blank\">\n <img src=\"https://img.shields.io/badge/python-3.11-blue.svg?logo=python\" alt=\"Python 3.11\">\n </a>\n <a href=\"https://github.com/psf/black\" target=\"_blank\">\n <img src=\"https://img.shields.io/badge/code%20style-black-000000.svg\" alt=\"Code style: black\">\n </a>\n <a href=\"https://pypi.org/project/carla-driving-simulator-client/\" target=\"_blank\">\n <img src=\"https://img.shields.io/pypi/v/carla-driving-simulator-client?logo=pypi\" alt=\"PyPI version\">\n </a>\n <a href=\"https://hub.docker.com/r/akshaychikhalkar/carla-driving-simulator-client\" target=\"_blank\">\n <img src=\"https://img.shields.io/docker/pulls/akshaychikhalkar/carla-driving-simulator-client?logo=docker\" alt=\"Docker Hub\">\n </a>\n <a href=\"https://github.com/akshaychikhalkar/carla-driving-simulator-client/releases\" target=\"_blank\">\n <img src=\"https://img.shields.io/github/v/release/akshaychikhalkar/carla-driving-simulator-client?logo=github\" alt=\"GitHub release\">\n </a>\n <a href=\"https://github.com/akshaychikhalkar/carla-driving-simulator-client/issues\" target=\"_blank\">\n <img src=\"https://img.shields.io/github/issues/akshaychikhalkar/carla-driving-simulator-client\" alt=\"GitHub issues\">\n </a>\n <a href=\"https://github.com/akshaychikhalkar/carla-driving-simulator-client/pulls\" target=\"_blank\">\n <img src=\"https://img.shields.io/github/issues-pr/akshaychikhalkar/carla-driving-simulator-client\" alt=\"GitHub pull requests\">\n </a>\n <a href=\"https://github.com/akshaychikhalkar/carla-driving-simulator-client/commits/master\" target=\"_blank\">\n <img src=\"https://img.shields.io/github/last-commit/akshaychikhalkar/carla-driving-simulator-client/master\" alt=\"GitHub last commit\">\n </a>\n <a href=\"https://github.com/akshaychikhalkar/carla-driving-simulator-client\" target=\"_blank\">\n <img src=\"https://img.shields.io/github/repo-size/akshaychikhalkar/carla-driving-simulator-client\" alt=\"GitHub repo size\">\n </a>\n</p>\n\nA personal project for experimenting with CARLA client, featuring vehicle control, sensor management, and visualization capabilities.\n\n## Features\n\n- Realistic vehicle physics and control\n- Multiple sensor types (Camera, GNSS, Collision, Lane Invasion)\n- Dynamic weather system\n- Traffic and pedestrian simulation\n- Real-time visualization with HUD and minimap\n- Comprehensive logging and data collection\n- Support for both manual and autopilot modes\n- Configurable simulation parameters\n- **Automatic versioning and CI/CD pipeline**\n- **Docker support with zero-configuration setup**\n- **Web-based frontend and backend API**\n\n## Requirements\n\n- Python 3.11\n- CARLA Simulator 0.10.0\n- Pygame\n- NumPy\n- Matplotlib\n- Tabulate\n- PyYAML\n- SQLAlchemy\n- PostgreSQL (optional)\n\n## Installation\n\n### From Docker (Recommended)\n```bash\n# Pull the latest image\ndocker pull akshaychikhalkar/carla-driving-simulator-client:latest\n\n# Run with Docker (frontend served by backend on port 8081)\ndocker run -p 8081:8000 akshaychikhalkar/carla-driving-simulator-client:latest\n\n# Or use Docker Compose (recommended)\ngit clone https://github.com/AkshayChikhalkar/carla-driving-simulator-client.git\ncd carla-driving-simulator-client\ndocker-compose -f docker-compose-prod.yml up -d\n```\n\n### From PyPI\n```bash\npip install carla-driving-simulator-client\n```\n\n### From Source\n1. Clone the repository:\n```bash\ngit clone https://github.com/AkshayChikhalkar/carla-driving-simulator-client.git\ncd carla-driving-simulator-client\n```\n\n2. Install in development mode:\n```bash\npip install -e .\n```\n\n3. Install CARLA:\n- Download CARLA 0.10.0 from [CARLA's website](https://carla.org/)\n- Extract the package and set the CARLA_ROOT environment variable\n- Add CARLA Python API to your PYTHONPATH:\n```bash\n# For Windows\nset PYTHONPATH=%PYTHONPATH%;C:\\path\\to\\carla\\PythonAPI\\carla\\dist\\carla-0.10.0-py3.11-win-amd64.egg\n\n# For Linux\nexport PYTHONPATH=$PYTHONPATH:/path/to/carla/PythonAPI/carla/dist/carla-0.10.0-py3.11-linux-x86_64.egg\n```\n\n## Usage\n\n1. Start the CARLA server:\n```bash\n./CarlaUE4.sh -carla-rpc-port=2000\n```\n\n2. Run the simulator client:\n```bash\n# If installed from PyPI\ncarla-simulator-client\n\n# If installed from source\npython -m carla_simulator.cli\n```\n\n## Configuration\n\nThe simulator client can be configured through the `config/simulation_config.yaml` file. Key parameters include:\n\n- Target distance\n- Maximum speed\n- Simulation duration\n- Vehicle model\n- Sensor settings\n- Weather conditions\n\n## Project Structure\n\n```\ncarla-driving-simulator-client/\n\u251c\u2500\u2500 carla_simulator/\n\u2502 \u251c\u2500\u2500 core/\n\u2502 \u251c\u2500\u2500 visualization/\n\u2502 \u251c\u2500\u2500 control/\n\u2502 \u251c\u2500\u2500 scenarios/\n\u2502 \u251c\u2500\u2500 database/\n\u2502 \u251c\u2500\u2500 utils/\n\u2502 \u2514\u2500\u2500 cli.py\n\u251c\u2500\u2500 web/\n\u251c\u2500\u2500 tests/\n\u251c\u2500\u2500 config/\n\u251c\u2500\u2500 docs/\n\u251c\u2500\u2500 requirements/\n\u2514\u2500\u2500 README.md\n```\n\n## Testing\n\nThis project includes comprehensive testing for both backend (Python) and frontend (React) components.\n\n### Backend Testing\n```bash\n# Run all Python tests\npytest tests/ --cov=carla_simulator --cov=web --cov-branch\n\n# Run specific test modules\npytest tests/test_core.py\npytest tests/test_scenarios.py\n```\n\n### Frontend Testing\n```bash\n# Navigate to frontend directory\ncd web/frontend\n\n# Install dependencies\nnpm install\n\n# Run tests in watch mode (development)\nnpm test\n\n# Run tests in CI mode (no watch, with coverage)\nnpm run test:ci\n```\n\n### CI/CD Pipeline\nThe project uses GitHub Actions for automated testing:\n- **Backend Tests**: Python tests with pytest and coverage reporting\n- **Frontend Tests**: React tests with Jest and coverage reporting\n- **Docker Tests**: Build and runtime validation of Docker containers\n- **Integration Tests**: End-to-end testing of the complete system\n\nAll tests must pass before code can be merged to the main branch.\n\n## Contributing\n\n1. Fork the repository\n2. Create your feature branch:\n```bash\ngit checkout -b feature/amazing-feature\n```\n3. Commit your changes:\n```bash\ngit commit -m 'Add some amazing feature'\n```\n4. Push to the branch:\n```bash\ngit push origin feature/amazing-feature\n```\n5. Open a Pull Request\n\n**Important**: Please ensure all tests pass before submitting a pull request. The CI/CD pipeline will automatically run both backend and frontend tests.\n\nNote: I cannot guarantee response times or implementation of suggested features as this project is maintained in my free time.\n\n## Support\n\nIf you need help, please check our [Support Guide](https://github.com/AkshayChikhalkar/carla-driving-simulator-client/blob/master/SUPPORT.md) for various ways to get assistance.\n\n## Security\n\nPlease report any security issues to our [Security Policy](https://github.com/AkshayChikhalkar/carla-driving-simulator-client/blob/master/SECURITY.md).\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](https://github.com/AkshayChikhalkar/carla-driving-simulator-client/blob/master/LICENSE) file for details.\n\n## Acknowledgments\n\n- CARLA Simulator Team\n- TH OWL for initial development\n\n## Roadmap\n\nCheck our [Roadmap](https://github.com/AkshayChikhalkar/carla-driving-simulator-client/blob/master/ROADMAP.md) for planned features and improvements.\n\n## Documentation\n\n- **[Versioning Strategy](https://github.com/AkshayChikhalkar/carla-driving-simulator-client/blob/master/VERSIONING.md)** - How automatic versioning works\n- **[Environment Configuration](https://github.com/AkshayChikhalkar/carla-driving-simulator-client/blob/master/ENVIRONMENT.md)** - Environment variables and configuration\n- **[Support Guide](https://github.com/AkshayChikhalkar/carla-driving-simulator-client/blob/master/SUPPORT.md)** - Getting help and support\n- **[Security Policy](https://github.com/AkshayChikhalkar/carla-driving-simulator-client/blob/master/SECURITY.md)** - Reporting security issues\n- **[Contributing Guidelines](https://github.com/AkshayChikhalkar/carla-driving-simulator-client/blob/master/CONTRIBUTING.md)** - How to contribute to the project\n#test for ci-test\n## Configuration \n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A comprehensive CARLA client for autonomous driving simulation",
"version": "2.0.39",
"project_urls": {
"Bug Tracker": "https://github.com/akshaychikhalkar/carla-driving-simulator-client/issues",
"Documentation": "https://carla-driving-simulator-client.readthedocs.io/",
"Homepage": "https://github.com/akshaychikhalkar/carla-driving-simulator-client",
"Repository": "https://github.com/akshaychikhalkar/carla-driving-simulator-client"
},
"split_keywords": [
"carla",
" autonomous-driving",
" simulation",
" pygame",
" visualization",
" scenario-testing",
" vehicle-control"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "a53b527a4c7f54ed7b961cdd9d589f771668e637ed081ce8fc9bfc1750ebd1ff",
"md5": "7991d8a2ffa591818722cb612a2b5803",
"sha256": "83a11c8bb52dddbc93c712b954f876951d4c8b6a6e3ada20a1d0d4df88910b59"
},
"downloads": -1,
"filename": "carla_driving_simulator_client-2.0.39-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7991d8a2ffa591818722cb612a2b5803",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 145967,
"upload_time": "2025-10-06T09:39:06",
"upload_time_iso_8601": "2025-10-06T09:39:06.299878Z",
"url": "https://files.pythonhosted.org/packages/a5/3b/527a4c7f54ed7b961cdd9d589f771668e637ed081ce8fc9bfc1750ebd1ff/carla_driving_simulator_client-2.0.39-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "dbd0e3ffbdc70c5ecd55124b388c9e8bdd036f38536e9be1d7570576d2218ee5",
"md5": "f49cd8ccc15d683dbeedfa25ad48c83b",
"sha256": "4c45f7b7c50275c209b5447a6053d5f59e005a30484645ebcc66e8f001ac8dbd"
},
"downloads": -1,
"filename": "carla_driving_simulator_client-2.0.39.tar.gz",
"has_sig": false,
"md5_digest": "f49cd8ccc15d683dbeedfa25ad48c83b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 124071,
"upload_time": "2025-10-06T09:39:07",
"upload_time_iso_8601": "2025-10-06T09:39:07.829200Z",
"url": "https://files.pythonhosted.org/packages/db/d0/e3ffbdc70c5ecd55124b388c9e8bdd036f38536e9be1d7570576d2218ee5/carla_driving_simulator_client-2.0.39.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-06 09:39:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "akshaychikhalkar",
"github_project": "carla-driving-simulator-client",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "carla-driving-simulator-client"
}
JSON
