Major work on the command line tool. Version check on the new website.

FlatCAMApp.py

@@ -44,10 +44,13 @@ class App(QtCore.QObject):
     log.addHandler(handler)
 
     ## URL for update checks
-    version_url = "http://caram.cl/flatcam/VERSION"
+    version_url = "http://flatcam.org/FlatCAM/apptalk/version"
 
     ## App URL
-    app_url = "http://caram.cl/software/flatcam"
+    app_url = "http://flatcam.org"
+
+    ## Manual URL
+    manual_url = "http://flatcam.org/manual/static/index.html"
 
     ## Signals
     inform = QtCore.pyqtSignal(str)  # Message
@@ -132,6 +135,8 @@ class App(QtCore.QObject):
         self.defaults = LoudDict()
         self.defaults.set_change_callback(lambda key: self.defaults_write_form())  # When the dictionary changes.
         self.defaults.update({
+            "serial": 0,
+            "stats": {},
             "units": "IN",
             "gerber_plot": True,
             "gerber_solid": True,
@@ -166,6 +171,11 @@ class App(QtCore.QObject):
         })
         self.load_defaults()
 
+        chars = 'abcdefghijklmnopqrstuvwxyz0123456789'
+        if self.defaults['serial'] == 0:
+            self.defaults['serial'] = ''.join([random.choice(chars) for i in range(20)])
+            self.save_defaults()
+
         self.options_form = GlobalOptionsUI()
         self.options_form_fields = {
             "units": self.options_form.units_radio,
@@ -298,7 +308,8 @@ class App(QtCore.QObject):
         self.ui.menuviewenable.triggered.connect(self.enable_all_plots)
         self.ui.menutoolshell.triggered.connect(lambda: self.shell.show())
         self.ui.menuhelp_about.triggered.connect(self.on_about)
-        self.ui.menuhelp_manual.triggered.connect(lambda: webbrowser.open(self.app_url))
+        self.ui.menuhelp_home.triggered.connect(lambda: webbrowser.open(self.app_url))
+        self.ui.menuhelp_manual.triggered.connect(lambda: webbrowser.open(self.manual_url))
         # Toolbar
         self.ui.zoom_fit_btn.triggered.connect(self.on_zoom_fit)
         self.ui.zoom_in_btn.triggered.connect(lambda: self.plotcanvas.zoom(1.5))
@@ -354,7 +365,9 @@ class App(QtCore.QObject):
             try:
                 self.defaults_form_fields[option].set_value(self.defaults[option])
             except KeyError:
-                self.log.error("defaults_write_form(): No field for: %s" % option)
+                #self.log.debug("defaults_write_form(): No field for: %s" % option)
+                # TODO: Rethink this?
+                pass
 
     def disable_plots(self, except_current=False):
         """
@@ -387,9 +400,9 @@ class App(QtCore.QObject):
         # Send to worker
         self.worker_task.emit({'fcn': worker_task, 'params': [self]})
 
-    def execCommand(self, text):
+    def exec_command(self, text):
         """
-        Hadles input from the shell.
+        Hadles input from the shell. See FlatCAMApp.setup_shell for shell commands.
 
         :param text: Input command
         :return: None
@@ -404,60 +417,9 @@ class App(QtCore.QObject):
             raise
         return
 
-        def shhelp(p=None):
-            if not p:
-                return "Available commands:\n" + '\n'.join(['  ' + cmd for cmd in commands])
-
-            if p not in commands:
-                return "Unknown command: %s" % p
-
-            return commands[p]["help"]
-
-
-        commands = {
-            "open_gerber": {
-                "fcn": self.open_gerber,
-                "params": 1,
-                "converters": [lambda x: x],
-                "retfcn": lambda x: None,
-                "help": "Opens a Gerber file.\n> open_gerber <filename>\n   filename: Path to file to open."
-            },
-            "open_excellon": {
-                "fcn": self.open_excellon,
-                "params": 1,
-                "converters": [lambda x: x],
-                "retfcn": lambda x: None,
-                "help": "Opens an Excellon file.\n> open_excellon <filename>\n   filename: Path to file to open."
-            },
-            "open_gcode": {
-                "fcn": self.open_gcode,
-                "params": 1,
-                "converters": [lambda x: x],
-                "retfcn": lambda x: None,
-                "help": "Opens an G-Code file.\n> open_gcode <filename>\n   filename: Path to file to open."
-            },
-            "open_project": {
-                "fcn": self.open_project,
-                "params": 1,
-                "converters": [lambda x: x],
-                "retfcn": lambda x: None,
-                "help": "Opens a FlatCAM project.\n> open_project <filename>\n   filename: Path to file to open."
-            },
-            "save_project": {
-                "fcn": self.save_project,
-                "params": 1,
-                "converters": [lambda x: x],
-                "retfcn": lambda x: None,
-                "help": "Saves the FlatCAM project to file.\n> save_project <filename>\n   filename: Path to file to save."
-            },
-            "help": {
-                "fcn": shhelp,
-                "params": [0, 1],
-                "converters": [lambda x: x],
-                "retfcn": lambda x: x,
-                "help": "Shows list of commands."
-            }
-        }
+        """
+        Code below is unsused. Saved for later.
+        """
 
         parts = re.findall(r'([\w\\:\.]+|".*?")+', text)
         parts = [p.replace('\n', '').replace('"', '') for p in parts]
@@ -690,6 +652,9 @@ class App(QtCore.QObject):
         :return: None
         """
 
+        self.save_defaults()
+
+    def save_defaults(self):
         # Read options from file
         try:
             f = open("defaults.json")
@@ -1257,13 +1222,16 @@ class App(QtCore.QObject):
         else:
             self.inform.emit("Project copy saved to: " + self.project_filename)
 
-    def open_gerber(self, filename):
+    def open_gerber(self, filename, follow=False, outname=None):
         """
         Opens a Gerber file, parses it and creates a new object for
         it in the program. Thread-safe.
 
         :param filename: Gerber file filename
         :type filename: str
+        :param follow: If true, the parser will not create polygons, just lines
+            following the gerber path.
+        :type follow: bool
         :return: None
         """
 
@@ -1277,13 +1245,13 @@ class App(QtCore.QObject):
 
             # Opening the file happens here
             self.progress.emit(30)
-            gerber_obj.parse_file(filename)
+            gerber_obj.parse_file(filename, follow=follow)
 
             # Further parsing
             self.progress.emit(70)
 
         # Object name
-        name = filename.split('/')[-1].split('\\')[-1]
+        name = outname or filename.split('/')[-1].split('\\')[-1]
 
         self.new_object("gerber", name, obj_init)
 
@@ -1310,7 +1278,7 @@ class App(QtCore.QObject):
         # GUI feedback
         self.inform.emit("Opened: " + filename)
 
-    def open_excellon(self, filename):
+    def open_excellon(self, filename, outname=None):
         """
         Opens an Excellon file, parses it and creates a new object for
         it in the program. Thread-safe.
@@ -1332,7 +1300,7 @@ class App(QtCore.QObject):
             self.progress.emit(70)
 
         # Object name
-        name = filename.split('/')[-1].split('\\')[-1]
+        name = outname or filename.split('/')[-1].split('\\')[-1]
 
         self.new_object("excellon", name, obj_init)
         # New object creation and file processing
@@ -1356,7 +1324,7 @@ class App(QtCore.QObject):
         self.inform.emit("Opened: " + filename)
         self.progress.emit(100)
 
-    def open_gcode(self, filename):
+    def open_gcode(self, filename, outname=None):
         """
         Opens a G-gcode file, parses it and creates a new object for
         it in the program. Thread-safe.
@@ -1389,7 +1357,7 @@ class App(QtCore.QObject):
             job_obj.create_geometry()
 
         # Object name
-        name = filename.split('/')[-1].split('\\')[-1]
+        name = outname or filename.split('/')[-1].split('\\')[-1]
 
         # New object creation and file processing
         try:
@@ -1503,12 +1471,18 @@ class App(QtCore.QObject):
         self.ui.progress_bar.setValue(int(percentage))
 
     def setup_shell(self):
+        """
+        Creates shell functions.
+
+        :return: None
+        """
+
         self.log.debug("setup_shell()")
 
         def shelp(p=None):
             if not p:
                 return "Available commands:\n" + '\n'.join(['  ' + cmd for cmd in commands]) + \
-                "\n\nType help <command_name> for usage.\n Example: help open_gerber"
+                       "\n\nType help <command_name> for usage.\n Example: help open_gerber"
 
             if p not in commands:
                 return "Unknown command: %s" % p
@@ -1519,11 +1493,252 @@ class App(QtCore.QObject):
             ops = self.collection.get_by_name(str(name)).options
             return '\n'.join(["%s: %s" % (o, ops[o]) for o in ops])
 
-        def isolate(name, dia=None, passes=None, overlap=None):
-            dia = float(dia) if dia is not None else None
-            passes = int(passes) if passes is not None else None
-            overlap = float(overlap) if overlap is not None else None
-            self.collection.get_by_name(str(name)).isolate(dia, passes, overlap)
+        def h(*args):
+            """
+            Pre-processes arguments to detect '-keyword value' pairs into dictionary
+            and standalone parameters into list.
+            """
+
+            kwa = {}
+            a = []
+            n = len(args)
+            name = None
+            for i in range(n):
+                match = re.search(r'^-([a-zA-Z].*)', args[i])
+                if match:
+                    assert name is None
+                    name = match.group(1)
+                    continue
+
+                if name is None:
+                    a.append(args[i])
+                else:
+                    kwa[name] = args[i]
+                    name = None
+
+            return a, kwa
+
+        def open_gerber(filename, *args):
+            a, kwa = h(*args)
+            types = {'follow': bool,
+                     'outname': str}
+
+            for key in kwa:
+                if key not in types:
+                    return 'Unknown parameter: %s' % key
+                kwa[key] = types[key](kwa[key])
+
+            self.open_gerber(str(filename), **kwa)
+
+        def open_excellon(filename, *args):
+            a, kwa = h(*args)
+            types = {'outname': str}
+
+            for key in kwa:
+                if key not in types:
+                    return 'Unknown parameter: %s' % key
+                kwa[key] = types[key](kwa[key])
+
+            self.open_excellon(str(filename), **kwa)
+
+        def open_gcode(filename, *args):
+            a, kwa = h(*args)
+            types = {'outname': str}
+
+            for key in kwa:
+                if key not in types:
+                    return 'Unknown parameter: %s' % key
+                kwa[key] = types[key](kwa[key])
+
+            self.open_gcode(str(filename), **kwa)
+
+        def isolate(name, *args):
+            a, kwa = h(*args)
+            types = {'dia': float,
+                     'passes': int,
+                     'overlap': float,
+                     'outname': str}
+
+            for key in kwa:
+                if key not in types:
+                    return 'Unknown parameter: %s' % key
+                kwa[key] = types[key](kwa[key])
+
+            try:
+                obj = self.collection.get_by_name(str(name))
+            except:
+                return "Could not retrieve object: %s" % name
+
+            if obj is None:
+                return "Object not found: %s" % name
+
+            try:
+                obj.isolate(**kwa)
+            except Exception, e:
+                return "Operation failed: %s" % str(e)
+
+            return 'Ok'
+
+        def cncjob(obj_name, *args):
+            a, kwa = h(*args)
+
+            types = {'z_cut': float,
+                     'z_move': float,
+                     'feedrate': float,
+                     'tooldia': float,
+                     'outname': str}
+
+            for key in kwa:
+                if key not in types:
+                    return 'Unknown parameter: %s' % key
+                kwa[key] = types[key](kwa[key])
+
+            try:
+                obj = self.collection.get_by_name(str(obj_name))
+            except:
+                return "Could not retrieve object: %s" % obj_name
+            if obj is None:
+                return "Object not found: %s" % obj_name
+
+            try:
+                obj.generatecncjob(**kwa)
+            except Exception, e:
+                return "Operation failed: %s" % str(e)
+
+            return 'Ok'
+
+        def write_gcode(obj_name, filename, preamble='', postamble=''):
+            try:
+                obj = self.collection.get_by_name(str(obj_name))
+            except:
+                return "Could not retrieve object: %s" % obj_name
+            if obj is None:
+                return "Object not found: %s" % obj_name
+            obj.export_gcode(str(filename), str(preamble), str(postamble))
+
+        def paint_poly(obj_name, inside_pt_x, inside_pt_y, tooldia, overlap):
+            try:
+                obj = self.collection.get_by_name(str(obj_name))
+            except:
+                return "Could not retrieve object: %s" % obj_name
+            if obj is None:
+                return "Object not found: %s" % obj_name
+            obj.paint_poly([float(inside_pt_x), float(inside_pt_y)], float(tooldia), float(overlap))
+
+        def add_poly(obj_name, *args):
+            if len(args) % 2 != 0:
+                return "Incomplete coordinate."
+
+            points = [[float(args[2*i]), float(args[2*i+1])] for i in range(len(args)/2)]
+
+            try:
+                obj = self.collection.get_by_name(str(obj_name))
+            except:
+                return "Could not retrieve object: %s" % obj_name
+            if obj is None:
+                return "Object not found: %s" % obj_name
+
+            obj.add_polygon(points)
+
+        def add_rectangle(obj_name, botleft_x, botleft_y, topright_x, topright_y):
+            return add_poly(obj_name, botleft_x, botleft_y, botleft_x, topright_y,
+                            topright_x, topright_y, topright_x, botleft_y)
+
+        def add_circle(obj_name, center_x, center_y, radius):
+            try:
+                obj = self.collection.get_by_name(str(obj_name))
+            except:
+                return "Could not retrieve object: %s" % obj_name
+            if obj is None:
+                return "Object not found: %s" % obj_name
+
+            obj.add_circle([float(center_x), float(center_y)], float(radius))
+
+        def set_active(obj_name):
+            try:
+                self.collection.set_active(str(obj_name))
+            except Exception, e:
+                return "Command failed: %s" % str(e)
+
+        def delete(obj_name):
+            try:
+                self.collection.set_active(str(obj_name))
+                self.on_delete()
+            except Exception, e:
+                return "Command failed: %s" % str(e)
+
+        def geo_union(obj_name):
+
+            try:
+                obj = self.collection.get_by_name(str(obj_name))
+            except:
+                return "Could not retrieve object: %s" % obj_name
+            if obj is None:
+                return "Object not found: %s" % obj_name
+
+            obj.union()
+
+        def make_docs():
+            output = ''
+            import collections
+            od = collections.OrderedDict(sorted(commands.items()))
+            for cmd, val in od.iteritems():
+                #print cmd, '\n', ''.join(['~']*len(cmd))
+                output += cmd + ' \n' + ''.join(['~']*len(cmd)) + '\n'
+
+                t = val['help']
+                usage_i = t.find('>')
+                if usage_i < 0:
+                    expl = t
+                    #print expl + '\n'
+                    output += expl + '\n\n'
+                    continue
+
+                expl = t[:usage_i-1]
+                #print expl + '\n'
+                output += expl + '\n\n'
+
+                end_usage_i = t[usage_i:].find('\n')
+
+                if end_usage_i < 0:
+                    end_usage_i = len(t[usage_i:])
+                    #print '    ' + t[usage_i:]
+                    #print '       No parameters.\n'
+                    output += '    ' + t[usage_i:] + '\n       No parameters.\n'
+                else:
+                    extras = t[usage_i+end_usage_i+1:]
+                    parts = [s.strip() for s in extras.split('\n')]
+
+
+                    #print '    ' + t[usage_i:usage_i+end_usage_i]
+                    output += '    ' + t[usage_i:usage_i+end_usage_i] + '\n'
+                    for p in parts:
+                        #print '       ' + p + '\n'
+                        output += '       ' + p + '\n\n'
+
+            return output
+
+        def follow(obj_name, *args):
+            a, kwa = h(*args)
+
+            types = {'outname': str}
+
+            for key in kwa:
+                if key not in types:
+                    return 'Unknown parameter: %s' % key
+                kwa[key] = types[key](kwa[key])
+
+            try:
+                obj = self.collection.get_by_name(str(obj_name))
+            except:
+                return "Could not retrieve object: %s" % obj_name
+            if obj is None:
+                return "Object not found: %s" % obj_name
+
+            try:
+                obj.follow(**kwa)
+            except Exception, e:
+                return "ERROR: %s" % str(e)
 
         commands = {
             'help': {
@@ -1531,16 +1746,26 @@ class App(QtCore.QObject):
                 'help': "Shows list of commands."
             },
             'open_gerber': {
-                'fcn': self.open_gerber,
-                'help': "Opens a Gerber file.\n> open_gerber <filename>\n   filename: Path to file to open."
+                'fcn': open_gerber,
+                'help': "Opens a Gerber file.\n' +"
+                        "> open_gerber <filename> [-follow <0|1>] [-outname <o>]\n' +"
+                        "   filename: Path to file to open.\n" +
+                        "   follow: If 1, does not create polygons, just follows the gerber path.\n" +
+                        "   outname: Name of the created gerber object."
             },
             'open_excellon': {
-                'fcn': self.open_excellon,
-                'help': "Opens an Excellon file.\n> open_excellon <filename>\n   filename: Path to file to open."
+                'fcn': open_excellon,
+                'help': "Opens an Excellon file.\n" +
+                        "> open_excellon <filename> [-outname <o>]\n" +
+                        "   filename: Path to file to open.\n" +
+                        "   outname: Name of the created excellon object."
             },
             'open_gcode': {
-                'fcn': self.open_gcode,
-                'help': "Opens an G-Code file.\n> open_gcode <filename>\n   filename: Path to file to open."
+                'fcn': open_gcode,
+                'help': "Opens an G-Code file.\n" +
+                        "> open_gcode <filename> [-outname <o>]\n" +
+                        "   filename: Path to file to open.\n" +
+                        "   outname: Name of the created CNC Job object."
             },
             'open_project': {
                 'fcn': self.open_project,
@@ -1551,7 +1776,7 @@ class App(QtCore.QObject):
                 'help': "Saves the FlatCAM project to file.\n> save_project <filename>\n   filename: Path to file to save."
             },
             'set_active': {
-                'fcn': self.collection.set_active,
+                'fcn': set_active,
                 'help': "Sets a FlatCAM object as active.\n > set_active <name>\n   name: Name of the object."
             },
             'get_names': {
@@ -1569,8 +1794,8 @@ class App(QtCore.QObject):
             'isolate': {
                 'fcn': isolate,
                 'help': "Creates isolation routing geometry for the given Gerber.\n" +
-                        "> isolate <name> [dia [passes [overlap]]]\n" +
-                        "   name: Name if the object\n"
+                        "> isolate <name> [-dia <d>] [-passes <p>] [-overlap <o>]\n" +
+                        "   name: Name of the object\n"
                         "   dia: Tool diameter\n   passes: # of tool width\n" +
                         "   overlap: Fraction of tool diameter to overlap passes"
             },
@@ -1591,12 +1816,96 @@ class App(QtCore.QObject):
             'plot': {
                 'fcn': self.plot_all,
                 'help': 'Updates the plot on the user interface'
+            },
+            'cncjob': {
+                'fcn': cncjob,
+                'help': 'Generates a CNC Job from a Geometry Object.\n' +
+                        '> cncjob <name> [-z_cut <c>] [-z_move <m>] [-feedrate <f>] [-tooldia <t>] [-outname <n>]\n' +
+                        '   name: Name of the source object\n' +
+                        '   z_cut: Z-axis cutting position\n' +
+                        '   z_move: Z-axis moving position\n' +
+                        '   feedrate: Moving speed when cutting\n' +
+                        '   tooldia: Tool diameter to show on screen\n' +
+                        '   outname: Name of the output object'
+            },
+            'write_gcode': {
+                'fcn': write_gcode,
+                'help': 'Saves G-code of a CNC Job object to file.\n' +
+                        '> write_gcode <name> <filename>\n' +
+                        '   name: Source CNC Job object\n' +
+                        '   filename: Output filename'
+            },
+            'paint_poly': {
+                'fcn': paint_poly,
+                'help': 'Creates a geometry object with toolpath to cover the inside of a polygon.\n' +
+                        '> paint_poly <name> <inside_pt_x> <inside_pt_y> <tooldia> <overlap>\n' +
+                        '   name: Name of the sourge geometry object.\n' +
+                        '   inside_pt_x, inside_pt_y: Coordinates of a point inside the polygon.\n' +
+                        '   tooldia: Diameter of the tool to be used.\n' +
+                        '   overlap: Fraction of the tool diameter to overlap cuts.'
+            },
+            'new_geometry': {
+                'fcn': lambda name: self.new_object('geometry', str(name), lambda x, y: None),
+                'help': 'Creates a new empty geometry object.\n' +
+                        '> new_geometry <name>\n' +
+                        '   name: New object name'
+            },
+            'add_poly': {
+                'fcn': add_poly,
+                'help': 'Creates a polygon in the given Geometry object.\n' +
+                        '> create_poly <name> <x0> <y0> <x1> <y1> <x2> <y2> [x3 y3 [...]]\n' +
+                        '   name: Name of the geometry object to which to append the polygon.\n' +
+                        '   xi, yi: Coordinates of points in the polygon.'
+            },
+            'delete': {
+                'fcn': delete,
+                'help': 'Deletes the give object.\n' +
+                        '> delete <name>\n' +
+                        '   name: Name of the object to delete.'
+            },
+            'geo_union': {
+                'fcn': geo_union,
+                'help': 'Runs a union operation (addition) on the components ' +
+                        'of the geometry object. For example, if it contains ' +
+                        '2 intersecting polygons, this opperation adds them into' +
+                        'a single larger polygon.\n' +
+                        '> geo_union <name>\n' +
+                        '   name: Name of the geometry object.'
+            },
+            'add_rect': {
+                'fcn': add_rectangle,
+                'help': 'Creates a rectange in the given Geometry object.\n' +
+                        '> add_rect <name> <botleft_x> <botleft_y> <topright_x> <topright_y>\n' +
+                        '   name: Name of the geometry object to which to append the rectangle.\n' +
+                        '   botleft_x, botleft_y: Coordinates of the bottom left corner.\n' +
+                        '   topright_x, topright_y Coordinates of the top right corner.'
+            },
+            'add_circle': {
+                'fcn': add_circle,
+                'help': 'Creates a circle in the given Geometry object.\n' +
+                        '> add_circle <name> <center_x> <center_y> <radius>\n' +
+                        '   name: Name of the geometry object to which to append the circle.\n' +
+                        '   center_x, center_y: Coordinates of the center of the circle.\n' +
+                        '   radius: Radius of the circle.'
+            },
+            'make_docs': {
+                'fcn': make_docs,
+                'help': 'Prints command rererence in reStructuredText format.'
+            },
+            'follow': {
+                'fcn': follow,
+                'help': 'Creates a geometry object following gerber paths.\n' +
+                        '> follow <name> [-outname <oname>]\n' +
+                        '   name: Name of the gerber object.\n' +
+                        '   outname: Name of the output geometry object.'
             }
         }
 
+        # Add commands to the tcl interpreter
         for cmd in commands:
             self.tcl.createcommand(cmd, commands[cmd]['fcn'])
 
+        # Make the tcl puts function return instead of print to stdout
         self.tcl.eval('''
             rename puts original_puts
             proc puts {args} {
@@ -1608,8 +1917,6 @@ class App(QtCore.QObject):
             }
             ''')
 
-
-
     def setup_recent_items(self):
         self.log.debug("setup_recent_items()")
 
@@ -1693,9 +2000,11 @@ class App(QtCore.QObject):
         """
 
         self.log.debug("version_check()")
+        full_url = App.version_url + "?s=" + str(self.defaults['serial']) + "&v=" + str(self.version)
+        App.log.debug("Checking for updates @ %s" % full_url)
 
         try:
-            f = urllib.urlopen(App.version_url)
+            f = urllib.urlopen(full_url)
         except:
             App.log.warning("Failed checking for latest version. Could not connect.")
             self.inform.emit("Failed checking for latest version. Could not connect.")
@@ -1703,9 +2012,10 @@ class App(QtCore.QObject):
 
         try:
             data = json.load(f)
-        except:
+        except Exception, e:
             App.log.error("Could not parse information about latest version.")
             self.inform.emit("Could not parse information about latest version.")
+            App.log.debug("json.load(): %s" % str(e))
             f.close()
             return
 

FlatCAMGUI.py

@@ -93,6 +93,7 @@ class FlatCAMGUI(QtGui.QMainWindow):
         ### Help ###
         self.menuhelp = self.menu.addMenu('&Help')
         self.menuhelp_about = self.menuhelp.addAction(QtGui.QIcon('share/tv16.png'), 'About FlatCAM')
+        self.menuhelp_home = self.menuhelp.addAction(QtGui.QIcon('share/home16.png'), 'Home')
         self.menuhelp_manual = self.menuhelp.addAction(QtGui.QIcon('share/globe16.png'), 'Manual')
 
         ###############

FlatCAMObj.py

@@ -390,15 +390,36 @@ class FlatCAMGerber(FlatCAMObj, Gerber):
         self.read_form()
         self.isolate()
 
-    def isolate(self, dia=None, passes=None, overlap=None):
+    def follow(self, outname=None):
+        """
+        Creates a geometry object "following" the gerber paths.
+
+        :return: None
+        """
+
+        default_name = self.options["name"] + "_follow"
+        follow_name = outname or default_name
+
+        def follow_init(follow_obj, app_obj):
+            # Propagate options
+            follow_obj.options["cnctooldia"] = self.options["isotooldia"]
+            follow_obj.solid_geometry = self.solid_geometry
+            app_obj.info("Follow geometry created: %s" % follow_obj.options["name"])
+
+        # TODO: Do something if this is None. Offer changing name?
+        self.app.new_object("geometry", follow_name, follow_init)
+
+    def isolate(self, dia=None, passes=None, overlap=None, outname=None):
         """
         Creates an isolation routing geometry object in the project.
 
         :param dia: Tool diameter
         :param passes: Number of tool widths to cut
         :param overlap: Overlap between passes in fraction of tool diameter
+        :param outname: Base name of the output object
         :return: None
         """
+
         if dia is None:
             dia = self.options["isotooldia"]
         if passes is None:
@@ -406,10 +427,16 @@ class FlatCAMGerber(FlatCAMObj, Gerber):
         if overlap is None:
             overlap = self.options["isooverlap"] * dia
 
+        base_name = self.options["name"] + "_iso"
+        base_name = outname or base_name
+
         for i in range(passes):
 
             offset = (2*i + 1)/2.0 * dia - i*overlap
-            iso_name = self.options["name"] + "_iso%d" % (i+1)
+            if passes > 1:
+                iso_name = base_name + str(i+1)
+            else:
+                iso_name = base_name
 
             # TODO: This is ugly. Create way to pass data into init function.
             def iso_init(geo_obj, app_obj):
@@ -778,8 +805,11 @@ class FlatCAMCNCjob(FlatCAMObj, CNCjob):
 
         postamble = str(self.ui.append_text.get_value())
 
+        self.export_gcode(filename, preamble='', postamble=postamble)
+
+    def export_gcode(self, filename, preamble='', postamble=''):
         f = open(filename, 'w')
-        f.write(self.gcode + "\n" + postamble)
+        f.write(preamble + '\n' + self.gcode + "\n" + postamble)
         f.close()
 
         self.app.file_opened.emit("cncjob", filename)
@@ -877,37 +907,49 @@ class FlatCAMGeometry(FlatCAMObj, Geometry):
         def doit(event):
             self.app.plotcanvas.mpl_disconnect(subscription)
             point = [event.xdata, event.ydata]
-            poly = find_polygon(self.solid_geometry, point)
+            self.paint_poly(point, tooldia, overlap)
 
-            # Initializes the new geometry object
-            def gen_paintarea(geo_obj, app_obj):
-                assert isinstance(geo_obj, FlatCAMGeometry)
-                #assert isinstance(app_obj, App)
-                cp = clear_poly(poly.buffer(-self.options["paintmargin"]), tooldia, overlap)
-                geo_obj.solid_geometry = cp
-                geo_obj.options["cnctooldia"] = tooldia
+        subscription = self.app.plotcanvas.mpl_connect('button_press_event', doit)
 
-            name = self.options["name"] + "_paint"
-            self.app.new_object("geometry", name, gen_paintarea)
+    def paint_poly(self, inside_pt, tooldia, overlap):
+        poly = find_polygon(self.solid_geometry, inside_pt)
 
-        subscription = self.app.plotcanvas.mpl_connect('button_press_event', doit)
+        # Initializes the new geometry object
+        def gen_paintarea(geo_obj, app_obj):
+            assert isinstance(geo_obj, FlatCAMGeometry)
+            #assert isinstance(app_obj, App)
+            cp = clear_poly(poly.buffer(-self.options["paintmargin"]), tooldia, overlap)
+            geo_obj.solid_geometry = cp
+            geo_obj.options["cnctooldia"] = tooldia
+
+        name = self.options["name"] + "_paint"
+        self.app.new_object("geometry", name, gen_paintarea)
 
     def on_generatecnc_button_click(self, *args):
         self.read_form()
-        job_name = self.options["name"] + "_cnc"
+        self.generatecncjob()
+
+    def generatecncjob(self, z_cut=None, z_move=None,
+                       feedrate=None, tooldia=None, outname=None):
+
+        outname = outname if outname is not None else self.options["name"] + "_cnc"
+        z_cut = z_cut if z_cut is not None else self.options["cutz"]
+        z_move = z_move if z_move is not None else self.options["travelz"]
+        feedrate = feedrate if feedrate is not None else self.options["feedrate"]
+        tooldia = tooldia if tooldia is not None else self.options["cnctooldia"]
 
         # Object initialization function for app.new_object()
         # RUNNING ON SEPARATE THREAD!
         def job_init(job_obj, app_obj):
             assert isinstance(job_obj, FlatCAMCNCjob)
             # Propagate options
-            job_obj.options["tooldia"] = self.options["cnctooldia"]
+            job_obj.options["tooldia"] = tooldia
 
             # GLib.idle_add(lambda: app_obj.set_progress_bar(0.2, "Creating CNC Job..."))
             app_obj.progress.emit(20)
-            job_obj.z_cut = self.options["cutz"]
-            job_obj.z_move = self.options["travelz"]
-            job_obj.feedrate = self.options["feedrate"]
+            job_obj.z_cut = z_cut
+            job_obj.z_move = z_move
+            job_obj.feedrate = feedrate
 
             # GLib.idle_add(lambda: app_obj.set_progress_bar(0.4, "Analyzing Geometry..."))
             app_obj.progress.emit(40)
@@ -927,11 +969,11 @@ class FlatCAMGeometry(FlatCAMObj, Geometry):
 
         # To be run in separate thread
         def job_thread(app_obj):
-            app_obj.new_object("cncjob", job_name, job_init)
+            app_obj.new_object("cncjob", outname, job_init)
             # GLib.idle_add(lambda: app_obj.info("CNCjob created: %s" % job_name))
             # GLib.idle_add(lambda: app_obj.set_progress_bar(1.0, "Done!"))
             # GLib.timeout_add_seconds(1, lambda: app_obj.set_progress_bar(0.0, "Idle"))
-            app_obj.inform.emit("CNCjob created: %s" % job_name)
+            app_obj.inform.emit("CNCjob created: %s" % outname)
             app_obj.progress.emit(100)
 
         # Send to worker
@@ -1004,10 +1046,14 @@ class FlatCAMGeometry(FlatCAMObj, Geometry):
             return
 
         # Make sure solid_geometry is iterable.
+        # TODO: This method should not modify the object !!!
         try:
             _ = iter(self.solid_geometry)
         except TypeError:
-            self.solid_geometry = [self.solid_geometry]
+            if self.solid_geometry is None:
+                self.solid_geometry = []
+            else:
+                self.solid_geometry = [self.solid_geometry]
 
         for geo in self.solid_geometry:
 

FlatCAMShell.py

@@ -1,5 +1,3 @@
-import sys
-from PyQt4.QtGui import QApplication
 import termwidget
 
 
@@ -24,4 +22,4 @@ class FCShell(termwidget.TermWidget):
         return True
 
     def child_exec_command(self, text):
-        self._sysShell.execCommand(text)
+        self._sysShell.exec_command(text)

ObjectCollection.py

@@ -142,8 +142,15 @@ class ObjectCollection(QtCore.QAbstractListModel):
         return self.object_list[row]
 
     def set_active(self, name):
-        iobj = self.createIndex(self.get_names().index(name))
-        self.view.selectionModel().select(iobj, QtGui.QItemSelectionModel)
+        """
+        Selects object by name from the project list. This trigger the
+        list_selection_changed event and call on_list_selection changed.
+
+        :param name: Name of the FlatCAM Object
+        :return: None
+        """
+        iobj = self.createIndex(self.get_names().index(name), 0)  # Column 0
+        self.view.selectionModel().select(iobj, QtGui.QItemSelectionModel.Select)
 
     def on_list_selection_change(self, current, previous):
         FlatCAMApp.App.log.debug("on_list_selection_change()")

camlib.py

@@ -51,7 +51,59 @@ class Geometry(object):
 
         # Attributes to be included in serialization
         self.ser_attrs = ['units', 'solid_geometry']
-        
+
+    def union(self):
+        """
+        Runs a cascaded union on the list of objects in
+        solid_geometry.
+
+        :return: None
+        """
+        self.solid_geometry = [cascaded_union(self.solid_geometry)]
+
+    def add_circle(self, origin, radius):
+        """
+        Adds a circle to the object.
+
+        :param origin: Center of the circle.
+        :param radius: Radius of the circle.
+        :return: None
+        """
+        # TODO: Decide what solid_geometry is supposed to be and how we append to it.
+
+        if self.solid_geometry is None:
+            self.solid_geometry = []
+
+        if type(self.solid_geometry) is list:
+            self.solid_geometry.append(Point(origin).buffer(radius))
+            return
+
+        try:
+            self.solid_geometry = self.solid_geometry.union(Point(origin).buffer(radius))
+        except:
+            print "Failed to run union on polygons."
+            raise
+
+    def add_polygon(self, points):
+        """
+        Adds a polygon to the object (by union)
+
+        :param points: The vertices of the polygon.
+        :return: None
+        """
+        if self.solid_geometry is None:
+            self.solid_geometry = []
+
+        if type(self.solid_geometry) is list:
+            self.solid_geometry.append(Polygon(points))
+            return
+
+        try:
+            self.solid_geometry = self.solid_geometry.union(Polygon(points))
+        except:
+            print "Failed to run union on polygons."
+            raise
+
     def isolation_geometry(self, offset):
         """
         Creates contours around geometry at a given
@@ -69,14 +121,22 @@ class Geometry(object):
         Returns coordinates of rectangular bounds
         of geometry: (xmin, ymin, xmax, ymax).
         """
+        log.debug("Geometry->bounds()")
         if self.solid_geometry is None:
+            log.debug("solid_geometry is None")
             log.warning("solid_geometry not computed yet.")
             return (0, 0, 0, 0)
             
-        if type(self.solid_geometry) == list:
+        if type(self.solid_geometry) is list:
+            log.debug("type(solid_geometry) is list")
             # TODO: This can be done faster. See comment from Shapely mailing lists.
+            if len(self.solid_geometry) == 0:
+                log.debug('solid_geometry is empty []')
+                return (0, 0, 0, 0)
+            log.debug('solid_geometry is not empty, returning cascaded union of items')
             return cascaded_union(self.solid_geometry).bounds
         else:
+            log.debug("type(solid_geometry) is not list, returning .bounds property")
             return self.solid_geometry.bounds
         
     def size(self):
@@ -863,21 +923,24 @@ class Gerber (Geometry):
         log.warning("Aperture not implemented: %s" % str(apertureType))
         return None
         
-    def parse_file(self, filename):
+    def parse_file(self, filename, follow=False):
         """
         Calls Gerber.parse_lines() with array of lines
         read from the given file.
 
         :param filename: Gerber file to parse.
         :type filename: str
+        :param follow: If true, will not create polygons, just lines
+            following the gerber path.
+        :type follow: bool
         :return: None
         """
         gfile = open(filename, 'r')
         gstr = gfile.readlines()
         gfile.close()
-        self.parse_lines(gstr)
+        self.parse_lines(gstr, follow=follow)
 
-    def parse_lines(self, glines):
+    def parse_lines(self, glines, follow=False):
         """
         Main Gerber parser. Reads Gerber and populates ``self.paths``, ``self.apertures``,
         ``self.flashes``, ``self.regions`` and ``self.units``.
@@ -885,6 +948,9 @@ class Gerber (Geometry):
         :param glines: Gerber code as list of strings, each element being
             one line of the source file.
         :type glines: list
+        :param follow: If true, will not create polygons, just lines
+            following the gerber path.
+        :type follow: bool
         :return: None
         :rtype: None
         """
@@ -1009,7 +1075,10 @@ class Gerber (Geometry):
                                 if last_path_aperture is None:
                                     log.warning("No aperture defined for curent path. (%d)" % line_num)
                                 width = self.apertures[last_path_aperture]["size"]
-                                geo = LineString(path).buffer(width/2)
+                                if follow:
+                                    geo = LineString(path)
+                                else:
+                                    geo = LineString(path).buffer(width/2)
                             poly_buffer.append(geo)
 
                         path = [[current_x, current_y]]  # Start new path

defaults.json

@@ -1 +1 @@
-{"gerber_cutoutgapsize": 0.15, "gerber_noncopperrounded": false, "geometry_paintoverlap": 0.15, "excellon_plot": true, "gerber_isotooldia": 0.016, "gerber_plot": true, "excellon_drillz": -0.1, "geometry_feedrate": 3.0, "units": "IN", "excellon_travelz": 0.1, "gerber_multicolored": false, "gerber_solid": true, "gerber_isopasses": 1, "cncjob_append": "", "excellon_feedrate": 3.0, "cncjob_tooldia": 0.016, "geometry_travelz": 0.1, "gerber_cutoutmargin": 0.1, "excellon_solid": true, "geometry_paintmargin": 0.0, "geometry_cutz": -0.002, "gerber_noncoppermargin": 0.0, "gerber_cutouttooldia": 0.07, "gerber_gaps": "4", "gerber_bboxmargin": 0.0, "cncjob_plot": true, "geometry_plot": true, "gerber_isooverlap": 0.15, "gerber_bboxrounded": false, "geometry_cnctooldia": 0.016, "geometry_painttooldia": 0.07}
+{"gerber_noncopperrounded": false, "geometry_paintoverlap": 0.15, "cncjob_append": "", "excellon_feedrate": 3.0, "serial": "cd37phz4q7dbmf7hbx9h", "gerber_plot": true, "geometry_plot": true, "excellon_drillz": -0.1, "geometry_feedrate": 3.0, "units": "IN", "excellon_travelz": 0.1, "gerber_multicolored": false, "gerber_solid": true, "gerber_isopasses": 1, "excellon_plot": true, "gerber_isotooldia": 0.016, "cncjob_tooldia": 0.016, "geometry_travelz": 0.1, "gerber_cutoutmargin": 0.1, "excellon_solid": true, "geometry_paintmargin": 0.0, "geometry_cutz": -0.002, "geometry_cnctooldia": 0.016, "gerber_cutouttooldia": 0.07, "gerber_gaps": "4", "gerber_bboxmargin": 0.0, "cncjob_plot": true, "gerber_cutoutgapsize": 0.15, "gerber_isooverlap": 0.15, "gerber_bboxrounded": false, "gerber_noncoppermargin": 0.0, "geometry_painttooldia": 0.07}

manual/_theme/__init__.py

@@ -0,0 +1,17 @@
+"""Sphinx ReadTheDocs theme.
+
+From https://github.com/ryan-roemer/sphinx-bootstrap-theme.
+
+"""
+import os
+
+VERSION = (0, 1, 5)
+
+__version__ = ".".join(str(v) for v in VERSION)
+__version_full__ = __version__
+
+
+def get_html_theme_path():
+    """Return list of HTML theme paths."""
+    cur_dir = os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
+    return cur_dir

manual/_theme/breadcrumbs.html

@@ -0,0 +1,19 @@
+<div role="navigation" aria-label="breadcrumbs navigation">
+  <ul class="wy-breadcrumbs">
+    <li><a href="{{ pathto(master_doc) }}">Docs</a> &raquo;</li>
+      {% for doc in parents %}
+          <li><a href="{{ doc.link|e }}">{{ doc.title }}</a> &raquo;</li>
+      {% endfor %}
+    <li>{{ title }}</li>
+      <li class="wy-breadcrumbs-aside">
+        {% if display_github %}
+          <a href="https://github.com/{{ github_user }}/{{ github_repo }}/blob/{{ github_version }}{{ conf_py_path }}{{ pagename }}.rst" class="icon icon-github"> Edit on GitHub</a>
+        {% elif display_bitbucket %}
+          <a href="https://bitbucket.org/{{ bitbucket_user }}/{{ bitbucket_repo }}/src/{{ bitbucket_version}}{{ conf_py_path }}{{ pagename }}.rst" class="icon icon-bitbucket"> Edit on Bitbucket</a>
+        {% elif show_source and has_source and sourcename %}
+          <a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow"> View page source</a>
+        {% endif %}
+      </li>
+  </ul>
+  <hr/>
+</div>

manual/_theme/footer.html

@@ -0,0 +1,32 @@
+<footer>
+  {% if next or prev %}
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      {% if next %}
+        <a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}"/>Next <span class="icon icon-circle-arrow-right"></span></a>
+      {% endif %}
+      {% if prev %}
+        <a href="{{ prev.link|e }}" class="btn btn-neutral" title="{{ prev.title|striptags|e }}"><span class="icon icon-circle-arrow-left"></span> Previous</a>
+      {% endif %}
+    </div>
+  {% endif %}
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>
+    {%- if show_copyright %}
+      {%- if hasdoc('copyright') %}
+        {% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
+      {%- else %}
+        {% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}
+      {%- endif %}
+    {%- endif %}
+
+    {%- if last_updated %}
+      {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
+    {%- endif %}
+    </p>
+  </div>
+
+  {% trans %}<a href="https://github.com/snide/sphinx_rtd_theme">Sphinx theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>{% endtrans %}
+</footer>

manual/_theme/layout.html

@@ -0,0 +1,149 @@
+{# TEMPLATE VAR SETTINGS #}
+{%- set url_root = pathto('', 1) %}
+{%- if url_root == '#' %}{% set url_root = '' %}{% endif %}
+{%- if not embedded and docstitle %}
+  {%- set titlesuffix = " — "|safe + docstitle|e %}
+{%- else %}
+  {%- set titlesuffix = "" %}
+{%- endif %}
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  {% block htmltitle %}
+  <title>{{ title|striptags|e }}{{ titlesuffix }}</title>
+  {% endblock %}
+
+  {# FAVICON #}
+  {% if favicon %}
+    <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
+  {% endif %}
+
+  {# CSS #}
+  <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
+
+  {# JS #}
+  {% if not embedded %}
+
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:'{{ url_root }}',
+        VERSION:'{{ release|e }}',
+        COLLAPSE_INDEX:false,
+        FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}',
+        HAS_SOURCE:  {{ has_source|lower }}
+      };
+    </script>
+    {%- for scriptfile in script_files %}
+      <script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
+    {%- endfor %}
+
+    {% if use_opensearch %}
+      <link rel="search" type="application/opensearchdescription+xml" title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}" href="{{ pathto('_static/opensearch.xml', 1) }}"/>
+    {% endif %}
+
+  {% endif %}
+
+  {# RTD hosts these file themselves, so just load on non RTD builds #}
+  {% if not READTHEDOCS %}
+    <link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
+    <script type="text/javascript" src="{{ pathto('_static/js/theme.js', 1) }}"></script>
+  {% endif %}
+
+  {# STICKY NAVIGATION #}
+  {% if theme_sticky_navigation %}
+    <script type="text/javascript">
+        jQuery(function () {
+            SphinxRtdTheme.StickyNav.enable();
+        });
+    </script>
+  {% endif %}
+
+  {% for cssfile in css_files %}
+    <link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
+  {% endfor %}
+
+  {%- block linktags %}
+    {%- if hasdoc('about') %}
+        <link rel="author" title="{{ _('About these documents') }}"
+              href="{{ pathto('about') }}"/>
+    {%- endif %}
+    {%- if hasdoc('genindex') %}
+        <link rel="index" title="{{ _('Index') }}"
+              href="{{ pathto('genindex') }}"/>
+    {%- endif %}
+    {%- if hasdoc('search') %}
+        <link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}"/>
+    {%- endif %}
+    {%- if hasdoc('copyright') %}
+        <link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}"/>
+    {%- endif %}
+    <link rel="top" title="{{ docstitle|e }}" href="{{ pathto('index') }}"/>
+    {%- if parents %}
+        <link rel="up" title="{{ parents[-1].title|striptags|e }}" href="{{ parents[-1].link|e }}"/>
+    {%- endif %}
+    {%- if next %}
+        <link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}"/>
+    {%- endif %}
+    {%- if prev %}
+        <link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}"/>
+    {%- endif %}
+  {%- endblock %}
+  {%- block extrahead %} {% endblock %}
+
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+  <div class="wy-grid-for-nav">
+
+    {# SIDE NAV, TOGGLES ON MOBILE #}
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-nav-search">
+        <a href="{{ pathto(master_doc) }}" class="icon icon-home"> {{ project }}</a>
+        {% include "searchbox.html" %}
+      </div>
+
+      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+        {% set toctree = toctree(maxdepth=2, collapse=False, includehidden=True) %}
+        {% if toctree %}
+            {{ toctree }}
+        {% else %}
+            <!-- Local TOC -->
+            <div class="local-toc">{{ toc }}</div>
+        {% endif %}
+      </div>
+      &nbsp;
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+      {# MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #}
+      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+        <i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
+        <a href="{{ pathto(master_doc) }}">{{ project }}</a>
+      </nav>
+
+
+      {# PAGE CONTENT #}
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          {% include "breadcrumbs.html" %}
+          <div role="main">
+            {% block body %}{% endblock %}
+          </div>
+          {% include "footer.html" %}
+        </div>
+      </div>
+
+    </section>
+
+  </div>
+  {% include "versions.html" %}
+</body>
+</html>

manual/_theme/layout_old.html

@@ -0,0 +1,205 @@
+{#
+    basic/layout.html
+    ~~~~~~~~~~~~~~~~~
+
+    Master layout template for Sphinx themes.
+
+    :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+#}
+{%- block doctype -%}
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+{%- endblock %}
+{%- set reldelim1 = reldelim1 is not defined and ' &raquo;' or reldelim1 %}
+{%- set reldelim2 = reldelim2 is not defined and ' |' or reldelim2 %}
+{%- set render_sidebar = (not embedded) and (not theme_nosidebar|tobool) and
+                         (sidebars != []) %}
+{%- set url_root = pathto('', 1) %}
+{# XXX necessary? #}
+{%- if url_root == '#' %}{% set url_root = '' %}{% endif %}
+{%- if not embedded and docstitle %}
+  {%- set titlesuffix = " &mdash; "|safe + docstitle|e %}
+{%- else %}
+  {%- set titlesuffix = "" %}
+{%- endif %}
+
+{%- macro relbar() %}
+    <div class="related">
+      <h3>{{ _('Navigation') }}</h3>
+      <ul>
+        {%- for rellink in rellinks %}
+        <li class="right" {% if loop.first %}style="margin-right: 10px"{% endif %}>
+          <a href="{{ pathto(rellink[0]) }}" title="{{ rellink[1]|striptags|e }}"
+             {{ accesskey(rellink[2]) }}>{{ rellink[3] }}</a>
+          {%- if not loop.first %}{{ reldelim2 }}{% endif %}</li>
+        {%- endfor %}
+        {%- block rootrellink %}
+        <li><a href="{{ pathto(master_doc) }}">{{ shorttitle|e }}</a>{{ reldelim1 }}</li>
+        {%- endblock %}
+        {%- for parent in parents %}
+          <li><a href="{{ parent.link|e }}" {% if loop.last %}{{ accesskey("U") }}{% endif %}>{{ parent.title }}</a>{{ reldelim1 }}</li>
+        {%- endfor %}
+        {%- block relbaritems %} {% endblock %}
+      </ul>
+    </div>
+{%- endmacro %}
+
+{%- macro sidebar() %}
+      {%- if render_sidebar %}
+      <div class="sphinxsidebar">
+        <div class="sphinxsidebarwrapper">
+          {%- block sidebarlogo %}
+          {%- if logo %}
+            <p class="logo"><a href="{{ pathto(master_doc) }}">
+              <img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/>
+            </a></p>
+          {%- endif %}
+          {%- endblock %}
+          {%- if sidebars != None %}
+            {#- new style sidebar: explicitly include/exclude templates #}
+            {%- for sidebartemplate in sidebars %}
+            {%- include sidebartemplate %}
+            {%- endfor %}
+          {%- else %}
+            {#- old style sidebars: using blocks -- should be deprecated #}
+            {%- block sidebartoc %}
+            {%- include "localtoc.html" %}
+            {%- endblock %}
+            {%- block sidebarrel %}
+            {%- include "relations.html" %}
+            {%- endblock %}
+            {%- block sidebarsourcelink %}
+            {%- include "sourcelink.html" %}
+            {%- endblock %}
+            {%- if customsidebar %}
+            {%- include customsidebar %}
+            {%- endif %}
+            {%- block sidebarsearch %}
+            {%- include "searchbox.html" %}
+            {%- endblock %}
+          {%- endif %}
+        </div>
+      </div>
+      {%- endif %}
+{%- endmacro %}
+
+{%- macro script() %}
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '{{ url_root }}',
+        VERSION:     '{{ release|e }}',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '{{ '' if no_search_suffix else file_suffix }}',
+        HAS_SOURCE:  {{ has_source|lower }}
+      };
+    </script>
+    {%- for scriptfile in script_files %}
+    <script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
+    {%- endfor %}
+{%- endmacro %}
+
+{%- macro css() %}
+    <link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
+    <link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" />
+    {%- for cssfile in css_files %}
+    <link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
+    {%- endfor %}
+{%- endmacro %}
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset={{ encoding }}" />
+    {{ metatags }}
+    {%- block htmltitle %}
+    <title>{{ title|striptags|e }}{{ titlesuffix }}</title>
+    {%- endblock %}
+    {{ css() }}
+    {%- if not embedded %}
+    {{ script() }}
+    {%- if use_opensearch %}
+    <link rel="search" type="application/opensearchdescription+xml"
+          title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}"
+          href="{{ pathto('_static/opensearch.xml', 1) }}"/>
+    {%- endif %}
+    {%- if favicon %}
+    <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
+    {%- endif %}
+    {%- endif %}
+{%- block linktags %}
+    {%- if hasdoc('about') %}
+    <link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" />
+    {%- endif %}
+    {%- if hasdoc('genindex') %}
+    <link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" />
+    {%- endif %}
+    {%- if hasdoc('search') %}
+    <link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" />
+    {%- endif %}
+    {%- if hasdoc('copyright') %}
+    <link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" />
+    {%- endif %}
+    <link rel="top" title="{{ docstitle|e }}" href="{{ pathto('index') }}" />
+    {%- if parents %}
+    <link rel="up" title="{{ parents[-1].title|striptags|e }}" href="{{ parents[-1].link|e }}" />
+    {%- endif %}
+    {%- if next %}
+    <link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}" />
+    {%- endif %}
+    {%- if prev %}
+    <link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}" />
+    {%- endif %}
+{%- endblock %}
+{%- block extrahead %} {% endblock %}
+  </head>
+  <body>
+{%- block header %}{% endblock %}
+
+{%- block relbar1 %}{{ relbar() }}{% endblock %}
+
+{%- block content %}
+  {%- block sidebar1 %} {# possible location for sidebar #} {% endblock %}
+
+    <div class="document">
+  {%- block document %}
+      <div class="documentwrapper">
+      {%- if render_sidebar %}
+        <div class="bodywrapper">
+      {%- endif %}
+          <div class="body">
+            {% block body %} {% endblock %}
+          </div>
+      {%- if render_sidebar %}
+        </div>
+      {%- endif %}
+      </div>
+  {%- endblock %}
+
+  {%- block sidebar2 %}{{ sidebar() }}{% endblock %}
+      <div class="clearer"></div>
+    </div>
+{%- endblock %}
+
+{%- block relbar2 %}{{ relbar() }}{% endblock %}
+
+{%- block footer %}
+    <div class="footer">
+    {%- if show_copyright %}
+      {%- if hasdoc('copyright') %}
+        {% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
+      {%- else %}
+        {% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}
+      {%- endif %}
+    {%- endif %}
+    {%- if last_updated %}
+      {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
+    {%- endif %}
+    {%- if show_sphinx %}
+      {% trans sphinx_version=sphinx_version|e %}Created using <a href="http://sphinx-doc.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}
+    {%- endif %}
+    </div>
+    <p>asdf asdf asdf asdf 22</p>
+{%- endblock %}
+  </body>
+</html>
+

manual/_theme/search.html

@@ -0,0 +1,50 @@
+{#
+    basic/search.html
+    ~~~~~~~~~~~~~~~~~
+
+    Template for the search page.
+
+    :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+#}
+{%- extends "layout.html" %}
+{% set title = _('Search') %}
+{% set script_files = script_files + ['_static/searchtools.js'] %}
+{% block extrahead %}
+  <script type="text/javascript">
+    jQuery(function() { Search.loadIndex("{{ pathto('searchindex.js', 1) }}"); });
+  </script>
+  {# this is used when loading the search index using $.ajax fails,
+     such as on Chrome for documents on localhost #}
+  <script type="text/javascript" id="searchindexloader"></script>
+  {{ super() }}
+{% endblock %}
+{% block body %}
+  <noscript>
+  <div id="fallback" class="admonition warning">
+    <p class="last">
+      {% trans %}Please activate JavaScript to enable the search
+      functionality.{% endtrans %}
+    </p>
+  </div>
+  </noscript>
+
+  {% if search_performed %}
+    <h2>{{ _('Search Results') }}</h2>
+    {% if not search_results %}
+      <p>{{ _('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.') }}</p>
+    {% endif %}
+  {% endif %}
+  <div id="search-results">
+  {% if search_results %}
+    <ul>
+    {% for href, caption, context in search_results %}
+      <li>
+        <a href="{{ pathto(item.href) }}">{{ caption }}</a>
+        <p class="context">{{ context|e }}</p>
+      </li>
+    {% endfor %}
+    </ul>
+  {% endif %}
+  </div>
+{% endblock %}

manual/_theme/searchbox.html

@@ -0,0 +1,7 @@
+<div role="search">
+  <form id ="rtd-search-form" class="wy-form" action="{{ pathto('search') }}" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>

manual/_theme/sphinx_rtd_theme/__init__.py

@@ -0,0 +1,17 @@
+"""Sphinx ReadTheDocs theme.
+
+From https://github.com/ryan-roemer/sphinx-bootstrap-theme.
+
+"""
+import os
+
+VERSION = (0, 1, 5)
+
+__version__ = ".".join(str(v) for v in VERSION)
+__version_full__ = __version__
+
+
+def get_html_theme_path():
+    """Return list of HTML theme paths."""
+    cur_dir = os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
+    return cur_dir

manual/_theme/sphinx_rtd_theme/breadcrumbs.html

@@ -0,0 +1,19 @@
+<div role="navigation" aria-label="breadcrumbs navigation">
+  <ul class="wy-breadcrumbs">
+    <li><a href="{{ pathto(master_doc) }}">Docs</a> &raquo;</li>
+      {% for doc in parents %}
+          <li><a href="{{ doc.link|e }}">{{ doc.title }}</a> &raquo;</li>
+      {% endfor %}
+    <li>{{ title }}</li>
+      <li class="wy-breadcrumbs-aside">
+        {% if display_github %}
+          <a href="https://github.com/{{ github_user }}/{{ github_repo }}/blob/{{ github_version }}{{ conf_py_path }}{{ pagename }}.rst" class="icon icon-github"> Edit on GitHub</a>
+        {% elif display_bitbucket %}
+          <a href="https://bitbucket.org/{{ bitbucket_user }}/{{ bitbucket_repo }}/src/{{ bitbucket_version}}{{ conf_py_path }}{{ pagename }}.rst" class="icon icon-bitbucket"> Edit on Bitbucket</a>
+        {% elif show_source and has_source and sourcename %}
+          <a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow"> View page source</a>
+        {% endif %}
+      </li>
+  </ul>
+  <hr/>
+</div>

manual/_theme/sphinx_rtd_theme/footer.html

@@ -0,0 +1,32 @@
+<footer>
+  {% if next or prev %}
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      {% if next %}
+        <a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}"/>Next <span class="icon icon-circle-arrow-right"></span></a>
+      {% endif %}
+      {% if prev %}
+        <a href="{{ prev.link|e }}" class="btn btn-neutral" title="{{ prev.title|striptags|e }}"><span class="icon icon-circle-arrow-left"></span> Previous</a>
+      {% endif %}
+    </div>
+  {% endif %}
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>
+    {%- if show_copyright %}
+      {%- if hasdoc('copyright') %}
+        {% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
+      {%- else %}
+        {% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}
+      {%- endif %}
+    {%- endif %}
+
+    {%- if last_updated %}
+      {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
+    {%- endif %}
+    </p>
+  </div>
+
+  {% trans %}<a href="https://github.com/snide/sphinx_rtd_theme">Sphinx theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>{% endtrans %}
+</footer>

manual/_theme/sphinx_rtd_theme/layout.html

@@ -0,0 +1,162 @@
+{# TEMPLATE VAR SETTINGS #}
+{%- set url_root = pathto('', 1) %}
+{%- if url_root == '#' %}{% set url_root = '' %}{% endif %}
+{%- if not embedded and docstitle %}
+  {%- set titlesuffix = " — "|safe + docstitle|e %}
+{%- else %}
+  {%- set titlesuffix = "" %}
+{%- endif %}
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  {% block htmltitle %}
+  <title>{{ title|striptags|e }}{{ titlesuffix }}</title>
+  {% endblock %}
+
+  {# FAVICON #}
+  {% if favicon %}
+    <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
+  {% endif %}
+
+  {# CSS #}
+  <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
+
+  {# JS #}
+  {% if not embedded %}
+
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:'{{ url_root }}',
+        VERSION:'{{ release|e }}',
+        COLLAPSE_INDEX:false,
+        FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}',
+        HAS_SOURCE:  {{ has_source|lower }}
+      };
+    </script>
+    {%- for scriptfile in script_files %}
+      <script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
+    {%- endfor %}
+
+    {% if use_opensearch %}
+      <link rel="search" type="application/opensearchdescription+xml" title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}" href="{{ pathto('_static/opensearch.xml', 1) }}"/>
+    {% endif %}
+
+  {% endif %}
+
+  {# RTD hosts these file themselves, so just load on non RTD builds #}
+  {% if not READTHEDOCS %}
+    <link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
+    <script type="text/javascript" src="{{ pathto('_static/js/theme.js', 1) }}"></script>
+  {% endif %}
+
+  {# STICKY NAVIGATION #}
+  {% if theme_sticky_navigation %}
+    <script type="text/javascript">
+        jQuery(function () {
+            SphinxRtdTheme.StickyNav.enable();
+        });
+    </script>
+  {% endif %}
+
+  {% for cssfile in css_files %}
+    <link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
+  {% endfor %}
+
+  {%- block linktags %}
+    {%- if hasdoc('about') %}
+        <link rel="author" title="{{ _('About these documents') }}"
+              href="{{ pathto('about') }}"/>
+    {%- endif %}
+    {%- if hasdoc('genindex') %}
+        <link rel="index" title="{{ _('Index') }}"
+              href="{{ pathto('genindex') }}"/>
+    {%- endif %}
+    {%- if hasdoc('search') %}
+        <link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}"/>
+    {%- endif %}
+    {%- if hasdoc('copyright') %}
+        <link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}"/>
+    {%- endif %}
+    <link rel="top" title="{{ docstitle|e }}" href="{{ pathto('index') }}"/>
+    {%- if parents %}
+        <link rel="up" title="{{ parents[-1].title|striptags|e }}" href="{{ parents[-1].link|e }}"/>
+    {%- endif %}
+    {%- if next %}
+        <link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}"/>
+    {%- endif %}
+    {%- if prev %}
+        <link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}"/>
+    {%- endif %}
+  {%- endblock %}
+  {%- block extrahead %} {% endblock %}
+
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
+
+
+
+<script>
+  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+  })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+  ga('create', 'UA-55008703-1', 'auto');
+  ga('send', 'pageview');
+
+</script>
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+  <div class="wy-grid-for-nav">
+
+    {# SIDE NAV, TOGGLES ON MOBILE #}
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-nav-search">
+        <!--<a href="{{ pathto(master_doc) }}" class="icon icon-home"> {{ project }}</a>-->
+        <a href="http://flatcam.org" class="icon icon-home"> {{ project }}</a>
+        {% include "searchbox.html" %}
+      </div>
+
+      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+        {% set toctree = toctree(maxdepth=2, collapse=False, includehidden=True) %}
+        {% if toctree %}
+            {{ toctree }}
+        {% else %}
+            <!-- Local TOC -->
+            <div class="local-toc">{{ toc }}</div>
+        {% endif %}
+      </div>
+      &nbsp;
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+      {# MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #}
+      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+        <i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
+        <a href="{{ pathto(master_doc) }}">{{ project }}</a>
+      </nav>
+
+
+      {# PAGE CONTENT #}
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          {% include "breadcrumbs.html" %}
+          <div role="main">
+            {% block body %}{% endblock %}
+          </div>
+          {% include "footer.html" %}
+        </div>
+      </div>
+
+    </section>
+
+  </div>
+  {% include "versions.html" %}
+</body>
+</html>

manual/_theme/sphinx_rtd_theme/layout_old.html

@@ -0,0 +1,205 @@
+{#
+    basic/layout.html
+    ~~~~~~~~~~~~~~~~~
+
+    Master layout template for Sphinx themes.
+
+    :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+#}
+{%- block doctype -%}
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+{%- endblock %}
+{%- set reldelim1 = reldelim1 is not defined and ' &raquo;' or reldelim1 %}
+{%- set reldelim2 = reldelim2 is not defined and ' |' or reldelim2 %}
+{%- set render_sidebar = (not embedded) and (not theme_nosidebar|tobool) and
+                         (sidebars != []) %}
+{%- set url_root = pathto('', 1) %}
+{# XXX necessary? #}
+{%- if url_root == '#' %}{% set url_root = '' %}{% endif %}
+{%- if not embedded and docstitle %}
+  {%- set titlesuffix = " &mdash; "|safe + docstitle|e %}
+{%- else %}
+  {%- set titlesuffix = "" %}
+{%- endif %}
+
+{%- macro relbar() %}
+    <div class="related">
+      <h3>{{ _('Navigation') }}</h3>
+      <ul>
+        {%- for rellink in rellinks %}
+        <li class="right" {% if loop.first %}style="margin-right: 10px"{% endif %}>
+          <a href="{{ pathto(rellink[0]) }}" title="{{ rellink[1]|striptags|e }}"
+             {{ accesskey(rellink[2]) }}>{{ rellink[3] }}</a>
+          {%- if not loop.first %}{{ reldelim2 }}{% endif %}</li>
+        {%- endfor %}
+        {%- block rootrellink %}
+        <li><a href="{{ pathto(master_doc) }}">{{ shorttitle|e }}</a>{{ reldelim1 }}</li>
+        {%- endblock %}
+        {%- for parent in parents %}
+          <li><a href="{{ parent.link|e }}" {% if loop.last %}{{ accesskey("U") }}{% endif %}>{{ parent.title }}</a>{{ reldelim1 }}</li>
+        {%- endfor %}
+        {%- block relbaritems %} {% endblock %}
+      </ul>
+    </div>
+{%- endmacro %}
+
+{%- macro sidebar() %}
+      {%- if render_sidebar %}
+      <div class="sphinxsidebar">
+        <div class="sphinxsidebarwrapper">
+          {%- block sidebarlogo %}
+          {%- if logo %}
+            <p class="logo"><a href="{{ pathto(master_doc) }}">
+              <img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/>
+            </a></p>
+          {%- endif %}
+          {%- endblock %}
+          {%- if sidebars != None %}
+            {#- new style sidebar: explicitly include/exclude templates #}
+            {%- for sidebartemplate in sidebars %}
+            {%- include sidebartemplate %}
+            {%- endfor %}
+          {%- else %}
+            {#- old style sidebars: using blocks -- should be deprecated #}
+            {%- block sidebartoc %}
+            {%- include "localtoc.html" %}
+            {%- endblock %}
+            {%- block sidebarrel %}
+            {%- include "relations.html" %}
+            {%- endblock %}
+            {%- block sidebarsourcelink %}
+            {%- include "sourcelink.html" %}
+            {%- endblock %}
+            {%- if customsidebar %}
+            {%- include customsidebar %}
+            {%- endif %}
+            {%- block sidebarsearch %}
+            {%- include "searchbox.html" %}
+            {%- endblock %}
+          {%- endif %}
+        </div>
+      </div>
+      {%- endif %}
+{%- endmacro %}
+
+{%- macro script() %}
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '{{ url_root }}',
+        VERSION:     '{{ release|e }}',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '{{ '' if no_search_suffix else file_suffix }}',
+        HAS_SOURCE:  {{ has_source|lower }}
+      };
+    </script>
+    {%- for scriptfile in script_files %}
+    <script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
+    {%- endfor %}
+{%- endmacro %}
+
+{%- macro css() %}
+    <link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
+    <link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" />
+    {%- for cssfile in css_files %}
+    <link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
+    {%- endfor %}
+{%- endmacro %}
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset={{ encoding }}" />
+    {{ metatags }}
+    {%- block htmltitle %}
+    <title>{{ title|striptags|e }}{{ titlesuffix }}</title>
+    {%- endblock %}
+    {{ css() }}
+    {%- if not embedded %}
+    {{ script() }}
+    {%- if use_opensearch %}
+    <link rel="search" type="application/opensearchdescription+xml"
+          title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}"
+          href="{{ pathto('_static/opensearch.xml', 1) }}"/>
+    {%- endif %}
+    {%- if favicon %}
+    <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
+    {%- endif %}
+    {%- endif %}
+{%- block linktags %}
+    {%- if hasdoc('about') %}
+    <link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" />
+    {%- endif %}
+    {%- if hasdoc('genindex') %}
+    <link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" />
+    {%- endif %}
+    {%- if hasdoc('search') %}
+    <link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" />
+    {%- endif %}
+    {%- if hasdoc('copyright') %}
+    <link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" />
+    {%- endif %}
+    <link rel="top" title="{{ docstitle|e }}" href="{{ pathto('index') }}" />
+    {%- if parents %}
+    <link rel="up" title="{{ parents[-1].title|striptags|e }}" href="{{ parents[-1].link|e }}" />
+    {%- endif %}
+    {%- if next %}
+    <link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}" />
+    {%- endif %}
+    {%- if prev %}
+    <link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}" />
+    {%- endif %}
+{%- endblock %}
+{%- block extrahead %} {% endblock %}
+  </head>
+  <body>
+{%- block header %}{% endblock %}
+
+{%- block relbar1 %}{{ relbar() }}{% endblock %}
+
+{%- block content %}
+  {%- block sidebar1 %} {# possible location for sidebar #} {% endblock %}
+
+    <div class="document">
+  {%- block document %}
+      <div class="documentwrapper">
+      {%- if render_sidebar %}
+        <div class="bodywrapper">
+      {%- endif %}
+          <div class="body">
+            {% block body %} {% endblock %}
+          </div>
+      {%- if render_sidebar %}
+        </div>
+      {%- endif %}
+      </div>
+  {%- endblock %}
+
+  {%- block sidebar2 %}{{ sidebar() }}{% endblock %}
+      <div class="clearer"></div>
+    </div>
+{%- endblock %}
+
+{%- block relbar2 %}{{ relbar() }}{% endblock %}
+
+{%- block footer %}
+    <div class="footer">
+    {%- if show_copyright %}
+      {%- if hasdoc('copyright') %}
+        {% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
+      {%- else %}
+        {% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}
+      {%- endif %}
+    {%- endif %}
+    {%- if last_updated %}
+      {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
+    {%- endif %}
+    {%- if show_sphinx %}
+      {% trans sphinx_version=sphinx_version|e %}Created using <a href="http://sphinx-doc.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}
+    {%- endif %}
+    </div>
+    <p>asdf asdf asdf asdf 22</p>
+{%- endblock %}
+  </body>
+</html>
+

manual/_theme/sphinx_rtd_theme/search.html

@@ -0,0 +1,50 @@
+{#
+    basic/search.html
+    ~~~~~~~~~~~~~~~~~
+
+    Template for the search page.
+
+    :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+#}
+{%- extends "layout.html" %}
+{% set title = _('Search') %}
+{% set script_files = script_files + ['_static/searchtools.js'] %}
+{% block extrahead %}
+  <script type="text/javascript">
+    jQuery(function() { Search.loadIndex("{{ pathto('searchindex.js', 1) }}"); });
+  </script>
+  {# this is used when loading the search index using $.ajax fails,
+     such as on Chrome for documents on localhost #}
+  <script type="text/javascript" id="searchindexloader"></script>
+  {{ super() }}
+{% endblock %}
+{% block body %}
+  <noscript>
+  <div id="fallback" class="admonition warning">
+    <p class="last">
+      {% trans %}Please activate JavaScript to enable the search
+      functionality.{% endtrans %}
+    </p>
+  </div>
+  </noscript>
+
+  {% if search_performed %}
+    <h2>{{ _('Search Results') }}</h2>
+    {% if not search_results %}
+      <p>{{ _('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.') }}</p>
+    {% endif %}
+  {% endif %}
+  <div id="search-results">
+  {% if search_results %}
+    <ul>
+    {% for href, caption, context in search_results %}
+      <li>
+        <a href="{{ pathto(item.href) }}">{{ caption }}</a>
+        <p class="context">{{ context|e }}</p>
+      </li>
+    {% endfor %}
+    </ul>
+  {% endif %}
+  </div>
+{% endblock %}

manual/_theme/sphinx_rtd_theme/searchbox.html

@@ -0,0 +1,7 @@
+<div role="search">
+  <form id ="rtd-search-form" class="wy-form" action="{{ pathto('search') }}" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>

manual/_theme/sphinx_rtd_theme/static/js/theme.js

@@ -0,0 +1,47 @@
+$( document ).ready(function() {
+    // Shift nav in mobile when clicking the menu.
+    $(document).on('click', "[data-toggle='wy-nav-top']", function() {
+      $("[data-toggle='wy-nav-shift']").toggleClass("shift");
+      $("[data-toggle='rst-versions']").toggleClass("shift");
+    });
+    // Close menu when you click a link.
+    $(document).on('click', ".wy-menu-vertical .current ul li a", function() {
+      $("[data-toggle='wy-nav-shift']").removeClass("shift");
+      $("[data-toggle='rst-versions']").toggleClass("shift");
+    });
+    $(document).on('click', "[data-toggle='rst-current-version']", function() {
+      $("[data-toggle='rst-versions']").toggleClass("shift-up");
+    });  
+    // Make tables responsive
+    $("table.docutils:not(.field-list)").wrap("<div class='wy-table-responsive'></div>");
+});
+
+window.SphinxRtdTheme = (function (jquery) {
+    var stickyNav = (function () {
+        var navBar,
+            win,
+            stickyNavCssClass = 'stickynav',
+            applyStickNav = function () {
+                if (navBar.height() <= win.height()) {
+                    navBar.addClass(stickyNavCssClass);
+                } else {
+                    navBar.removeClass(stickyNavCssClass);
+                }
+            },
+            enable = function () {
+                applyStickNav();
+                win.on('resize', applyStickNav);
+            },
+            init = function () {
+                navBar = jquery('nav.wy-nav-side:first');
+                win    = jquery(window);
+            };
+        jquery(init);
+        return {
+            enable : enable
+        };
+    }());
+    return {
+        StickyNav : stickyNav
+    };
+}($));

manual/_theme/sphinx_rtd_theme/theme.conf

@@ -0,0 +1,8 @@
+[theme]
+inherit = basic
+stylesheet = css/theme.css
+
+[options]
+typekit_id = hiw1hhg
+analytics_id = 
+sticky_navigation = False

manual/_theme/sphinx_rtd_theme/versions.html

@@ -0,0 +1,37 @@
+{% if READTHEDOCS %}
+{# Add rst-badge after rst-versions for small badge style. #}
+  <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+    <span class="rst-current-version" data-toggle="rst-current-version">
+      <span class="icon icon-book"> Read the Docs</span>
+      v: {{ current_version }} 
+      <span class="icon icon-caret-down"></span>
+    </span>
+    <div class="rst-other-versions">
+      <dl>
+        <dt>Versions</dt>
+        {% for slug, url in versions %}
+          <dd><a href="{{ url }}">{{ slug }}</a></dd>
+        {% endfor %}
+      </dl>
+      <dl>
+        <dt>Downloads</dt>
+        {% for type, url in downloads %}
+          <dd><a href="{{ url }}">{{ type }}</a></dd>
+        {% endfor %}
+      </dl>
+      <dl>
+        <dt>On Read the Docs</dt>
+          <dd>
+            <a href="//{{ PRODUCTION_DOMAIN }}/projects/{{ slug }}/?fromdocs={{ slug }}">Project Home</a>
+          </dd>
+          <dd>
+            <a href="//{{ PRODUCTION_DOMAIN }}/builds/{{ slug }}/?fromdocs={{ slug }}">Builds</a>
+          </dd>
+      </dl>
+      <hr/>
+      Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+    </div>
+  </div>
+{% endif %}
+

manual/_theme/static/js/theme.js

@@ -0,0 +1,47 @@
+$( document ).ready(function() {
+    // Shift nav in mobile when clicking the menu.
+    $(document).on('click', "[data-toggle='wy-nav-top']", function() {
+      $("[data-toggle='wy-nav-shift']").toggleClass("shift");
+      $("[data-toggle='rst-versions']").toggleClass("shift");
+    });
+    // Close menu when you click a link.
+    $(document).on('click', ".wy-menu-vertical .current ul li a", function() {
+      $("[data-toggle='wy-nav-shift']").removeClass("shift");
+      $("[data-toggle='rst-versions']").toggleClass("shift");
+    });
+    $(document).on('click', "[data-toggle='rst-current-version']", function() {
+      $("[data-toggle='rst-versions']").toggleClass("shift-up");
+    });  
+    // Make tables responsive
+    $("table.docutils:not(.field-list)").wrap("<div class='wy-table-responsive'></div>");
+});
+
+window.SphinxRtdTheme = (function (jquery) {
+    var stickyNav = (function () {
+        var navBar,
+            win,
+            stickyNavCssClass = 'stickynav',
+            applyStickNav = function () {
+                if (navBar.height() <= win.height()) {
+                    navBar.addClass(stickyNavCssClass);
+                } else {
+                    navBar.removeClass(stickyNavCssClass);
+                }
+            },
+            enable = function () {
+                applyStickNav();
+                win.on('resize', applyStickNav);
+            },
+            init = function () {
+                navBar = jquery('nav.wy-nav-side:first');
+                win    = jquery(window);
+            };
+        jquery(init);
+        return {
+            enable : enable
+        };
+    }());
+    return {
+        StickyNav : stickyNav
+    };
+}($));

manual/_theme/theme.conf

@@ -0,0 +1,8 @@
+[theme]
+inherit = basic
+stylesheet = css/theme.css
+
+[options]
+typekit_id = hiw1hhg
+analytics_id = 
+sticky_navigation = False

manual/_theme/versions.html

@@ -0,0 +1,37 @@
+{% if READTHEDOCS %}
+{# Add rst-badge after rst-versions for small badge style. #}
+  <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+    <span class="rst-current-version" data-toggle="rst-current-version">
+      <span class="icon icon-book"> Read the Docs</span>
+      v: {{ current_version }} 
+      <span class="icon icon-caret-down"></span>
+    </span>
+    <div class="rst-other-versions">
+      <dl>
+        <dt>Versions</dt>
+        {% for slug, url in versions %}
+          <dd><a href="{{ url }}">{{ slug }}</a></dd>
+        {% endfor %}
+      </dl>
+      <dl>
+        <dt>Downloads</dt>
+        {% for type, url in downloads %}
+          <dd><a href="{{ url }}">{{ type }}</a></dd>
+        {% endfor %}
+      </dl>
+      <dl>
+        <dt>On Read the Docs</dt>
+          <dd>
+            <a href="//{{ PRODUCTION_DOMAIN }}/projects/{{ slug }}/?fromdocs={{ slug }}">Project Home</a>
+          </dd>
+          <dd>
+            <a href="//{{ PRODUCTION_DOMAIN }}/builds/{{ slug }}/?fromdocs={{ slug }}">Builds</a>
+          </dd>
+      </dl>
+      <hr/>
+      Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+    </div>
+  </div>
+{% endif %}
+

manual/basics.rst

@@ -0,0 +1,33 @@
+Basics
+======
+
+Creating, Saving and Loading Projects
+-------------------------------------
+
+A project is everything that you have loaded, created and set inside the program. A new project is created every time you load the program or run File→New.
+
+By running File→Save Project, File→Save Project As… or File→Save a Project Copy… you are saving everything currently in the environment including project options. File→Open Project… lets you load a saved project.
+
+Source Files
+------------
+
+Supported source files are:
+
+* **Gerber**: Typically define copper layers in a circuit board.
+* **Excellon**: (drill file): Contain drill specifications, size and coordinates.
+* **G-Code**: CNC machine instructions for cutting and/or drilling.
+
+These source files can be loaded by selecting File→Open Gerber…, File→Open Excellon… or File→Open G-Code… respectively. The objects created from source files are automatically added to the current project when loaded.
+
+Navigating Plots
+----------------
+
+Plots for open objectsPlots for open objects (Gerber, drills, g-code, etc…) are automatically shown on screen. A plot for a given can be updated by clicking “Update Plot” in the “Selected” tab, in case any parameters that would have changed the plot have been modified. (Gerber, drills, g-code, etc…) are automatically shown on screen. A plot for a given can be updated by clicking “Update Plot” in the “Selected” tab, in case any parameters that would have changed the plot have been modified.
+
+Zooming plots in and out is accomplished by clicking on the plot and using the mouse **scroll wheel** or hitting one of the following keys:
+
+* **‘1’**: Fits all graphics to the available plotting area.
+* **‘2’**: Zooms out
+* **‘3’**: Zooms in
+
+When zooming in or out, the point under the cursor stays at the same location. To move around the plot, first zoom out, move the cursor to a point of interest and zoom in again.

manual/cmdreference.rst

@@ -0,0 +1,227 @@
+.. _cmdreference:
+
+Shell Command Reference
+=======================
+
+.. warning::
+    The FlatCAM Shell is under development and its behavior might change in the future. This includes available commands and their syntax.
+
+add_circle
+~~~~~~~~~~
+Creates a circle in the given Geometry object.
+
+    > add_circle <name> <center_x> <center_y> <radius>
+       name: Name of the geometry object to which to append the circle.
+
+       center_x, center_y: Coordinates of the center of the circle.
+
+       radius: Radius of the circle.
+
+add_poly
+~~~~~~~~
+Creates a polygon in the given Geometry object.
+
+    > create_poly <name> <x0> <y0> <x1> <y1> <x2> <y2> [x3 y3 [...]]
+       name: Name of the geometry object to which to append the polygon.
+
+       xi, yi: Coordinates of points in the polygon.
+
+add_rect
+~~~~~~~~
+Creates a rectange in the given Geometry object.
+
+    > add_rect <name> <botleft_x> <botleft_y> <topright_x> <topright_y>
+       name: Name of the geometry object to which to append the rectangle.
+
+       botleft_x, botleft_y: Coordinates of the bottom left corner.
+
+       topright_x, topright_y Coordinates of the top right corner.
+
+cncjob
+~~~~~~
+Generates a CNC Job from a Geometry Object.
+
+    > cncjob <name> [-z_cut <c>] [-z_move <m>] [-feedrate <f>] [-tooldia <t>] [-outname <n>]
+       name: Name of the source object
+
+       z_cut: Z-axis cutting position
+
+       z_move: Z-axis moving position
+
+       feedrate: Moving speed when cutting
+
+       tooldia: Tool diameter to show on screen
+
+       outname: Name of the output object
+
+delete
+~~~~~~
+Deletes the give object.
+
+    > delete <name>
+       name: Name of the object to delete.
+
+follow
+~~~~~~
+Creates a geometry object following gerber paths.
+
+    > follow <name> [-outname <oname>]
+       name: Name of the gerber object.
+
+       outname: Name of the output geometry object.
+
+geo_union
+~~~~~~~~~
+Runs a union operation (addition) on the components of the geometry object. For example, if it contains 2 intersecting polygons, this opperation adds them intoa single larger polygon.
+
+    > geo_union <name>
+       name: Name of the geometry object.
+
+get_names
+~~~~~~~~~
+Lists the names of objects in the project.
+
+
+    > get_names
+       No parameters.
+
+help
+~~~~
+Shows list of commands.
+
+isolate
+~~~~~~~
+Creates isolation routing geometry for the given Gerber.
+
+    > isolate <name> [-dia <d>] [-passes <p>] [-overlap <o>]
+       name: Name of the object
+
+       dia: Tool diameter
+
+       passes: # of tool width
+
+       overlap: Fraction of tool diameter to overlap passes
+
+make_docs
+~~~~~~~~~
+Prints command rererence in reStructuredText format.
+
+new
+~~~
+Starts a new project. Clears objects from memory.
+
+
+    > new
+       No parameters.
+
+new_geometry
+~~~~~~~~~~~~
+Creates a new empty geometry object.
+
+    > new_geometry <name>
+       name: New object name
+
+offset
+~~~~~~
+Changes the position of the object.
+
+    > offset <name> <x> <y>
+       name: Name of the object
+
+       x: X-axis distance
+
+       y: Y-axis distance
+
+open_excellon
+~~~~~~~~~~~~~
+Opens an Excellon file.
+
+    > open_excellon <filename> [-outname <o>]
+       filename: Path to file to open.
+
+       outname: Name of the created excellon object.
+
+open_gcode
+~~~~~~~~~~
+Opens an G-Code file.
+
+    > open_gcode <filename> [-outname <o>]
+       filename: Path to file to open.
+
+       outname: Name of the created CNC Job object.
+
+open_gerber
+~~~~~~~~~~~
+Opens a Gerber file.
+
+    > open_gerber <filename> [-follow <0|1>] [-outname <o>]
+       filename: Path to file to open.
+
+       follow: If 1, does not create polygons, just follows the gerber path.
+
+       outname: Name of the created gerber object.
+
+open_project
+~~~~~~~~~~~~
+Opens a FlatCAM project.
+
+    > open_project <filename>
+       filename: Path to file to open.
+
+options
+~~~~~~~
+Shows the settings for an object.
+
+
+    > options <name>
+       name: Object name.
+
+paint_poly
+~~~~~~~~~~
+Creates a geometry object with toolpath to cover the inside of a polygon.
+
+    > paint_poly <name> <inside_pt_x> <inside_pt_y> <tooldia> <overlap>
+       name: Name of the sourge geometry object.
+
+       inside_pt_x, inside_pt_y: Coordinates of a point inside the polygon.
+
+       tooldia: Diameter of the tool to be used.
+
+       overlap: Fraction of the tool diameter to overlap cuts.
+
+plot
+~~~~
+Updates the plot on the user interface
+
+save_project
+~~~~~~~~~~~~
+Saves the FlatCAM project to file.
+
+    > save_project <filename>
+       filename: Path to file to save.
+
+scale
+~~~~~
+Resizes the object by a factor.
+
+    > scale <name> <factor>
+       name: Name of the object
+
+       factor: Fraction by which to scale
+
+set_active
+~~~~~~~~~~
+Sets a FlatCAM object as active.
+
+
+    > set_active <name>
+       name: Name of the object.
+
+write_gcode
+~~~~~~~~~~~
+Saves G-code of a CNC Job object to file.
+
+    > write_gcode <name> <filename>
+       name: Source CNC Job object
+
+       filename: Output filename

manual/flatcamshell.rst

@@ -0,0 +1,54 @@
+Shell Command Line Interface
+============================
+
+.. warning::
+    The FlatCAM Shell is under development and its behavior might change in the future. This includes available commands and their syntax.
+
+The FlatCAM Shell provides a command line interface to FlatCAM's functionalies and to the TCL language. It serves the following purposes:
+
+* An alternative the GUI for issuing commands and visualizing data output.
+* Scripting interface for automating large sequences of commands.
+* A mechanism for the user to implement new functionality.
+* A mechanism to provide detailed information to the user.
+* Keep a record of commands and responses.
+
+The Shell Window
+----------------
+
+.. image:: shell.png
+    :align: center
+
+The FlatCAM Shell window is shown at startup when FlatCAM loads. It can be closed and re-opened at any time without loss of data by clicking on the close button on the top right edge of the window and selecting **Tool→Command Line** from the main menu respectively.
+
+It is divided into 2 sections, an output section on the top and an input section on the bottom. A record of previously issued commands is shown in the output section along with their results and other information that FlatCAM might provide. Distinction between types of data in the output section is done by color coding.
+
+To issue a command, type it in the input section and hit ``Enter``. If the command consists of multiple lines, use ``Shift-Enter`` to insert a new line without issuing the command.
+
+Shell Language
+--------------
+
+The Shell uses the TCL_ language. TCL provides the simples posible syntax and requires no learning at all for isuing the basic FlatCAM commands. Nonetheless, TCL is a powerfull language that enables the users to create their own complex functionality if desired.
+
+.. _TCL: https://www.tcl.tk/man/tcl8.5/tutorial/tcltutorial.html
+
+Issuing a command is as simple as typing its name and hitting the ``Enter`` key. For example::
+
+    new
+
+This the same as clicking on **File→New** in the main window menu.
+
+If a command requires additional information, it is given immediately after the command name and a space. For example, to open the gerber file ``mygerber.gbr``::
+
+    open_gerber mygerber.gbr
+
+Sometimes a command will have optional parameters, this is, if you provide it it will use it, otherwise it will use some default value. For example::
+
+    isolate mygerber.gbr -tooldia 0.04
+
+This would create isolation routing geometry for the ``mygerber.gbr`` gerber object with a tool diameter of 0.04 inches (or mm, depending on the project settings). Otherwise, if you run::
+
+    isolate mygerber.gbr
+
+The same action will be performed but the tool diameter will be taken from the default value set for that object (If it is a new object, its default values will be set from the project options.)
+
+For complete reference of FlatCAM Shell commands, see :ref:`cmdreference`.

manual/installation.rst

@@ -0,0 +1,54 @@
+Installation
+============
+
+Windows Installer
+-----------------
+
+Download the installer from the repository_ and run it in your machine. It includes everything you need.
+
+.. _repository: https://bitbucket.org/jpcgt/flatcam/downloads
+
+Ubuntu
+------
+
+FlatCAM should work on most Linux distributions but Ubuntu has been chosen as the test platform.
+
+There are several dependencies required to run FlatCAM. These are listed in the following section. Before attempting a manual installation, try running the provided setup script ``setup_ubuntu.sh`` that will download and install required packages.
+
+Manual Installation
+-------------------
+
+Requirements
+~~~~~~~~~~~~
+
+* Python 2.7 32-bit
+* PyQt 4
+* Matplotlib 1.3.1
+* Numpy 1.8
+* `Shapely 1.3`_
+
+.. _Shapely 1.3: https://pypi.python.org/pypi/Shapely
+
+These packages might have their own dependencies.
+
+Linux
+~~~~~
+
+Under Linux, most modern package installers like **yum** or **apt-get** will attempt to locate and install the whole tree of dependencies for a specified package automatically. Refer to the provided setup script ``setup_ubuntu.sh`` for the names and installation order.
+
+Once the dependencies are installed, download the latest .zip release (or the latest source, although it is not garanteed to work), unpack it, change into the created folder and run::
+
+    Python FlatCAM.py
+
+
+Windows
+~~~~~~~
+
+An easy way to get the requirements in your system is to install WinPython_. This is a standalone distribution of Python which includes all of FlatCAM's dependencies, except for Shapely.
+
+.. _WinPython: http://winpython.sourceforge.net/
+
+Once the dependencies are installed, download the latest .zip release (or the latest source, although it is not garanteed to work), unpack it, change into the created folder and run::
+
+    Python FlatCAM.py
+

manual/introduction.rst

@@ -0,0 +1,4 @@
+Introduction
+============
+
+FlatCAM is a program for preparing CNC jobs for making PCBs on a CNC router. Among other things, it can take a Gerber file generated by your favorite PCB CAD program, and create G-Code for Isolation routing.

manual/procedures.rst

@@ -0,0 +1,201 @@
+Common Procedures
+=================
+
+Isolation Routing
+-----------------
+
+Isolation routing is the operation of cutting copper around traces for electrical isolation.
+
+1) Open a Gerber file: File→Open Gerber…
+
+The file is automatically analyzed, processed and plotted.
+
+2) Enter the diameter of the tool you will use for isolation routing and hit “Generate Geometry”. The units are determined by the project setting and are shown on the bottom right of the screen. If you want to work using different units, go to Options, Project Options (Combo box), Units. This will change the units for the whole project.
+
+.. image:: open_gerber_ready.png
+    :align: center
+
+This creates a new geometry object listed under “Project” with the same name as the  Gerber object with an “_iso” postfix, and its options are shown in “Selected”. Zoom into the plot (click over the plot and use the ‘2’ and ‘3’ keys to zoom in and out) to inspect the results.
+
+.. image:: iso_routing_ready.png
+    :align: center
+
+3) Create a CNC job from the new geometry by indicating the desired parameters as shown in the figure above and explained below:
+
+* **Cut Z**: The depth of the tool while cutting. -2 mils or -0.05 mm are a typical value for isolation routing.
+* **Travel Z**: The height above the board at which the cutting tool will travel  when not cutting copper.
+* **Feedrate**: The speed of the cutting tool while cutting in inches/minute of mm/minute depending on the project settings.
+* **Tool diam.**: The cutting tool diameter. Use the same value as when creating the isolation routing geometry in step 2.
+
+A CNC Job object has been added to your project and its options are shown in the “Selected” tab. Tool paths are shown on the plot. Blue are copper cuts, while yellow are travelling (no cutting) motions.
+
+.. image:: iso_routing_cnc_ready.png
+    :align: center
+
+Click on the “Export” button under “Export G-Code”. This will open a dialog box for you to save to a file. This is the file that you will supply to your CNC router.
+
+Wide Isolation Routing
+----------------------
+
+1) Go to the “Project” tab and double-click on the isolation geometry object that you created for the 1st pass. In the “Selected” tab, change its name and hit Enter.
+
+2) Go back to “Project” and double-click on the Gerber object. This takes you back to step 1 of tutorial 4.1. We will generate geometry for a second pass in the same way but with a larger offset. If “Tool diam” reads 0.016, enter 0.016*2.5 instead (0.016*3 would put the path 3 times as far which provides no overlap with the previous pass. By setting it to 0.016*2.5 you ensure that there is no copper left on the board and a cleaner finish). Click on “Generate Geometry” just like in tutorial 4.1 and you should get something like the figure below.
+
+.. image:: Double_iso.png
+    :align: center
+
+3) Generate a CNC job like you did in part 3 of tutorial 4.1. You will end up with 2 G-Code file, one for each pass.
+
+CNC Jobs for Drill Files
+------------------------
+
+1) Open a drill (Excellon) file: File→Open Excellon. The drill file will be drawn onto the plot and its options form should show up.
+
+2) A drill file will usually contain different tools (drill diameters). You can choose to create a CNC job for each individual tool or bundle some of the tools together in the same job (in case you did not intend to use drill bits of different diameters). Click on “Choose” under “Create CNC Job” to open a selection window with the list of tools. Each has the format “id”: “diameter”, where the diameter is in the project’s units. Check the boxes by the tools you want to  include in the job. The comma-separated list of tools should appear in the “Tools” entry box (Note: If you know the ids of the tools you can type the list yourself).
+
+.. image:: drill_tool_select.png
+    :align: center
+
+3) Adjust “Drill Z” (Drilling depth), “Travel Z” (Height for X-Y movement) and “Feed rate” (Z-axis speed in project units per minute) to your desired values, and click on “Generate”.
+
+.. image:: drill_cnc_job.png
+    :align: center
+
+A CNC job will be created and the tool-path will be shown on the screen. Click on “Export G-Code” as explained in tutorial 4.1 to save the generated CNC job to G-Code.
+
+2-side PCB
+----------
+
+The main idea behind this process is to ensure that when you turn your board around to mill the bottom side of your PCB it will be perfectly aligned with the top side.
+
+The mechanical alignment is accomplished by using alignment holes/pins. These are holes on your board and on the milling machine bed (typically a board of wood, known as “sacrificial” layer). Pins are used to align the holes on the board to the holes on the sacrificial layer. The holes are always pairs of holes that are symmetrical about a mirror axis. This ensures that when you turn your board around, the board can be aligned using the same alignment holes as before.
+
+.. image:: double1.png
+    :align: center
+
+The bottom layer must be flipped (mirrored) around the same axis that was used for the alignment holes.
+
+The placement of the mirror axis can be very arbitrary. You just need to make sure that after flipping the board around, it will still fit on the milling machine bed. Same for the alignment holes. It doesn’t matter much where you put them. Perhaps if you have a large bare copper board and you plan on reusing the alignment holes for different projects that will be made out of this same bare board, you might want to define the location of the axis and holes, and record them for later use.
+
+FlatCAM takes care of the rest. To ensure the symmetry of the alignment holes, FlatCAM asks you to specify the holes on only one side of the mirror axis and it will create the mirror copies for you. It will also mirror the bottom (Gerber) layer around the same axis.
+
+.. image:: double2.png
+    :align: center
+
+The process of making the double-sided board consists of creating the CNC Job objects for the top layer, the mirrored bottom layer and the alignment holes using FlatCAM. Then you can run the alignment holes job (you must drill through the board and into the sacrificial layer) and the top layer job. You must then turn the board around, align it using the alignment holes (fit some kind of pin in the holes) and run the bottom layer job.
+
+Here is how to use FlatCAM to generate the required files:
+
+1) Open the Gerber files for the top and bottom layers of your PCB.
+
+2) Start the Double-sided PCB tool by selecting Tools→Double-sided PCB tool.
+
+.. image:: dbl_sided1_arrows.png
+    :align: center
+
+The tool has the following options:
+
+* **Bottom Layer**: Indicates which layer is the bottom layer, which needs to be flipped.
+
+* **Mirror axis**: Around which axis, X or Y, we want to mirror the layer.
+
+* **Axis location**: How we want to specify the location of the axis.
+
+* **Point/Box**: Specifies the location of the axis. It depends on the Axis location setting:
+
+    * Point: A single point specifies where the axis is, and you input the coordinates of the point in the format (x, y). For example, if Mirror Axis is set to X and Point is set to (1.0, -1.0) the axis will be horizontal at y=-1.0 (The x coordinate is ignored).
+
+    * Box: If you have already defined the boundary of your PCB you may want the axis to be exactly in the middle of that rectangle. The boundary must be some geometry object defined in the project and can be selected in the combo box appearing in the Point/Box field.
+
+* Alignment holes: These can aid in placing the board at the exact position after turning it over for the bottom side job. These holes must be symmetrical to the mirror axis. You only need to specify the location of the holes on one side of the mirror axis and the program will create the mirror copy. Input the coordinates of the holes in the following format: (x1, y1), (x2, y2), etc.
+
+* Drill diameter: The diameter of the drill for the alignment holes.
+
+.. note::
+    You don’t have to manually type coordinates of points. Clicking on the plot automatically copies the coordinates to the clipboard in (x, y) format and these can be pasted into the input boxes.
+
+3) Create the mirror image of the bottom layer by clicking on “Create Mirror”. This will create a new Gerber object for the project. You can work with this object, create isolation routing and a CNC job as it has been show in the previous tutorials. You may want to hide or remove the layer for the top side to ease the visualization.
+
+4) Create the alignment hole drill object by going back to the Double-sided PCB tool and clicking “Create alignment drill”. This will create a drill job as specified and a CNC job can be created for it as has been shown for the previous examples.
+
+.. image:: bottom.png
+    :align: center
+
+Copper Area Clear
+-----------------
+
+Removing large areas of copper is necessary when trying to avoid shorts due to dust, rust, etc, or in RF circuits, where the remaining unused copper is just unwanted parasitics. This tutorial shows how to eliminate all copper that is not specified in the Gerber source, but the user can still selectively choose what to clear.
+
+.. image:: coppercleardemo1.png
+    :align: center
+
+1) Open a Gerber file as explained in previous tutorials.
+
+2) In the “Select” tab for the Gerber object, under “Non-copper regions”, provide “Boundary Margin” and click “Generate Geometry”. This creates a bounding box around the Gerber object, with the given margin. Then subtracts the Gerber object from the bounding box, resulting in a Geometry object with polygons covering the areas without copper.
+
+.. image:: coppercleardemo2.png
+    :align: center
+
+3) Now we can choose which polygon we want to “paint”, this is, draw a toolpath inside it to cover all its surface. In the “Selected” tab for the newly created geometry, under “Paint Area”, provide the following:
+
+* **Tool diam.**: The diameter of the tool that will be used to cut the area.
+
+* **Overlap**: Fraction of the tool diameter by which to overlap each passing cut. The default value of 0.15 is the minimum to ensure no copper is left in 90 degree turns of the toolpath.
+
+* **Margin**: Distance for the tool to stay away from the polygon boundary. This can be used to ensure that a large tool does not touch copper edges that have or will be cut by a smaller more precise tool.
+
+4) Click on “Generate” and then click on the plot inside the polygon to be painted. This will create a new Geometry object with the desired toolpaths.
+
+.. image:: coppercleardemo3.png
+    :align: center
+
+Board Cutout
+------------
+
+To cut the PCB to the desired shape and remove it from a larger blank PCB, a toolpath that traces the board edge can be created. Gaps to hold the board until the job is complete can be placed along the edge.
+
+This tutorial describes how to create rectangular cutouts with 2 or 4 gaps.
+
+1) Open a Gerber file and find the **Board Cutout** section in the **Selected tab**.
+
+.. image:: cutout.png
+    :align: center
+
+2) Specify a **Margin**. This will create a rectangular cutout at the given distance from any element in the Gerber. Specify a **Gap Size**. 2 times the diameter of the tool you will use for cutting is a good size. Specify how many and where you want the **Gaps** along the edge, 2 (top and bottom), 2 (left and right) or 4, one on each side. Click on **Generate Geometry**. The figure below shows an example of the results.
+
+.. image:: cutout2.png
+    :align: center
+
+3) Create a CNC job for the newly created geometry as explained in earlier tutorials.
+
+.. image:: cutout3.png
+    :align: center
+
+Bed Flattening
+--------------
+
+Most often a sacrificial layer (e.g. wood) is used between the machine bed and the PCB so when drilling and cutting the machine is not hit by the tool. In order to have a completely flat surface for the PCB, the sacrificial layer is flattened by the machine. This tutorial shows how to create a toolpath for this purpose.
+
+1) Open a Gerber file and locate the **Bounding Box** section in the **Selected tab**.
+
+2) Specify a **Margin** (distance of the bounding box from any element in the Gerber) and whether you want **rounded corners**. Click **Generate Bounding Box**.
+
+.. image:: bedflatten0.png
+    :align: center
+
+Make sure your blank PCB will fit in the bounding box.
+
+.. image:: bedflatten.png
+    :align: center
+
+3) In the **Selected** tab for the newly created geometry locate the **Paint Area** section. Specify the **diameter** of the tool you will use, how much (fraction of the tool width) each pass will **overlap** each other, and a **Margin** (although typically not needed and set to 0.0 in this case.)
+
+.. image:: bedflatten1.png
+    :align: center
+
+4) Click on **Generate**, and you will be asked to **click** inside the polygon inside which to create the tool path. Click inside the boundary we just created.
+
+.. image:: bedflatten2.png
+    :align: center
+
+5) Create a CNC job for the newly created geometry as explained in earlier tutorials.

