fixed main.py problems and added command line arguments

Author: BenSDuggan

README.md

@@ -2,12 +2,25 @@
 CSCI-B 351 final project with the goal of making an AI to solve a 2x2 cube and possibly scaling up to higher order cubes.  The AI algorithms used are BFS, Better BFS (limit moves), A\*, IDA\*, and Mini (a minimizing version of MiniMax).  There are 3 heuristics implimented: simpleHeuristic, hammingDistance and manhattanDistance.  There is a GUI which shows a 2D and 3D cube inaddition to the move states and allows for people to try to solve the cube in an easy way.
 
 # How to run:
-First make sure you have pygames installed by running `pip install pygames`.  The simplest way to run the code is by running `python main.py`.  The console will then walk you through the options.  Additionally you can use command line arguments.  The first argument is the size of the cube n (nxn), then the scramble length, next the AI algorithm (bfs, bbfs, a\*, ida\*, mini) and finally the heuristic ((s)impleHeuristic, (h)ammingDistance, (m)anhattanCube).
+First make sure you have pygames installed by running `pip install pygames`.  The simplest way to run the code is by running `python main.py`.  To view the command line arguments type `python main.py -h`.  This will show the help page which is shown below:
+```
+CubeAI
+CSCI-B 351 final project with the goal of making an AI to solve a 2x2 cube and possibly scaling up to higher order cubes. The AI algorithms used are BFS, Better BFS (limit moves), A*, IDA*, and Mini (a minimizing version of MiniMax). There are 3 heuristics implimented: simpleHeuristic, hammingDistance and manhattanDistance. 
+
+optional arguments:
+  -h, --help  show this help message and exit
+  --m False   Run manually (start gui) or run the AI first
+  --n 2       The dimension of the cube (nxn)
+  --s 5       How many times to scramble the cube
+  --a ida*    Which AI algorithm to use: (bfs), (bbfs), (a*), (ida*), (mini)
+  --h m       Which heuristic to use: (s)impleHeuristic, (h)ammingDistance, (m)anhattanDistance.
+```
+
 
 # Example images:
-![3D 2x2 GUI](/project_files/images/3d_2x2.png)
+![3D 2x2 GUI](/docs/images/3d_2x2.png)
 3D 2X2 cube in GUI
-![2D 2x2 GUI](/project_files/images/2d_2x2.png)
+![2D 2x2 GUI](/docs/images/2d_2x2.png)
 2D 2x2 cube in GUI
 
 # Documentation:

docs/2d_2x2.png

@@ -1,10 +1,10 @@
 '''
     Team 4 - Ben Duggan & Connor Altic
-    12/10/18
+    8/17/19
     Class with main gui class
 '''
 
-import time
+import time, argparse
 from main_gui import *
 from AIs import *
 from Heuristic import *
@@ -79,40 +79,23 @@ def ai(type, n, scramble_length, heuristic):
 if __name__ == '__main__':
     # Ask the user what they want to run and run it for them
 
-    #x,n,scramble,heuristic = 'ida*',2,12,Heuristic.manhattanDistance
-    x,n,scramble,heuristic = None,None,None,None
-    if len(sys.argv) >= 2:
-        x = sys.argv[1]
-    if len(sys.argv) >= 3:
-        n = int(sys.argv[2])
-    if len(sys.argv) >= 4:
-        scramble = int(sys.argv[3])
-    if len(sys.argv) >= 5:
-        if sys.argv[4] == 's':
-            heuristic = Heuristic.simpleHeuristic
-        elif sys.argv[4] == 'h':
-            heuristic = Heuristic.hammingDistance
-        else:
-            heuristic = Heuristic.manhattanDistance
-    elif x == None or n == None:
-        print("(h)uman (gui) | (bfs), (bbfs), (a*), (ida*), (mini)")
-        x = input()
-        print("what nxn (just n)?")
-        n = int(input())
-        print("what scramble length?")
-        scramble = int(input())
-        print("What heuristic? (s)impleHeuristic, (h)ammingDistance, (m)anhattanDistance")
-        h = input()
-        if h == 's':
-            heuristic = Heuristic.simpleHeuristic
-        elif h == 'h':
-            heuristic = Heuristic.hammingDistance
-        else:
-            heuristic = Heuristic.manhattanDistance
+    parser = argparse.ArgumentParser(description='CubeAI\nCSCI-B 351 final project with the goal of making an AI to solve a 2x2 cube and possibly scaling up to higher order cubes. The AI algorithms used are BFS, Better BFS (limit moves), A*, IDA*, and Mini (a minimizing version of MiniMax). There are 3 heuristics implimented: simpleHeuristic, hammingDistance and manhattanDistance. ', formatter_class=argparse.RawTextHelpFormatter)
+    parser.add_argument('--m', metavar='False', default=False, type=bool, action='store', help='Run manually (start gui) or run the AI first')
+    parser.add_argument('--n', metavar='2', default=2, type=int, action='store', help='The dimension of the cube (nxn)')
+    parser.add_argument('--s', metavar='5', default=5, type=int, action='store', help='How many times to scramble the cube')
+    parser.add_argument('--a', metavar='ida*', default='ida*', type=str, action='store', help='Which AI algorithm to use: (bfs), (bbfs), (a*), (ida*), (mini)')
+    parser.add_argument('--h', metavar='m', default='m', type=str, action='store', help='Which heuristic to use: (s)impleHeuristic, (h)ammingDistance, (m)anhattanDistance.')
 
-    assert type(x) == type('a') and type(n) == type(1) and type(scramble) == type(1)
+    args = parser.parse_args()
 
-    if x == 'h':
-        gui(n, scramble)
+    if args.h == 's':
+        heuristic = Heuristic.simpleHeuristic
+    elif args.h == 'h':
+        heuristic = Heuristic.hammingDistance
     else:
-        ai(x, n, scramble, heuristic)
+        heuristic = Heuristic.manhattanDistance
+
+    if args.m:
+        gui(args.n, args.s)
+    else:
+        ai(args.a, args.n, args.s, heuristic)