autonavsim2D 0.0.2

This project provides a 2D simulation environment designed for the development and testing of path planning algorithms. It offers a flexible and interactive platform for researchers, developers, and hobbyists to experiment with various path planning strategies in a controlled virtual space.

---

AutoNavSim2D

This project provides a 2D simulation environment designed for the development and testing of path planning algorithms. It offers a flexible and interactive platform for researchers, developers, and hobbyists to experiment with various path planning strategies in a controlled virtual space.

This project is being maintained by Clinton Anani.

---

Table of Contents

• Installation
• Usage
• Features
• Demo
• Configuration
• Requirements
• Contributing
• License
• Acknowledgments
• Contact

Installation

Follow these steps to install and set up the simulation environment on your system:

pip install autonavsim2D

Usage

To use the simulation environment for basic path planning and navigation with the default Djikstra algorithm path planner, create a main.py file, and import the package:

from autonavsim2d.autonavsim2d import AutoNavSim2D

nav = AutoNavSim2D(
    custom_planner='default', 
    window='amr'
)

nav.run()

Configuration

AutoNavSim2D can be customized in numerous ways. To launch the simulation environment with a starting page, set the window parameter to default:

nav = AutoNavSim2D(
    custom_planner='default', 
    window='default'
)

To launch the simulation environment in map mode where you can begin visualization, set the window parameter to amr:

nav = AutoNavSim2D(
    custom_planner='default', 
    window='amr'
)

To use your custom path planner in AutoNavSim2D, write it in a function or class, and set it to the custom_planner parameter as seen below:

from autonavsim2d.autonavsim2d import AutoNavSim2D

def my_planner(grid, matrix, start_loc, goal_loc):
    # your own custom path planning algorithm here
    path = []
    runtime = ''
    
    return (path, runtime)

nav = AutoNavSim2D(
    custom_planner=my_planner, 
    window='amr'
)

nav.run()

Features

Currently, AutoNavSim2D has the following features:

• 2D path planning
• Reactive autonomous navigation
• Dynamic map generation
• Support for custom graph-based path planning algorithms such as A*, Djiktra or D*

Demo

See a video demo of the simulation environment in action here or check out the screenshots below:

Requirements

AutoNavSim2D is designed to be lightweight and memory efficient, so no dedicated hardware is required to run it. It is built on the pygame python package.

Contributing

To contribute, please email me at [e-mail]. We welcome contributions from the community!

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

AutoNavSim was built on Pygame. Thank you to the Pygame community for making this available :)

Contact

For inquiries or feedback, feel free to reach out:

• Email: [e-mail]
• Twitter: https://twitter.com/oxncgen
• Linkedin: https://www.linkedin.com/in/clinton-anani-56a125196/