Merge pull request #78 from srajan-kiyotaka/sracho

Preparing for release!

.gitignore

@@ -13,3 +13,4 @@ build
 dist
 *.egg-info
 *.in
+Docker

CITATION.cff

@@ -0,0 +1,15 @@
+cff-version: 1.0.0
+message: "If you use this software, please cite it as below."
+authors:
+  - family-names: "Chourasia"
+    given-names: "Srajan"
+    orcid: "https://orcid.org/0009-0000-1440-3554"
+  - family-names: "Patrikar"
+    given-names: "Varun"
+    # orcid: "https://orcid.org/0000-0001-2345-6789" # Replace with actual ORCID if available
+title: "Traverse Craft: A Cross-Platform Simulation Tool"
+version: "1.0.0"
+date-released: "2024-06-27"
+url: "https://github.com/srajan-kiyotaka/TraverseCraft"
+abstract: "TraverseCraft is a versatile, cross-platform library written in Python for creating static, animated, and interactive visualizations. Designed as a robust simulation tool, 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)."
+keywords: ["simulation", "visualization", "Algorithm", "AI", "ML", "RL"]

README.md

@@ -1,5 +1,5 @@
 <picture align="center">
-  <img alt="Traverse Craft Logo" src="src/traverseCraft/icons/logo/traverseCraftLandscapeLogo.png">
+  <img alt="Traverse Craft Logo" src="https://github.com/srajan-kiyotaka/TraverseCraft/blob/main/src/traverseCraft/icons/logo/traverseCraftLandscapeLogo.png">
 </picture>
 
 <!-- ![Build Status](https://github.com/srajan-kiyotaka/TraverseCraft/blob/main/.github/workflows/python-app.yml/badge.svg) -->
@@ -125,20 +125,25 @@ You can manually set up the development environment using the following steps:
 
 To set up a development environment using Docker, follow these steps:
 
-1. Build the Docker image:
+1. Pull the Docker image from Docker Hub:
 
 ```sh
-  docker build -t traverse-craft:latest .
+  docker pull your-username/traversecraf-dev:latest
 ```
 
 2. Run the Docker container:
 
 ```sh
-  docker run -it --rm traverse-craft:latest
+  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).

setup.py

@@ -5,20 +5,20 @@
 
 setup(
     name='TraverseCraft',
-    version='1.1.0',
+    version='1.2.1',
     author='Srajan Chourasia, Varun Patrikar',
     author_email='[email protected], [email protected]',
-    maintainer='Srajan Chourasia, Varun Patrikar',
-    maintainer_email='srajanstark.ash@gmail.com, patrikarvarun@gmail.com',
-    description='TraverseCraft: Cross-Platform Real-Time Algorithm Simulation Tool',
+    maintainer='Varun Patrikar, Srajan Chourasia',
+    maintainer_email='patrikarvarun@gmail.com, srajanstark.ash@gmail.com',
+    description='A Cross-Platform Real-Time Algorithm Simulation Tool',
     long_description=long_description,
     long_description_content_type='text/markdown',
-    url='https://official-website.com',  # Official website
+    url='https://harrionparrix.github.io/traversecraft/',  # Official website
     project_urls={
-        'Documentation': 'https://docs.traverseCraft.com',
+        'Documentation': 'https://harrionparrix.github.io/traversecraft/user-guide/index.html',
         'Source': 'https://github.com/srajan-kiyotaka/TraverseCraft/tree/main',
-        'Tracker': 'https://github.com/srajan-kiyotaka/TraverseCraft/tree/main/issues',
-        'Reference': 'https://reference.traverseCraft.com',
+        'Tracker': 'https://github.com/srajan-kiyotaka/TraverseCraft/issues',
+        'Reference': 'https://harrionparrix.github.io/traversecraft/references/world/World.html',
     },
     package_dir={'': 'src'},
     packages=find_packages(where='src'),
@@ -28,7 +28,7 @@
         'prettytable',
     ],
     classifiers=[
-        'Development Status :: 4 - Beta',
+        'Development Status :: 5 - Production/Stable',
         'Intended Audience :: Developers',
         'Intended Audience :: Education',
         'License :: OSI Approved :: MIT License',

tutorials/Graph World/advance.ipynb

@@ -67,7 +67,7 @@
     "# Graph World\n",
     "Let's start with creating a Graph world using the image below. But this time we will not use the default settings and will customize our world.\n",
     "\n",
-    "<img src='../../resources/Graph_Advance.png' alt='Tree Abstract View' height=500>\n",
+    "<img src='https://github.com/srajan-kiyotaka/TraverseCraft/blob/main/resources/Graph_Advance.png' alt='Tree Abstract View' height=500>\n",
     "\n",
     "## World Information\n",
     "Before creating the Graph World we have to first create the world blueprint/template. We call this blueprint/template as *world information*. This is like a abstract view of your world.\n",

tutorials/Graph World/beginner.ipynb

@@ -69,7 +69,7 @@
     "\n",
     "We will create a simple Graph as shown below with the default settings on.\n",
     "\n",
-    "<img src='../../resources/Graph_Beginning.png' alt='Graph Abstract View' height=500>\n",
+    "<img src='https://github.com/srajan-kiyotaka/TraverseCraft/blob/main/resources/Graph_Beginning.png' alt='Graph Abstract View' height=500>\n",
     "\n",
     "## World Information\n",
     "Before creating the Graph World we have to first create the world blueprint/template. We call this blueprint/template as *world information*. This is like a abstract view of your world.\n",

tutorials/Tree World/advance.ipynb

@@ -133,7 +133,7 @@
     "# Create a Tree World\n",
     "Let's start with creating a Tree world using the image below. But this time we will not use the default settings and will customize our world.\n",
     "\n",
-    "<img src='../../resources/Tree_Advance.png' alt='Tree Abstract View' height=500>\n",
+    "<img src='https://github.com/srajan-kiyotaka/TraverseCraft/blob/main/resources/Tree_Advance.png' alt='Tree Abstract View' height=500>\n",
     "\n",
     "We will make the following changes:\n",
     "- `radius`: Controls the size of each node of the tree.\n",