<!-- <picture align="center">
<img alt="Traverse Craft Logo" src="https://github.com/srajan-kiyotaka/TraverseCraft/blob/main/src/traverseCraft/icons/logo/traverseCraftLandscapeLogo.png">
</picture> -->
[](https://harrionparrix.github.io/traversecraft/index.html)
<!--  -->
[](https://www.python.org/)
[](https://python.org "Go to Python homepage")
[](https://badge.fury.io/py/TraverseCraft)
[](https://harrionparrix.github.io/traversecraft/references/world/World.html "Go to library documentation")
[](https://github.com/srajan-kiyotaka/TraverseCraft/blob/main/LICENCE)
[](https://github.com/srajan-kiyotaka/TraverseCraft)
[](https://github.com/srajan-kiyotaka/TraverseCraft)
<center>
<h1>
Traverse Craft
</h1>
</center>
[**TraverseCraft**](https://github.com/srajan-kiyotaka/TraverseCraft) is a ***versatile***, ***cross-platform*** library written in Python for creating *static*, *animated*, and *interactive visualizations*. Designed as a *robust simulation tool*, [**TraverseCraft**](https://github.com/srajan-kiyotaka/TraverseCraft) allows users to build custom virtual worlds, populate them with agents, and observe real-time behaviors of various algorithms, including those in artificial intelligence (AI), reinforcement learning (RL), and machine learning (ML).
Powered by the ***[tkinter](https://docs.python.org/3/library/tkinter.html#module-tkinter)*** library, [**TraverseCraft**](https://github.com/srajan-kiyotaka/TraverseCraft) ensures *fast and responsive simulations*, making it ideal for students, educators, and researchers. Its intuitive framework enables users to easily generate, visualize, and interact with diverse world types and their respective agents, facilitating the study and development of advanced AI, RL, and ML algorithms.
Please visit the our official ***[website](https://harrionparrix.github.io/traversecraft/index.html)*** for more information.
## Features
- **Cross-Platform:** TraverseCraft operates seamlessly on various operating systems, ensuring a consistent experience for all users.
- **High Performance**: Built on the ***[Tkinter](https://docs.python.org/3/library/tkinter.html#module-tkinter)*** library for fast and responsive simulations.
- **Real-Time Algorithm Simulation:** Test and visualize the workings of your algorithms, such as search algorithms, in real time.
- **Dynamic Summaries and Heatmap:** Automatically generate summaries and heatmap to track agent movements and node visits dynamically.
- **Customizable World Generation:** Create and customize diverse worlds to suit your simulation needs.
- **Educational Utility:** Enhance the learning experience for students by providing a visual aid to understand algorithm workings, aiding both instructors and learners.
- **Research Application:** An invaluable tool for researchers in fields such as reinforcement learning, AI, ML, deep learning, and algorithm design.
- **User-Friendly Interface and Framework Flexibility:** Provides extensive customization options while remaining accessible to beginners.
## World Types
TraverseCraft currently supports the creation and simulation of three distinct world types:
| World Type | Description |
|-------------|---------------------------------------------------------------------------------------|
| Grid World |A customizable simulation of a grid environment for testing algorithms and agent navigation, with options for path, goal, and block states to mimic various grid scenarios. |
| Tree World | A visualized tree data structure, perfect for experimenting with various tree-based algorithms. It offers customizable weights, positions, and appearance for flexible and detailed tree like simulations. |
| Graph World | A visualized graph data structure, perfect for experimenting with various graph-based algorithms. It offers customizable weights, edges, positions, and appearance for flexible and detailed graph like simulations. |
Each world type is equipped with specialized agents designed to interact within these environments, enabling comprehensive testing and visualization of algorithms. For more information about each class and methods please refer to [API Reference](https://harrionparrix.github.io/traversecraft/references/world/World.html) section.
## Examples
| <center> <a href='https://github.com/srajan-kiyotaka/TraverseCraft/blob/main/tutorials/Graph%20World/dijkstra.py'>Dijkstra Algorithm</a> </center> | <center> <a href='https://github.com/srajan-kiyotaka/TraverseCraft/blob/main/tutorials/Tree%20World/level_order_traversal.py'> Level Order Traversal Algorithm </a> </center> |
|-|-|
| <img src='https://github.com/srajan-kiyotaka/TraverseCraft/raw/main/resources/dijkstra.gif' alt='Dijkstra Algorithm'> |<img src='https://github.com/srajan-kiyotaka/TraverseCraft/raw/main/resources/level_order.gif' alt='Level Order Traversal Algorithm'>|
| <center> <a href='https://github.com/srajan-kiyotaka/TraverseCraft/blob/main/tutorials/Grid%20World/a_star.py'>A Star Algorithm</a> </center> | <center> <a href='https://github.com/srajan-kiyotaka/TraverseCraft/blob/main/tutorials/Grid%20World/unique_path.py'> Unique Path Traversal Algorithm </a> </center> |
| <img src='https://github.com/srajan-kiyotaka/TraverseCraft/raw/main/resources/AStar.gif' alt='A Star Algorithm'> |<img src='https://github.com/srajan-kiyotaka/TraverseCraft/raw/main/resources/unique_paths.gif' alt='Unique Paths Algorithm'>|
Check out more in our [**Example**](https://harrionparrix.github.io/traversecraft/user-guide/examples/index.html) section on our [website](https://harrionparrix.github.io/traversecraft/index.html)!
## Installation
To install Traverse Craft, simply run:
### Using pip
```bash
pip install TraverseCraft
```
For detailed installation instructions, refer to our [installation guide](https://harrionparrix.github.io/traversecraft/getting-started/index.html).
## Getting Started
If you are new to Traverse Craft, start with the [Quick Start](https://harrionparrix.github.io/traversecraft/getting-started/quick-start.html) available in our website. For more detailed information and learning please refer to the [Tutorials](https://harrionparrix.github.io/traversecraft/user-guide/index.html), [API reference](https://harrionparrix.github.io/traversecraft/references/world/World.html), [FAQ](https://harrionparrix.github.io/traversecraft/user-guide/faq/index.html), and view [Release](https://harrionparrix.github.io/traversecraft/releases/release-1.html) for more information.
To build and see the documentation locally, please refer to [docs/ReadMe.md](docs/ReadMe.md).
Explore the source code for deeper insights, or reach out to our [community](https://github.com/srajan-kiyotaka/TraverseCraft/discussions) for help. For further assistance, visit our official [website](https://harrionparrix.github.io/traversecraft/index.html).
## Development
All the details related to contributing to the library are [**Contributor's Toolkit**](https://harrionparrix.github.io/traversecraft/contribute/index.html). Please refer to this section as this section contains information about [Ways to Contribute](https://harrionparrix.github.io/traversecraft/contribute/ways-to-contribute.html), [Development Setup](https://harrionparrix.github.io/traversecraft/contribute/dev-setup.html), [Testing Guidelines](https://harrionparrix.github.io/traversecraft/contribute/testing.html), [Write Documentation](https://harrionparrix.github.io/traversecraft/contribute/documentation.html), [Pull Request Guidelines](https://harrionparrix.github.io/traversecraft/contribute/pull-requests.html), and [Code of Conduct](https://harrionparrix.github.io/traversecraft/contribute/code-of-conduct.html). If you are unable to access the above links you can also refer to the [Contribution Guide](./CONTRIBUTING.md) locally.
Most development discussions take place on GitHub in this library via the [Discussion Page](https://github.com/srajan-kiyotaka/TraverseCraft/discussions).
### Development Setup
#### Manual Installation
You can manually set up the development environment using the following steps:
1. Fork the repository.
2. Clone your repository into your local machine.
3. Change the directory to the cloned repository.
```bash
cd TraverseCraft
```
4. Create a virtual environment.
5. Activate the virtual environment.
6. Install the dependencies:
```bash
pip install prettytable
```
To set up a development environment using Docker, follow these steps:
1. Pull the Docker image from Docker Hub:
```sh
docker pull your-username/traversecraf-dev:latest
```
2. Run the Docker container:
```sh
docker run -it --name traversecraft-dev-container -v $(pwd):/workspace your-username/traversecraf-dev:latest
```
3. Follow step 1 to 5 of manual installation.
> Note: To Access the running container:
> ```sh
> docker exec -it traversecraft-dev-container /bin/bash
> ```
## Contributing to Traverse Craft
We welcome all contributions, including [bug reports](https://github.com/srajan-kiyotaka/TraverseCraft/issues/new?assignees=&labels=bug&projects=&template=bug_report.md&title=%5BBUG%5D), [bug fixes](https://github.com/srajan-kiyotaka/TraverseCraft/issues), [documentation improvements](https://github.com/srajan-kiyotaka/TraverseCraft/issues/new?assignees=&labels=documentation&projects=&template=documentation-template.md&title=%5BDOCUMENTATION%5D), [enhancements](https://github.com/srajan-kiyotaka/TraverseCraft/issues), and [ideas](https://github.com/srajan-kiyotaka/TraverseCraft/issues/new?assignees=&labels=enhancement&projects=&template=feature_request.md&title=%5BFEATURE%5D).
Start by reading our [contributing guide](https://harrionparrix.github.io/traversecraft/contribute/contribution-guide.html).
If you have discovered a bug or have a feature request, please submit an issue on GitHub. For more detailed contribution instructions, visit our [contribution page](https://harrionparrix.github.io/traversecraft/contribute/index.html).
## Citing Traverse Craft
If you use Traverse Craft in your research or publications, please cite our library using the following reference in bibtex:
```bibtex
@misc{traversecrafthq2024,
author = {Srajan Chourasia, Varun Patrikar},
title = {Traverse Craft: A Cross-Platform Simulation Tool},
year = {2024},
url = {https://github.com/srajan-kiyotaka/TraverseCraft},
note = {Version 1.0.0},
publisher = {Traverse Craft Team},
}
```
Raw data
{
"_id": null,
"home_page": "https://harrionparrix.github.io/traversecraft/",
"name": "TraverseCraft",
"maintainer": "Varun Patrikar, Srajan Chourasia",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "patrikarvarun@gmail.com, srajanstark.ash@gmail.com",
"keywords": "algorithms, simulation, real-time, tkinter, education, research, visualization, machine learning, reinforcement learning, artificial intelligence, agent-based modeling, cross-platform, dynamic heatmap, world generation, customizable, interactive, framework, algorithm visualization, graph traversal, tree traversal, grid world",
"author": "Srajan Chourasia, Varun Patrikar",
"author_email": "srajanstark.ash@gmail.com, patrikarvarun@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e4/26/580bbf566f65bf965f51d4cdf3b2b039eec1de527eb47e6587c7c5d78aaf/traversecraft-1.0.3.tar.gz",
"platform": null,
"description": "<!-- <picture align=\"center\">\n <img alt=\"Traverse Craft Logo\" src=\"https://github.com/srajan-kiyotaka/TraverseCraft/blob/main/src/traverseCraft/icons/logo/traverseCraftLandscapeLogo.png\">\n</picture> -->\n\n[](https://harrionparrix.github.io/traversecraft/index.html)\n\n<!--  -->\n[](https://www.python.org/)\n[](https://python.org \"Go to Python homepage\")\n\n[](https://badge.fury.io/py/TraverseCraft)\n\n\n\n\n[](https://harrionparrix.github.io/traversecraft/references/world/World.html \"Go to library documentation\")\n[](https://github.com/srajan-kiyotaka/TraverseCraft/blob/main/LICENCE)\n\n[](https://github.com/srajan-kiyotaka/TraverseCraft)\n[](https://github.com/srajan-kiyotaka/TraverseCraft)\n\n\n\n\n\n\n<center>\n <h1>\n Traverse Craft\n </h1>\n</center>\n\n[**TraverseCraft**](https://github.com/srajan-kiyotaka/TraverseCraft) is a ***versatile***, ***cross-platform*** library written in Python for creating *static*, *animated*, and *interactive visualizations*. Designed as a *robust simulation tool*, [**TraverseCraft**](https://github.com/srajan-kiyotaka/TraverseCraft) allows users to build custom virtual worlds, populate them with agents, and observe real-time behaviors of various algorithms, including those in artificial intelligence (AI), reinforcement learning (RL), and machine learning (ML).\n\nPowered by the ***[tkinter](https://docs.python.org/3/library/tkinter.html#module-tkinter)*** library, [**TraverseCraft**](https://github.com/srajan-kiyotaka/TraverseCraft) ensures *fast and responsive simulations*, making it ideal for students, educators, and researchers. Its intuitive framework enables users to easily generate, visualize, and interact with diverse world types and their respective agents, facilitating the study and development of advanced AI, RL, and ML algorithms.\n\nPlease visit the our official ***[website](https://harrionparrix.github.io/traversecraft/index.html)*** for more information.\n\n## Features\n\n- **Cross-Platform:** TraverseCraft operates seamlessly on various operating systems, ensuring a consistent experience for all users.\n- **High Performance**: Built on the ***[Tkinter](https://docs.python.org/3/library/tkinter.html#module-tkinter)*** library for fast and responsive simulations.\n- **Real-Time Algorithm Simulation:** Test and visualize the workings of your algorithms, such as search algorithms, in real time.\n- **Dynamic Summaries and Heatmap:** Automatically generate summaries and heatmap to track agent movements and node visits dynamically.\n- **Customizable World Generation:** Create and customize diverse worlds to suit your simulation needs.\n- **Educational Utility:** Enhance the learning experience for students by providing a visual aid to understand algorithm workings, aiding both instructors and learners.\n- **Research Application:** An invaluable tool for researchers in fields such as reinforcement learning, AI, ML, deep learning, and algorithm design.\n- **User-Friendly Interface and Framework Flexibility:** Provides extensive customization options while remaining accessible to beginners.\n\n\n## World Types\n\nTraverseCraft currently supports the creation and simulation of three distinct world types:\n\n| World Type | Description |\n|-------------|---------------------------------------------------------------------------------------|\n| Grid World |A customizable simulation of a grid environment for testing algorithms and agent navigation, with options for path, goal, and block states to mimic various grid scenarios. |\n| Tree World | A visualized tree data structure, perfect for experimenting with various tree-based algorithms. It offers customizable weights, positions, and appearance for flexible and detailed tree like\u00a0simulations.\u00a0 |\n| Graph World | A visualized graph data structure, perfect for experimenting with various graph-based algorithms. It offers customizable weights, edges, positions, and appearance for flexible and detailed graph like\u00a0simulations.\u00a0 |\n\nEach world type is equipped with specialized agents designed to interact within these environments, enabling comprehensive testing and visualization of algorithms. For more information about each class and methods please refer to [API Reference](https://harrionparrix.github.io/traversecraft/references/world/World.html) section.\n\n## Examples\n\n| <center> <a href='https://github.com/srajan-kiyotaka/TraverseCraft/blob/main/tutorials/Graph%20World/dijkstra.py'>Dijkstra Algorithm</a> </center> | <center> <a href='https://github.com/srajan-kiyotaka/TraverseCraft/blob/main/tutorials/Tree%20World/level_order_traversal.py'> Level Order Traversal Algorithm </a> </center> |\n|-|-|\n| <img src='https://github.com/srajan-kiyotaka/TraverseCraft/raw/main/resources/dijkstra.gif' alt='Dijkstra Algorithm'> |<img src='https://github.com/srajan-kiyotaka/TraverseCraft/raw/main/resources/level_order.gif' alt='Level Order Traversal Algorithm'>|\n| <center> <a href='https://github.com/srajan-kiyotaka/TraverseCraft/blob/main/tutorials/Grid%20World/a_star.py'>A Star Algorithm</a> </center> | <center> <a href='https://github.com/srajan-kiyotaka/TraverseCraft/blob/main/tutorials/Grid%20World/unique_path.py'> Unique Path Traversal Algorithm </a> </center> |\n| <img src='https://github.com/srajan-kiyotaka/TraverseCraft/raw/main/resources/AStar.gif' alt='A Star Algorithm'> |<img src='https://github.com/srajan-kiyotaka/TraverseCraft/raw/main/resources/unique_paths.gif' alt='Unique Paths Algorithm'>|\n\nCheck out more in our [**Example**](https://harrionparrix.github.io/traversecraft/user-guide/examples/index.html) section on our [website](https://harrionparrix.github.io/traversecraft/index.html)!\n\n\n\n## Installation\n\nTo install Traverse Craft, simply run:\n\n### Using pip\n\n```bash\npip install TraverseCraft\n```\n\nFor detailed installation instructions, refer to our [installation guide](https://harrionparrix.github.io/traversecraft/getting-started/index.html).\n\n## Getting Started\n\nIf you are new to Traverse Craft, start with the [Quick Start](https://harrionparrix.github.io/traversecraft/getting-started/quick-start.html) available in our website. For more detailed information and learning please refer to the [Tutorials](https://harrionparrix.github.io/traversecraft/user-guide/index.html), [API reference](https://harrionparrix.github.io/traversecraft/references/world/World.html), [FAQ](https://harrionparrix.github.io/traversecraft/user-guide/faq/index.html), and view [Release](https://harrionparrix.github.io/traversecraft/releases/release-1.html) for more information.\n\nTo build and see the documentation locally, please refer to [docs/ReadMe.md](docs/ReadMe.md).\n\nExplore the source code for deeper insights, or reach out to our [community](https://github.com/srajan-kiyotaka/TraverseCraft/discussions) for help. For further assistance, visit our official [website](https://harrionparrix.github.io/traversecraft/index.html).\n\n## Development\n\nAll the details related to contributing to the library are [**Contributor's Toolkit**](https://harrionparrix.github.io/traversecraft/contribute/index.html). Please refer to this section as this section contains information about [Ways to Contribute](https://harrionparrix.github.io/traversecraft/contribute/ways-to-contribute.html), [Development Setup](https://harrionparrix.github.io/traversecraft/contribute/dev-setup.html), [Testing Guidelines](https://harrionparrix.github.io/traversecraft/contribute/testing.html), [Write Documentation](https://harrionparrix.github.io/traversecraft/contribute/documentation.html), [Pull Request Guidelines](https://harrionparrix.github.io/traversecraft/contribute/pull-requests.html), and [Code of Conduct](https://harrionparrix.github.io/traversecraft/contribute/code-of-conduct.html). If you are unable to access the above links you can also refer to the [Contribution Guide](./CONTRIBUTING.md) locally.\n\nMost development discussions take place on GitHub in this library via the [Discussion Page](https://github.com/srajan-kiyotaka/TraverseCraft/discussions).\n\n\n### Development Setup\n\n#### Manual Installation\n\nYou can manually set up the development environment using the following steps:\n\n1. Fork the repository.\n2. Clone your repository into your local machine.\n3. Change the directory to the cloned repository.\n ```bash\n cd TraverseCraft\n ```\n4. Create a virtual environment.\n5. Activate the virtual environment.\n6. Install the dependencies:\n ```bash\n pip install prettytable\n ```\n\nTo set up a development environment using Docker, follow these steps:\n\n1. Pull the Docker image from Docker Hub:\n\n```sh\n docker pull your-username/traversecraf-dev:latest\n```\n\n2. Run the Docker container:\n\n```sh\n docker run -it --name traversecraft-dev-container -v $(pwd):/workspace your-username/traversecraf-dev:latest\n```\n\n3. Follow step 1 to 5 of manual installation.\n\n> Note: To Access the running container:\n> ```sh\n> docker exec -it traversecraft-dev-container /bin/bash\n> ```\n\n## Contributing to Traverse Craft\n\nWe welcome all contributions, including [bug reports](https://github.com/srajan-kiyotaka/TraverseCraft/issues/new?assignees=&labels=bug&projects=&template=bug_report.md&title=%5BBUG%5D), [bug fixes](https://github.com/srajan-kiyotaka/TraverseCraft/issues), [documentation improvements](https://github.com/srajan-kiyotaka/TraverseCraft/issues/new?assignees=&labels=documentation&projects=&template=documentation-template.md&title=%5BDOCUMENTATION%5D), [enhancements](https://github.com/srajan-kiyotaka/TraverseCraft/issues), and [ideas](https://github.com/srajan-kiyotaka/TraverseCraft/issues/new?assignees=&labels=enhancement&projects=&template=feature_request.md&title=%5BFEATURE%5D).\n\nStart by reading our [contributing guide](https://harrionparrix.github.io/traversecraft/contribute/contribution-guide.html).\n\nIf you have discovered a bug or have a feature request, please submit an issue on GitHub. For more detailed contribution instructions, visit our [contribution page](https://harrionparrix.github.io/traversecraft/contribute/index.html).\n\n## Citing Traverse Craft\n\nIf you use Traverse Craft in your research or publications, please cite our library using the following reference in bibtex:\n\n```bibtex\n@misc{traversecrafthq2024,\n author = {Srajan Chourasia, Varun Patrikar},\n title = {Traverse Craft: A Cross-Platform Simulation Tool},\n year = {2024},\n url = {https://github.com/srajan-kiyotaka/TraverseCraft},\n note = {Version 1.0.0},\n publisher = {Traverse Craft Team},\n}\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "A Cross-Platform Real-Time Algorithm Simulation Tool",
"version": "1.0.3",
"project_urls": {
"Documentation": "https://harrionparrix.github.io/traversecraft/user-guide/index.html",
"Homepage": "https://harrionparrix.github.io/traversecraft/",
"Reference": "https://harrionparrix.github.io/traversecraft/references/world/World.html",
"Source": "https://github.com/srajan-kiyotaka/TraverseCraft/tree/main",
"Tracker": "https://github.com/srajan-kiyotaka/TraverseCraft/issues"
},
"split_keywords": [
"algorithms",
" simulation",
" real-time",
" tkinter",
" education",
" research",
" visualization",
" machine learning",
" reinforcement learning",
" artificial intelligence",
" agent-based modeling",
" cross-platform",
" dynamic heatmap",
" world generation",
" customizable",
" interactive",
" framework",
" algorithm visualization",
" graph traversal",
" tree traversal",
" grid world"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4f9484f4afc61fafe3619065dcc11eccd1f91bc45f2bef5e388e25f1031d1ea7",
"md5": "99571903a45aa10bfa2318aca64a5a85",
"sha256": "df9232935c83dd4f276b0cd4a4771f5dbbfa5459e64a39b5bc8878638158fc30"
},
"downloads": -1,
"filename": "TraverseCraft-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "99571903a45aa10bfa2318aca64a5a85",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 3548811,
"upload_time": "2024-06-27T19:34:37",
"upload_time_iso_8601": "2024-06-27T19:34:37.456231Z",
"url": "https://files.pythonhosted.org/packages/4f/94/84f4afc61fafe3619065dcc11eccd1f91bc45f2bef5e388e25f1031d1ea7/TraverseCraft-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e426580bbf566f65bf965f51d4cdf3b2b039eec1de527eb47e6587c7c5d78aaf",
"md5": "b81c401b918369c3748e01a10e31b08a",
"sha256": "dfefd8129e65fd677172dba92c384c0f846cebd04df0ea23544d88fe7f4c9453"
},
"downloads": -1,
"filename": "traversecraft-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "b81c401b918369c3748e01a10e31b08a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 3444585,
"upload_time": "2024-06-27T19:34:53",
"upload_time_iso_8601": "2024-06-27T19:34:53.034968Z",
"url": "https://files.pythonhosted.org/packages/e4/26/580bbf566f65bf965f51d4cdf3b2b039eec1de527eb47e6587c7c5d78aaf/traversecraft-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-27 19:34:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "srajan-kiyotaka",
"github_project": "TraverseCraft",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "traversecraft"
}
JSON
