Skip to content

EdwinJaico-Berg/final_project

Repository files navigation

Contributors Forks Stargazers Issues LinkedIn


Logo

Path Finding Visualiser

A path finding visualiser built in python!
Explore the docs

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

I have built this path finding visualiser as part of Harvard's CS50 course. The visualiser is able to show a greedy algorithm, alongside breadth first search, depth first search, Djikstra's and A* search.

(back to top)

Getting Started

Just clone the repo and you're good to go!

Prerequisites

This project requires two packages: pygame and numpy. sh pip install numpy pygame

(back to top)

Usage

In order to use the visualiser, the user must run the runner.py file along with 2 optional command line arguments. The first of these is the algorithm keyword, which determines the algorith that is used to find the target. The second is the maze keyword, which automatically creates a maze on the board for the algorithm to explore. If both of these are omitted however, the algorithm will default to A* search and no maze will be drawn.

(back to top)

Roadmap

  • Fix path drawing features
  • Increase the number of algorithms visualised

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

Contact

Edwin Jaico-Berg - @ejaicoberg - e.j.berg@outlook.com

Project Link: https://github.com/EdwinJaico-Berg/final_project

(back to top)