https://github.com/tomcat-42/graph_searcher

A visual representation of search algorithms for graphs
https://github.com/tomcat-42/graph_searcher

Last synced: 25 days ago
JSON representation

A visual representation of search algorithms for graphs

• Host: GitHub
• URL: https://github.com/tomcat-42/graph_searcher
• Owner: Tomcat-42
• Created: 2022-11-30T12:05:52.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-21T00:00:03.000Z (about 2 years ago)
• Last Synced: 2024-02-28T13:43:17.577Z (11 months ago)
• Language: Python
• Size: 709 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# graph searcher

[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)

A graph search algorithms visualization tool.

## Install

  The package is available on [pypi](https://pypi.org/project/graph-searcher/):

  ```bash

pip install graph_searcher

  ```

## Usage

```

usage: graph_searcher [-h] [--verbose] [--version] (--file FILE | --random) --path START END [--algorithm {bfs,sma}] [--bound BOUND]

                      [--interval INTERVAL] [--repeat] [--output OUTPUT]

Search a graph for a path between two nodes

options:

  -h, --help            show this help message and exit

  --verbose, -v         increase output verbosity

  --version             show program's version number and exit

  --file FILE           JSON File to read graph from

  --random              A random generated graph

  --path START END      Starting and ending nodes

  --algorithm {bfs,sma}, -a {bfs,sma}

                        Which algorithm to use for searching the graph

  --bound BOUND, -b BOUND

                        Bound for SMA algorithm

  --interval INTERVAL, -i INTERVAL

                        Animation Interval

  --repeat, -r          Repeat the animation

  --output OUTPUT, -o OUTPUT

                        Output file

```

## Run

The `assets` folder contains some graphs for testing:

- **SMA \*(boundary=5) algorithm on Paraná Graph**:

```bash

graph_searcher --file ./assets/parana.json --path Cascavel Londrina -a sma -b 5

```

https://user-images.githubusercontent.com/44649669/208787339-f90d841c-91df-4011-975d-b0f8760ae27e.mp4

- **BFS algorithm on Paraná Graph**:

```bash

graph_searcher --file ./assets/parana.json --path Cascavel Londrina -a bfs

```

https://user-images.githubusercontent.com/44649669/208787516-8edfaeeb-8f4a-40d9-9828-808c6543caf2.mp4

- **SMA\* (boundary=4) algorithm on example Graph**:

```bash

graph_searcher --file ./assets/example.json --path n m -a sma -b 4

```

https://user-images.githubusercontent.com/44649669/208787598-bd7578c8-1cdf-4dfe-96c2-17c778845ee4.mp4

- **BFS algorithm on example Graph**:

```bash

graph_searcher --file ./assets/example.json --path n m -a bfs

```

https://user-images.githubusercontent.com/44649669/208787387-2f3a82cb-ea0f-4a67-bf66-7e64a367c38c.mp4

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    

      
Pablo Alessandro Santos Hugen
💻 📖 🤔 🔬

      
Matheus Nunes Ismael
💻 📖 🤔 🔬

      
AlessandraDosSantos
💻 📖 🤔 🔬

    

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!