pymycar 0.0.3

pyMyCar: An Open-Source Framework for Vehicle Dynamics simulations

Welcome to pyMyCar. documentation

Introduction

The pyMyCar project is a comprehensive Python library designed to facilitate the analysis and simulation of vehicle dynamics. This package provides tools to explore, simulate, and optimize various suspension configurations, enhancing vehicle performance and safety.

Installation Instructions (Conda Environment)

To install pyMyCar and its dependencies in a dedicated conda environment, follow these steps:

1. Create a new conda environment (recommended for isolation):

   conda create -n pymycar-env

2. Activate the environment:

   conda activate pymycar-env

3. Install the required packages from the conda-forge channel:

   conda install -c conda-forge scipy pyvista pandas tabulate

4. Install pyMyCar from PyPI using pip:

   pip install pymycar

These instructions ensure all dependencies are installed in a clean, isolated conda environment. Always activate pymycar-env before working with this project.

Examples

There are numerous examples available to demonstrate the usage of pyMyCar for various vehicle dynamics simulations. These examples cover different scenarios such as suspension analysis, vehicle stability, and more complex dynamics simulations. Explore the examples in the documentation to learn more.

API Documentation

For detailed API documentation, including class references, function definitions, and usage examples, please refer to the API documentation.

You can also explore the project on DeepWiki — an AI-powered, interactive knowledge base built from the code and documentation: Explore pyMyCar on DeepWiki

Contributions and Feedback

We welcome contributions and feedback from the community to enhance the code’s functionality, reliability, and user experience.To get started, please review our Contributing Guidelines to share your insights and collaborate with fellow developers.

Thank you for choosing our pyMyCar simulation code. We trust this tool will prove invaluable in advancing your understanding of vehicle dynamics and its practical applications.