Skip to content

OpenCDA Changelog

This changelog documents the evolution of OpenCDA within the OpenCDA-MARL project. While we develop the MARL extension, we also continuously improve and modify the core OpenCDA functionality.

Tracking OpenCDA Evolution

This changelog tracks all modifications made to the original OpenCDA codebase. Changes are organized by category and version for easy reference.

Latest Changes

Version 0.1.3.1 (Current)

Change Categories

🏗️ Architecture Changes

Structural modifications to the OpenCDA core including:

  • Version management system
  • Module organization
  • Package structure

🔧 API Changes

Updates to interfaces and functions:

  • Command line arguments
  • Function signatures
  • Class modifications

⚙️ Configuration Changes

Configuration system updates:

  • YAML structure changes
  • Default parameters
  • Scenario configurations

📦 Platform & Dependencies

Environment and compatibility:

  • Package management (Conda → Pixi)
  • Python version requirements
  • CARLA version updates
  • Platform-specific fixes

📚 Migration & Documentation

Migration guide and documentation updates:

  • Step-by-step migration from original OpenCDA
  • Documentation system migration (Sphinx → MkDocs)
  • Common issues and solutions

Quick Reference

Change Type Impact Migration Required
Version Management Low Update imports
Command Line Medium Update scripts
Package Manager High Reinstall environment
Documentation Low New location

Contributing Changes

When making changes to OpenCDA core:

  1. Document the change in the appropriate category file
  2. Update this index if adding new categories
  3. Include migration notes for breaking changes
  4. Reference related GitHub issues/PRs

Migration Guide

For users migrating from original OpenCDA, see:

!!! tip "Staying Updated" Subscribe to our GitHub releases to get notified of new changes.