Project Structure and Usage

Project Structure

The groundvehpy project is organized as follows:

• src/groundvehpy/ — Main package directory containing:
  • controller.py: Implements control algorithms for ground vehicles.
  • ugv.py: Kinematic model and simulation utilities for ground vehicles.
  • path_planning.py: Path planning algorithms and utilities.
  • __init__.py: Package initialization.
• demo.py — A brief example script demonstrating the usage of the package.
• pyproject.toml — Project metadata and build configuration.
• README.md — Project documentation (this file).

Tools and Features

• Controller: The controller.py module provides control logic for ground vehicle navigation and movement.
• Path Planning: The path_planning.py module includes algorithms for generating and following trajectories.
• UGV: The ugv.py module contains the kinematic model for simulating ground vehicle behavior.

Installation

To install the package in editable mode, navigate to the directory containing pyproject.toml and run:

pip install -e .

This installs groundvehpy in your Python environment in editable mode, allowing immediate use of any source code changes.

Note: If you modify the package source code or structure, reinstall it using the same command:

pip install -e .

Updating the Package

To update to the latest version from the repository, pull the newest changes and reinstall:

git pull
pip install -e .

This ensures your environment uses the most recent code.

Example Usage

The demo.py file provides a brief example demonstrating how to use the package. Run it after installation to see a basic ground vehicle simulation in action.