recent.json

@@ -1 +1 @@
-[{"kind": "gerber", "filename": "C:/Users/jpcaram/Dropbox/CNC/pcbcam/test_files/maitest.gtl"}, {"kind": "gerber", "filename": "C:\\Users\\jpcaram\\Dropbox\\CNC\\pcbcam\\test_files\\maitest.gtl"}, {"kind": "gerber", "filename": "C:/Users/jpcaram/Dropbox/CNC/pcbcam/cirkuix/tests/CBS-F_Cu.gtl"}, {"kind": "excellon", "filename": "C:/Users/jpcaram/Dropbox/CNC/pcbcam/cirkuix/tests/CBS.drl"}, {"kind": "gerber", "filename": "C:/Users/jpcaram/Dropbox/CNC/pcbcam/test_files/Gerbers/AVR_Transistor_Tester_copper_top.GTL"}, {"kind": "excellon", "filename": "C:/Users/jpcaram/Dropbox/CNC/pcbcam/test_files/LockController_v1.0_pcb-RoundHoles.TXT/LockController_v1.0_pcb-RoundHoles.TXT"}, {"kind": "excellon", "filename": "C:/Users/jpcaram/Dropbox/CNC/pcbcam/test_files/Gerbers/AVR_Transistor_Tester.DRL"}, {"kind": "excellon", "filename": "C:/Users/jpcaram/Dropbox/CNC/pcbcam/test_files/FlatCam_Drilling_Test/FlatCam_Drilling_Test.drl"}, {"kind": "excellon", "filename": "C:/Users/jpcaram/Dropbox/CNC/pcbcam/test_files/Excellon_Planck/X-Y CONTROLLER - Drill Data - Through Hole.drl"}, {"kind": "excellon", "filename": "C:/Users/jpcaram/Dropbox/CNC/pcbcam/test_files/Scrivania/girasettori_v3.drd"}]
+[{"kind": "gerber", "filename": "tests/CBS-F_Cu.gtl"}, {"kind": "gerber", "filename": "C:/Users/jpcaram/Dropbox/CNC/pcbcam/test_files/maitest.gtl"}, {"kind": "gerber", "filename": "C:\\Users\\jpcaram\\Dropbox\\CNC\\pcbcam\\test_files\\maitest.gtl"}, {"kind": "gerber", "filename": "C:/Users/jpcaram/Dropbox/CNC/pcbcam/cirkuix/tests/CBS-F_Cu.gtl"}, {"kind": "excellon", "filename": "C:/Users/jpcaram/Dropbox/CNC/pcbcam/cirkuix/tests/CBS.drl"}, {"kind": "gerber", "filename": "C:/Users/jpcaram/Dropbox/CNC/pcbcam/test_files/Gerbers/AVR_Transistor_Tester_copper_top.GTL"}, {"kind": "excellon", "filename": "C:/Users/jpcaram/Dropbox/CNC/pcbcam/test_files/LockController_v1.0_pcb-RoundHoles.TXT/LockController_v1.0_pcb-RoundHoles.TXT"}, {"kind": "excellon", "filename": "C:/Users/jpcaram/Dropbox/CNC/pcbcam/test_files/Gerbers/AVR_Transistor_Tester.DRL"}, {"kind": "excellon", "filename": "C:/Users/jpcaram/Dropbox/CNC/pcbcam/test_files/FlatCam_Drilling_Test/FlatCam_Drilling_Test.drl"}, {"kind": "excellon", "filename": "C:/Users/jpcaram/Dropbox/CNC/pcbcam/test_files/Excellon_Planck/X-Y CONTROLLER - Drill Data - Through Hole.drl"}]

termwidget.py

@@ -171,12 +171,15 @@ class TermWidget(QWidget):
         Save current command in the history. Append it to the log. Clear edit line
         Reimplement in the child classes to actually execute command
         """
-        text = self._edit.toPlainText()
+        text = str(self._edit.toPlainText())
         self._append_to_browser('in', '> ' + text + '\n')
 
         if len(self._history) < 2 or\
            self._history[-2] != text:  # don't insert duplicating items
-            self._history.insert(-1, text)
+            if text[-1] == '\n':
+                self._history.insert(-1, text[:-1])
+            else:
+                self._history.insert(-1, text)
 
         self._historyIndex = len(self._history) - 1