pycam 34.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
$Id$

Copyright 2010 Lars Kruse <devel@sumpfralle.de>
Copyright 2008-2009 Lode Leroy

This file is part of PyCAM.

PyCAM is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

PyCAM is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with PyCAM.  If not, see <http://www.gnu.org/licenses/>.
"""

25
# extend the PYTHONPATH to include the "src" directory
26 27
import sys
import os
sumpfralle's avatar
sumpfralle committed
28 29
BASE_DIR = os.path.dirname(os.path.realpath(__file__))
sys.path.insert(0, os.path.join(BASE_DIR, "src"))
30

31 32 33
# register the glut32.dll manually for the pyinstaller standalone executable
if hasattr(sys, "frozen") and sys.frozen and "_MEIPASS2" in os.environ:
    from ctypes import windll
sumpfralle's avatar
sumpfralle committed
34 35
    windll[os.path.join(os.path.normpath(os.environ["_MEIPASS2"]),
            "glut32.dll")]
36

37 38 39 40 41
import pycam.Gui.common as GuiCommon
import pycam.Gui.Settings
import pycam.Gui.Console
import pycam.Importers.TestModel
import pycam.Importers
42
import pycam.Exporters.GCodeExporter
43
import pycam.Toolpath.Generator
44
import pycam.Utils.threading
45
import pycam.Utils
46 47 48
from pycam.Toolpath import Bounds, Toolpath
from pycam import VERSION
import pycam.Utils.log
49
from optparse import OptionParser
50
import socket
51 52 53
import logging
import time

54 55 56 57
# we need the multiprocessing exception for remote connections
try:
    import multiprocessing
except ImportError:
58
    class multiprocessing(object):
59 60 61 62
        # use an arbitrary other Exception
        AuthenticationError = socket.error


63 64 65
log = pycam.Utils.log.get_logger()

EXAMPLE_MODEL_LOCATIONS = [
sumpfralle's avatar
sumpfralle committed
66
        os.path.join(BASE_DIR, "samples"),
67 68 69 70
        os.path.join(sys.prefix, "share", "pycam", "samples"),
        os.path.join("usr", "share", "pycam", "samples")]
# for pyinstaller (windows distribution)
if "_MEIPASS2" in os.environ:
sumpfralle's avatar
sumpfralle committed
71 72
    EXAMPLE_MODEL_LOCATIONS.insert(0, os.path.join(os.path.normpath(
            os.environ["_MEIPASS2"]), "samples"))
73 74
DEFAULT_MODEL_FILE = "pycam.stl"
EXIT_CODES = {"ok": 0, "requirements": 1, "load_model_failed": 2,
75 76
        "write_output_failed": 3, "parsing_failed": 4,
        "server_without_password": 5, "connection_error": 6}
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91


def show_gui(inputfile=None, task_settings_file=None):
    deps_gtk = GuiCommon.requirements_details_gtk()
    report_gtk = GuiCommon.get_dependency_report(deps_gtk, prefix="\t")
    if GuiCommon.check_dependencies(deps_gtk):
        from pycam.Gui.Project import ProjectGui
        gui_class = ProjectGui
    else:
        full_report = []
        full_report.append("PyCAM dependency problem")
        full_report.append("Error: Failed to load the GTK interface.")
        full_report.append("Details:")
        full_report.append(report_gtk)
        full_report.append("")
92 93
        full_report.append("Detailed list of requirements: %s" % \
                GuiCommon.REQUIREMENTS_LINK)
94
        log.critical(os.linesep.join(full_report))
95
        return EXIT_CODES["requirements"]
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114

    gui = gui_class()

    # load the given model or the default
    if inputfile is None:
        default_model = get_default_model()
        if isinstance(default_model, basestring):
            gui.load_model_file(filename=default_model)
        else:
            gui.load_model(default_model)
    else:
        gui.load_model_file(filename=inputfile)

    # load task settings file
    if not task_settings_file is None:
        gui.open_task_settings_file(task_settings_file)

    # open the GUI
    gui.mainloop()
115 116
    # no error -> return no error code
    return None
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132


def get_default_model():
    """ return a filename or a Model instance """
    # try to load the default model file ("pycam" logo)
    for inputdir in EXAMPLE_MODEL_LOCATIONS:
        inputfile = os.path.join(inputdir, DEFAULT_MODEL_FILE)
        if os.path.isfile(inputfile):
            return inputfile
    else:
        # fall back to the simple test model
        log.warn("Failed to find the default model (%s) in the " \
                "following locations: %s" % (DEFAULT_MODEL_FILE,
                        ", ".join(EXAMPLE_MODEL_LOCATIONS)))
        return pycam.Importers.TestModel.get_test_model()

133
def load_model_file(filename, program_locations, unit=None):
134 135
    filename = os.path.expanduser(filename)
    if not os.path.isfile(filename):
sumpfralle's avatar
sumpfralle committed
136
        log.warn("The input file ('%s') was not found!" % filename)
137
        return None
138
    importer = pycam.Importers.detect_file_type(filename)[1]
139
    model = importer(filename, program_locations=program_locations, unit=unit)
140 141 142 143 144 145 146 147 148 149 150
    if model is None:
        log.warn("Failed to load the model file (%s)." % filename)
        return None
    else:
        return model

def get_output_handler(destination):
    if destination == "-":
        handler = sys.stdout
        closer = lambda: None
    else:
151 152
        # support paths with a tilde (~)
        destination = os.path.expanduser(destination)
153 154 155 156 157 158 159 160 161
        try:
            handler = open(destination, "w")
        except IOError, err_msg:
            log.error("Failed to open output file (%s) for writing: %s" \
                    % (destination, err_msg))
            return None, None
        closer = handler.close
    return (handler, closer)

162
def execute(parser, opts, args, pycam):
163
    # try to change the process name
164
    pycam.Utils.setproctitle("pycam")
165

166 167 168 169 170
    if len(args) > 0:
        inputfile = os.path.expanduser(args[0])
    else:
        inputfile = None

171 172 173
    if opts.debug:
        log.setLevel(logging.DEBUG)
    elif opts.quiet:
174 175 176 177 178 179 180 181 182 183
        log.setLevel(logging.WARNING)
        # disable the progress bar
        opts.progress = "none"

    # show version and exit
    if opts.show_version:
        if opts.quiet:
            # print only the bare version number
            print VERSION
        else:
184 185 186 187 188 189 190 191
            text = '''PyCAM %s
Copyright (C) 2008-2010 Lode Leroy
Copyright (C) 2010-2011 Lars Kruse

License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.''' % VERSION
            print text
192
        return EXIT_CODES["ok"]
193 194 195 196 197 198 199 200 201 202 203 204

    if not opts.disable_psyco:
        try:
            import psyco
            psyco.full()
            log.info("Psyco enabled")
        except ImportError:
            log.info("Psyco is not available (performance will probably " \
                    + "suffer slightly)")
    else:
        log.info("Psyco was disabled via the commandline")

205 206 207 208 209 210 211
    # check if server-auth-key is given -> this is mandatory for server mode
    if (opts.enable_server or opts.start_server) and not opts.server_authkey:
        parser.error("You need to supply a shared secret for server mode. " \
                + "This is supposed to prevent you from exposing your host " \
                + "to remote access without authentication.\n" \
                + "Please add the '--server-auth-key' argument followed by " \
                + "a shared secret password.")
212
        return EXIT_CODES["server_without_password"]
213

214
    # initialize multiprocessing
215 216 217 218 219 220
    try:
        if opts.start_server:
            pycam.Utils.threading.init_threading(opts.parallel_processes,
                    remote=opts.remote_server, run_server=True,
                    server_credentials=opts.server_authkey)
            pycam.Utils.threading.cleanup()
221
            return EXIT_CODES["ok"]
222 223 224 225 226 227
        else:
            pycam.Utils.threading.init_threading(opts.parallel_processes,
                    enable_server=opts.enable_server, remote=opts.remote_server,
                    server_credentials=opts.server_authkey)
    except socket.error, err_msg:
        log.error("Failed to connect to remote server: %s" % err_msg)
228
        return EXIT_CODES["connection_error"]
229 230 231
    except multiprocessing.AuthenticationError, err_msg:
        log.error("The remote server rejected your authentication key: %s" \
                % err_msg)
232
        return EXIT_CODES["connection_error"]
233

234 235 236 237 238 239 240 241 242 243 244 245 246
    # initialize the progress bar
    progress_styles = {"none": pycam.Gui.Console.ConsoleProgressBar.STYLE_NONE,
            "text": pycam.Gui.Console.ConsoleProgressBar.STYLE_TEXT,
            "bar": pycam.Gui.Console.ConsoleProgressBar.STYLE_BAR,
            "dot": pycam.Gui.Console.ConsoleProgressBar.STYLE_DOT,
    }
    progress_bar = pycam.Gui.Console.ConsoleProgressBar(sys.stdout,
            progress_styles[opts.progress])

    if opts.config_file:
        opts.config_file = os.path.expanduser(opts.config_file)

    if not opts.export_gcode and not opts.export_task_config:
247 248 249 250
        result = show_gui(inputfile, opts.config_file)
        if not result is None:
            # deliver the error code to our caller
            return result
251 252 253 254 255 256 257 258 259 260
    else:
        # generate toolpath
        tps = pycam.Gui.Settings.ToolpathSettings()
        tool_shape = {"cylindrical": "CylindricalCutter",
                "spherical": "SphericalCutter",
                "toroidal": "ToroidalCutter",
            }[opts.tool_shape]
        tps.set_tool(opts.tool_id, tool_shape, 0.5 * opts.tool_diameter,
                0.5 * opts.tool_torus_diameter, opts.tool_spindle_speed,
                opts.tool_feedrate)
261
        if opts.support_type == "grid":
262
            tps.set_support_grid(opts.support_grid_distance_x,
263 264 265 266 267 268 269 270 271 272 273 274 275
                    opts.support_grid_distance_y,
                    opts.support_profile_thickness, opts.support_profile_height,
                    opts.support_grid_offset_x, opts.support_grid_offset_y)
        elif opts.support_type in ("distributed-edges", "distributed-corners"):
            start_at_corners = (opts.support_type == "distributed-corners")
            tps.set_support_distributed(opts.support_distributed_distance,
                    opts.support_distributed_minimum,
                    opts.support_profile_thickness, opts.support_profile_height,
                    opts.support_distributed_length,
                    start_at_corners=start_at_corners)
        elif opts.support_type == "none":
            pass
        else:
276
            raise NotImplementedError, "Invalid support type specified: %s" % \
277
                    opts.support_type
278 279 280
        if opts.collision_engine == "ode":
            tps.set_calculation_backend("ODE")
        tps.set_unit_size(opts.unit_size)
281 282 283 284 285 286 287
        path_generator, postprocessor = {
                "layer": ("PushCutter", "SimpleCutter"),
                "contour-follow": ("ContourFollow", "SimpleCutter"),
                "contour-polygon": ("PushCutter", "ContourCutter"),
                "surface": ("DropCutter", "PathAccumulator"),
                "engrave": ("EngraveCutter", "SimpleCutter"),
            }[opts.process_path_strategy]
288
        tps.set_process_settings(path_generator, postprocessor,
289
                opts.process_path_direction,
290
                material_allowance=opts.process_material_allowance,
sumpfralle's avatar
sumpfralle committed
291
                overlap_percent=opts.process_overlap_percent,
292 293 294
                step_down=opts.process_step_down,
                engrave_offset=opts.process_engrave_offset,
                milling_style=opts.process_milling_style)
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
        # set locations of external programs
        program_locations = {}
        if opts.external_program_inkscape:
            program_locations["inkscape"] = opts.external_program_inkscape
        if opts.external_program_pstoedit:
            program_locations["pstoedit"] = opts.external_program_pstoedit
        # load the model
        if inputfile is None:
            model = get_default_model()
            # the "get_default_model" function returns a string or a model
            if isinstance(model, basestring):
                model = load_model_file(model,
                        program_locations=program_locations,
                        unit=opts.unit_size)
        else:
            model = load_model_file(inputfile,
                    program_locations=program_locations, unit=opts.unit_size)
        if model is None:
            # something went wrong - we quit
314
            return EXIT_CODES["load_model_failed"]
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
        # calculate the processing boundary
        bounds = Bounds()
        bounds.set_reference(model.get_bounds())
        # set the bounds type and let the default bounding box match the model
        if opts.bounds_type == "relative-margin":
            bounds.set_type(Bounds.TYPE_RELATIVE_MARGIN)
            bounds_default_low = (0, 0, 0)
            bounds_default_high = (0, 0, 0)
        elif opts.bounds_type == "fixed-margin":
            bounds.set_type(Bounds.TYPE_FIXED_MARGIN)
            bounds_default_low = (0, 0, 0)
            bounds_default_high = (0, 0, 0)
        else:
            # custom boundary setting
            bounds.set_type(Bounds.TYPE_CUSTOM)
            bounds_default_low = (model.minx, model.miny, model.minz)
            bounds_default_high = (model.maxx, model.maxy, model.maxz)
        # TODO: use the optparse conversion callback instead
        def parse_triple_float(text):
            nums = text.split(",")
            if len(nums) != 3:
                return None
            result = []
            for num in nums:
                try:
                    result.append(float(num))
                except ValueError:
                    if num == "":
                        result.append(0.0)
                    else:
                        return None
            return result
        bounds_lower_nums = parse_triple_float(opts.bounds_lower)
        if opts.bounds_lower and not bounds_lower_nums:
349
            parser.error("Failed to parse the lower boundary limit: %s" \
350
                    % opts.bounds_lower)
351
            return EXIT_CODES["parsing_failed"]
352 353
        bounds_upper_nums = parse_triple_float(opts.bounds_upper)
        if opts.bounds_upper and not bounds_upper_nums:
354
            parser.error("Failed to parse the upper boundary limit: %s" \
355
                    % opts.bounds_upper)
356
            return EXIT_CODES["parsing_failed"]
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390
        if bounds_lower_nums is None:
            bounds_lower_nums = bounds_default_low
        if bounds_upper_nums is None:
            bounds_upper_nums = bounds_default_high
        # both lower and upper bounds were specified
        bounds.set_bounds(bounds_lower_nums, bounds_upper_nums)
        # adjust the bounding box according to the "boundary_mode"
        if opts.boundary_mode == "along":
            offset = (0, 0, 0)
        elif opts.boundary_mode == "inside":
            offset = (-0.5 * opts.tool_diameter, -0.5 * opts.tool_diameter, 0)
        else:
            # "outside"
            offset = (0.5 * opts.tool_diameter, 0.5 * opts.tool_diameter, 0)
        process_bounds = Bounds(Bounds.TYPE_FIXED_MARGIN, offset, offset)
        process_bounds.set_reference(bounds)
        tps.set_bounds(process_bounds)
        if opts.export_gcode:
            # generate the toolpath
            start_time = time.time()
            toolpath = pycam.Toolpath.Generator.generate_toolpath_from_settings(
                    model, tps, callback=progress_bar.update)
            progress_bar.finish()
            log.info("Toolpath generation time: %f" \
                    % (time.time() - start_time))
            # write result
            if isinstance(toolpath, basestring):
                # an error occoured
                log.error(toolpath)
            else:
                description = "Toolpath generated via PyCAM v%s" % VERSION
                tp_obj = Toolpath(toolpath, description, tps)
                handler, closer = get_output_handler(opts.export_gcode)
                if handler is None:
391
                    return EXIT_CODES["write_output_failed"]
392 393
                generator = pycam.Exporters.GCodeExporter.GCodeGenerator(
                        handler, metric_units = (opts.unit_size == "mm"),
394
                        safety_height=opts.safety_height,
395
                        toggle_spindle_status=opts.gcode_no_start_stop_spindle,
396
                        minimum_step_x=opts.gcode_minimum_step)
397 398 399 400 401 402 403 404 405 406 407 408 409
                generator.set_speed(opts.tool_feedrate, opts.tool_spindle_speed)
                path_mode = opts.gcode_path_mode
                PATH_MODES = pycam.Exporters.GCodeExporter.PATH_MODES
                if (path_mode == "continuous") \
                        and (not opts.gcode_motion_tolerance is None):
                    if opts.gcode_naive_tolerance == 0:
                        naive_tolerance = None
                    else:
                        naive_tolerance = opts.gcode_naive_tolerance
                    generator.set_path_mode(PATH_MODES["continuous"],
                            opts.gcode_motion_tolerance, naive_tolerance)
                else:
                    generator.set_path_mode(PATH_MODES[opts.gcode_path_mode])
410
                generator.add_moves(tp_obj.get_moves(opts.safety_height),
411
                        comment=tp_obj.get_meta_data())
412
                generator.finish()
413 414 415 416
                closer()
        if opts.export_task_config:
            handler, closer = get_output_handler(opts.export_task_config)
            if handler is None:
417
                return EXIT_CODES["write_output_failed"]
418
            print >> handler, tps.get_string()
419
            closer()
420 421
    # no error -> don't return a specific exit code
    return None
422

423 424 425

# define the commandline interface
if __name__ == "__main__":
426 427 428 429 430 431
    # The PyInstaller standalone executable requires this "freeze_support" call.
    # Otherwise we will see a warning regarding an invalid argument called
    # "--multiprocessing-fork". This problem can be triggered on single-core
    # systems with these arguments: "--enable-server --server-auth-key foo".
    if hasattr(multiprocessing, "freeze_support"):
        multiprocessing.freeze_support()
432 433
    parser = OptionParser(prog="PyCAM",
            usage="usage: pycam [options] [inputfile]\n\n" \
434 435 436 437
                + "Start the PyCAM toolpath generator. Supplying one of " \
                + "the '--export-?' parameters will cause PyCAM to start " \
                + "in batch mode. Most parameters are useful only for " \
                + "batch mode.",
438
            epilog="Take a look at the wiki for more information: " \
439 440
                + "http://sourceforge.net/apps/mediawiki/pycam/.\nBug reports" \
                + ": http://sf.net/tracker/?group_id=237831&atid=1104176")
441 442 443 444 445 446
    group_general = parser.add_option_group("General options")
    group_export = parser.add_option_group("Export formats",
            "Export the resulting toolpath or meta-data in various formats. " \
            + "These options trigger the non-interactive mode. Thus the GUI " \
            + "is disabled.")
    group_tool = parser.add_option_group("Tool definition",
447
            "Specify the tool parameters. The default tool is spherical and " \
448 449 450 451 452 453 454 455 456 457 458 459 460 461
            + "has a diameter of 1 unit. The default speeds are 1000 " \
            + "units/minute (feedrate) and 250 (spindle rotations per minute)")
    group_process = parser.add_option_group("Process definition",
            "Specify the process parameters: toolpath strategy, layer height," \
            + " and others. A typical roughing operation is configured by " \
            + "default.")
    group_bounds = parser.add_option_group("Boundary definition",
            "Specify the outer limits of the processing area (x/y/z). " \
            + "You may choose between 'relative_margin' (margin is given as " \
            + "percentage of the respective model dimension), 'fixed_margin' " \
            + "(margin for each face given in absolute units of length) " \
            + "and 'custom' (absolute coordinates of the bounding box - " \
            + "regardless of the model size and position). Negative values " \
            + "are allowed and can make sense (e.g. negative margin).")
462 463 464 465 466 467
    group_support_structure = parser.add_option_group("Support structure",
            "An optional support structure can be used to keep the object in " \
            + "place during the mill operation. The support structure can be " \
            + "removed manually afterwards. Various types of support " \
            + "structures are available. Support structures are disabled " \
            + "by default.")
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
    group_gcode = parser.add_option_group("GCode settings",
            "Specify some details of the generated GCode.")
    group_external_programs = parser.add_option_group("External programs",
            "Some optional external programs are used for format conversions.")
    # general options
    group_general.add_option("-c", "--config", dest="config_file",
            default=None, action="store", type="string",
            help="load a task settings file")
    group_general.add_option("", "--unit", dest="unit_size",
            default="mm", action="store", type="choice",
            choices=["mm", "inch"], help="choose 'mm' or 'inch' for all " \
            + "numbers. By default 'mm' is assumed.")
    group_general.add_option("", "--collision-engine", dest="collision_engine",
            default="triangles", action="store", type="choice",
            choices=["triangles", "ode"],
            help="choose a specific collision detection engine. The default " \
                    + "is 'triangles'. Use 'help' to get a list of possible " \
                    + "engines.")
    group_general.add_option("", "--boundary-mode", dest="boundary_mode",
            default="along", action="store", type="choice",
            choices=["inside", "along", "outside"],
            help="specify if the mill tool (including its radius) should " \
                    + "move completely 'inside', 'along' or 'outside' the " \
                    + "defined processing boundary.")
    group_general.add_option("", "--disable-psyco", dest="disable_psyco",
            default=False, action="store_true", help="disable the Psyco " \
494
                    + "just-in-time-compiler even if it is available")
495 496 497
    group_general.add_option("", "--number-of-processes",
            dest="parallel_processes", default=None, type="int", action="store",
            help="override the default detection of multiple CPU cores. " \
498 499 500
                    + "Parallel processing only works with Python 2.6 (or " \
                    + "later) or with the additional 'multiprocessing' " \
                    + "module.")
501 502 503
    group_general.add_option("", "--enable-server", dest="enable_server",
            default=False, action="store_true", help="enable a local server " \
                    + "and (optionally) remote worker servers.")
504 505 506 507 508 509 510 511 512 513 514 515
    group_general.add_option("", "--remote-server", dest="remote_server",
            default=None, action="store", type="string", help="Connect to a " \
                    + "remote task server to distribute the processing load. " \
                    + "The server is given as an IP or a hostname with an " \
                    + "optional port (default: 1250) separated by a colon.")
    group_general.add_option("", "--start-server-only", dest="start_server",
            default=False, action="store_true", help="Start only a local " \
                    + "server for handling remote requests.")
    group_general.add_option("", "--server-auth-key", dest="server_authkey",
            default="", action="store", type="string", help="Secret used for " \
                    + "connecting to a remote server or for granting access " \
                    + "to remote clients.")
516
    group_general.add_option("-q", "--quiet", dest="quiet",
517 518
            default=False, action="store_true", help="output only warnings " \
            + "and errors.")
519 520 521 522 523 524 525 526 527 528 529 530
    group_general.add_option("-d", "--debug", dest="debug",
            default=False, action="store_true", help="enable output of debug " \
            + "messages.")
    group_general.add_option("", "--progress", dest="progress",
            default="text", action="store", type="choice",
            choices=["none", "text", "bar", "dot"],
            help="specify the type of progress bar used in non-GUI mode. " \
            + "The following options are available: text, none, bar, dot.")
    group_general.add_option("", "--profiling", dest="profile_destination",
            action="store", type="string",
            help="store profiling statistics in a file (only for debugging)")
    group_general.add_option("-v", "--version", dest="show_version",
531
            default=False, action="store_true", help="output the current " \
532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
            + "version of PyCAM and exit")
    # export options
    group_export.add_option("", "--export-gcode", dest="export_gcode",
            default=None, action="store", type="string",
            help="export the generated toolpaths to a file")
    group_export.add_option("", "--export-task-config",
            dest="export_task_config", default=None, action="store",
            type="string",
            help="export the current task configuration (mainly for debugging)")
    # tool options
    group_tool.add_option("", "--tool-shape", dest="tool_shape",
            default="cylindrical", action="store", type="choice",
            choices=["cylindrical", "spherical", "toroidal"],
            help="tool shape for the operation (cylindrical, spherical, " \
            + "toroidal)")
    group_tool.add_option("", "--tool-size", dest="tool_diameter",
            default=1.0, action="store", type="float",
            help="diameter of the tool")
    group_tool.add_option("", "--tool-torus-size", dest="tool_torus_diameter",
            default=0.25, action="store", type="float",
            help="torus diameter of the tool (only for toroidal tool shape)")
    group_tool.add_option("", "--tool-feedrate", dest="tool_feedrate",
            default=1000, action="store", type="float",
            help="allowed movement velocity of the tool (units/minute)")
    group_tool.add_option("", "--tool-spindle-speed", dest="tool_spindle_speed",
            default=250, action="store", type="float",
            help="rotation speed of the tool (per minute)")
    group_tool.add_option("", "--tool-id", dest="tool_id",
            default=1, action="store", type="int",
            help="tool ID - to be used for tool selection via GCode " \
            + "(default: 1)")
    # process options
    group_process.add_option("", "--process-path-direction",
            dest="process_path_direction", default="x", action="store",
            type="choice", choices=["x", "y", "xy"],
            help="primary direction of the generated toolpath (x/y/xy)")
568 569 570 571
    group_process.add_option("", "--process-path-strategy",
            dest="process_path_strategy", default="surface", action="store",
            type="choice", choices=["layer", "contour-follow",
                    "contour-polygon", "surface", "engrave"],
572
            help="one of the available toolpath strategies (layer, surface, " \
573
            + "contour-follow, contour-polygon, engrave)")
574 575 576 577 578 579 580 581 582 583 584 585
    group_process.add_option("", "--process-material-allowance",
            dest="process_material_allowance", default=0.0, action="store",
            type="float", help="minimum distance between the tool and the " \
            + "object (for rough processing)")
    group_process.add_option("", "--process-step-down",
            dest="process_step_down", default=3.0, action="store", type="float",
            help="the maximum thickness of each processed material layer " \
            + "(only for 'layer' strategy)")
    group_process.add_option("", "--process-overlap-percent",
            dest="process_overlap_percent", default=0, action="store",
            type="int", help="how much should two adjacent parallel " \
            + "toolpaths overlap each other (0..99)")
586 587 588 589 590
    group_process.add_option("", "--process-milling-style",
            dest="process_milling_style", default="ignore",
            action="store", type="choice",
            choices=["ignore", "conventional", "climb"],
            help="milling style (conventional / climb / ignore)")
591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
    group_process.add_option("", "--safety-height", dest="safety_height",
            default=25.0, action="store", type="float",
            help="height for safe re-positioning moves")
    group_process.add_option("", "--process-engrave-offset",
            dest="process_engrave_offset", default=0.0, action="store",
            type="float", help="engrave along the contour of a model with a " \
            + "given distance (only for 'engrave' strategy)")
    # bounds settings
    group_bounds.add_option("", "--bounds-type", dest="bounds_type",
            default="fixed-margin", action="store", type="choice",
            choices=["relative-margin", "fixed-margin", "custom"],
            help="type of the boundary definition (relative-margin, " \
            + "fixed-margin, custom)")
    group_bounds.add_option("", "--bounds-lower", dest="bounds_lower",
            default="", action="store", type="string",
            help="comma-separated x/y/z combination of the lower boundary " \
            + "(e.g. '4,4,-0.5')")
    group_bounds.add_option("", "--bounds-upper", dest="bounds_upper",
            default="", action="store", type="string",
            help="comma-separated x/y/z combination of the upper boundary " \
            + "(e.g. '12,5.5,0')")
    # support grid settings
613 614 615 616 617 618 619 620 621 622 623 624
    group_support_structure.add_option("", "--support-type",
            dest="support_type", default="none", type="choice", action="store",
            choices=["none", "grid", "distributed-edges",
                    "distributed-corners"],
            help="type of the support structure (default: none)")
    group_support_structure.add_option("", "--support-profile-height",
            dest="support_profile_height", default=2.0, action="store",
            type="float", help="height of the support profile")
    group_support_structure.add_option("", "--support-profile-thickness",
            dest="support_profile_thickness", default=0.5, action="store",
            type="float", help="width of the support profile")
    group_support_structure.add_option("", "--support-grid-distance-x",
625 626
            dest="support_grid_distance_x", default=10.0, action="store",
            type="float", help="distance along the x-axis between two " \
627 628 629
            + "adjacent parallel lines of the support structure" \
            + "(only for grid type)")
    group_support_structure.add_option("", "--support-grid-distance-y",
630 631
            dest="support_grid_distance_y", default=10.0, action="store",
            type="float", help="distance along the y-axis between two " \
632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
            + "adjacent parallel lines of the support structure " \
            + "(only for grid type)")
    group_support_structure.add_option("", "--support-grid-offset-x",
            dest="support_grid_offset_x", default=0.0, action="store",
            type="float", help="shift the support grid along the x axis")
    group_support_structure.add_option("", "--support-grid-offset-y",
            dest="support_grid_offset_y", default=0.0, action="store",
            type="float", help="shift the support grid along the y axis")
    group_support_structure.add_option("", "--support-distributed-distance",
            dest="support_distributed_distance", default=30.0, action="store",
            type="float", help="average distance between two adjacent " \
            + "support bridges")
    group_support_structure.add_option("", "--support-distributed-minimum",
            dest="support_distributed_minimum", default=2, action="store",
            type="int", help="minimum number of support bridges per polygon")
    group_support_structure.add_option("", "--support-distributed-length",
            dest="support_distributed_length", default=5.0, action="store",
            type="float", help="length of each support bridge")
650 651 652 653 654
    # gcode options
    group_gcode.add_option("", "--gcode-no-start-stop-spindle",
            dest="gcode_no_start_stop_spindle", default=True,
            action="store_false", help="do not start the spindle before " \
            + "and stop it after each operation (M3/M5)")
655
    group_gcode.add_option("", "--gcode-minimum-step",
656
            dest="gcode_minimum_step", default=0.00001,
657 658
            type="float", action="store", help="mimimum axial distance " \
            + "between two machine positions. Any shorter move is not " \
659
            + "written to GCode (default: 0.00001).")
660 661 662
    group_gcode.add_option("", "--gcode-path-mode", dest="gcode_path_mode",
            default="exact_path", action="store", type="choice",
            choices=["exact_path", "exact_stop", "continuous"],
663 664 665 666 667
            help="choose the GCode path mode from 'exact_path', 'exact_stop' " \
            + "and 'continuous'. Use '--gcode-motion-tolerance' and " \
            + "and '--gcode-naive-tolerance' if you want to limit the " \
            + "deviation. See http://linuxcnc.org/docs/html/gcode_main.html " \
            + "(G61) for details.")
668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
    group_gcode.add_option("", "--gcode-motion-tolerance",
            dest="gcode_motion_tolerance", default=None,
            action="store", help="the optional motion tolerance for " \
            + "'continuous' path mode (G64).")
    group_gcode.add_option("", "--gcode-naive-tolerance",
            dest="gcode_naive_tolerance", default=None,
            action="store", help="the optional naive CAM tolerance for " \
            + "'continuous' path mode (G64).")
    # external program settings
    group_external_programs.add_option("", "--location-inkscape",
            dest="external_program_inkscape", default="", action="store",
            type="string", help="location of the Inkscape executable. " \
            + "This program is required for importing SVG files.")
    group_external_programs.add_option("", "--location-pstoedit",
            dest="external_program_pstoedit", default="", action="store",
            type="string", help="location of the PStoEdit executable. " \
            + "This program is required for importing SVG files.")
    (opts, args) = parser.parse_args()

687 688 689
    try:
        if opts.profile_destination:
            import cProfile
690
            exit_code = cProfile.run('execute(parser, opts, args, pycam)',
691
                    opts.profile_destination)
692 693 694
        else:
            # We need to add the parameter "pycam" to avoid weeeeird namespace
            # issues. Any idea how to fix this?
695
            exit_code = execute(parser, opts, args, pycam)
696 697
    except KeyboardInterrupt:
        log.info("Quit requested")
698
        exit_code = None
699
    pycam.Utils.threading.cleanup()
700 701 702 703
    if not exit_code is None:
        sys.exit(exit_code)
    else:
        sys.exit(EXIT_CODES["ok"])
704