index.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313
  1. <!DOCTYPE html>
  2. <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
  3. <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
  4. <head>
  5. <meta charset="utf-8">
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <title>Welcome to FlatCAM’s documentation! &mdash; FlatCAM 7 documentation</title>
  8. <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
  9. <script type="text/javascript">
  10. var DOCUMENTATION_OPTIONS = {
  11. URL_ROOT:'./',
  12. VERSION:'7',
  13. COLLAPSE_INDEX:false,
  14. FILE_SUFFIX:'.html',
  15. HAS_SOURCE: true
  16. };
  17. </script>
  18. <script type="text/javascript" src="_static/jquery.js"></script>
  19. <script type="text/javascript" src="_static/underscore.js"></script>
  20. <script type="text/javascript" src="_static/doctools.js"></script>
  21. <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
  22. <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  23. <script type="text/javascript" src="_static/js/theme.js"></script>
  24. <script type="text/javascript">
  25. jQuery(function () {
  26. SphinxRtdTheme.StickyNav.enable();
  27. });
  28. </script>
  29. <link rel="top" title="FlatCAM 7 documentation" href="#"/>
  30. <link rel="next" title="Introduction" href="introduction.html"/>
  31. <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
  32. <script>
  33. (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
  34. (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
  35. m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
  36. })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
  37. ga('create', 'UA-55008703-1', 'auto');
  38. ga('send', 'pageview');
  39. </script>
  40. </head>
  41. <body class="wy-body-for-nav" role="document">
  42. <div class="wy-grid-for-nav">
  43. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  44. <div class="wy-side-nav-search" style="background-color: #3d3d3d;">
  45. <!--<a href="#" class="icon icon-home"> FlatCAM</a>-->
  46. <!--<a href="http://flatcam.org" class="icon icon-home"> FlatCAM</a>-->
  47. <a href="http://flatcam.org">
  48. <img src="http://flatcam.org/static/images/fcweblogo1.png"
  49. style="height: auto;
  50. width: auto;
  51. border-radius: 0px;
  52. background-color: #3d3d3d;
  53. margin: auto">
  54. </a>
  55. <div role="search">
  56. <form id ="rtd-search-form" class="wy-form" action="search.html" method="get">
  57. <input type="text" name="q" placeholder="Search docs" />
  58. <input type="hidden" name="check_keywords" value="yes" />
  59. <input type="hidden" name="area" value="default" />
  60. </form>
  61. </div>
  62. </div>
  63. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  64. <ul>
  65. <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
  66. <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
  67. <li class="toctree-l2"><a class="reference internal" href="installation.html#windows-installer">Windows Installer</a></li>
  68. <li class="toctree-l2"><a class="reference internal" href="installation.html#ubuntu">Ubuntu</a></li>
  69. <li class="toctree-l2"><a class="reference internal" href="installation.html#manual-installation">Manual Installation</a></li>
  70. </ul>
  71. </li>
  72. <li class="toctree-l1"><a class="reference internal" href="basics.html">Basics</a><ul>
  73. <li class="toctree-l2"><a class="reference internal" href="basics.html#source-files">Source Files</a></li>
  74. <li class="toctree-l2"><a class="reference internal" href="basics.html#objects-and-tasks">Objects and Tasks</a></li>
  75. <li class="toctree-l2"><a class="reference internal" href="basics.html#creating-saving-and-loading-projects">Creating, Saving and Loading Projects</a></li>
  76. <li class="toctree-l2"><a class="reference internal" href="basics.html#navigating-plots">Navigating Plots</a></li>
  77. </ul>
  78. </li>
  79. <li class="toctree-l1"><a class="reference internal" href="procedures.html">Common Procedures</a><ul>
  80. <li class="toctree-l2"><a class="reference internal" href="procedures.html#isolation-routing">Isolation Routing</a></li>
  81. <li class="toctree-l2"><a class="reference internal" href="procedures.html#wide-isolation-routing">Wide Isolation Routing</a></li>
  82. <li class="toctree-l2"><a class="reference internal" href="procedures.html#cnc-jobs-for-drill-files">CNC Jobs for Drill Files</a></li>
  83. <li class="toctree-l2"><a class="reference internal" href="procedures.html#side-pcb">2-side PCB</a></li>
  84. <li class="toctree-l2"><a class="reference internal" href="procedures.html#copper-area-clear">Copper Area Clear</a></li>
  85. <li class="toctree-l2"><a class="reference internal" href="procedures.html#board-cutout">Board Cutout</a></li>
  86. <li class="toctree-l2"><a class="reference internal" href="procedures.html#bed-flattening">Bed Flattening</a></li>
  87. </ul>
  88. </li>
  89. <li class="toctree-l1"><a class="reference internal" href="editor.html">Geometry Editor</a><ul>
  90. <li class="toctree-l2"><a class="reference internal" href="editor.html#introduction">Introduction</a></li>
  91. <li class="toctree-l2"><a class="reference internal" href="editor.html#creating-new-geometry-objects">Creating New Geometry Objects</a></li>
  92. <li class="toctree-l2"><a class="reference internal" href="editor.html#editing-existing-geometry-objects">Editing Existing Geometry Objects</a></li>
  93. </ul>
  94. </li>
  95. <li class="toctree-l1"><a class="reference internal" href="flatcamshell.html">Shell Command Line Interface</a><ul>
  96. <li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#the-shell-window">The Shell Window</a></li>
  97. <li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#shell-language">Shell Language</a></li>
  98. </ul>
  99. </li>
  100. <li class="toctree-l1"><a class="reference internal" href="cmdreference.html">Shell Command Reference</a><ul>
  101. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-circle">add_circle</a></li>
  102. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-poly">add_poly</a></li>
  103. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-rect">add_rect</a></li>
  104. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#cncjob">cncjob</a></li>
  105. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#delete">delete</a></li>
  106. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#follow">follow</a></li>
  107. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#geo-union">geo_union</a></li>
  108. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#get-names">get_names</a></li>
  109. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#help">help</a></li>
  110. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#isolate">isolate</a></li>
  111. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#make-docs">make_docs</a></li>
  112. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#new">new</a></li>
  113. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#new-geometry">new_geometry</a></li>
  114. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#offset">offset</a></li>
  115. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#open-excellon">open_excellon</a></li>
  116. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#open-gcode">open_gcode</a></li>
  117. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#open-gerber">open_gerber</a></li>
  118. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#open-project">open_project</a></li>
  119. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#options">options</a></li>
  120. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#paint-poly">paint_poly</a></li>
  121. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#plot">plot</a></li>
  122. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#save-project">save_project</a></li>
  123. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#scale">scale</a></li>
  124. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#set-active">set_active</a></li>
  125. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#write-gcode">write_gcode</a></li>
  126. </ul>
  127. </li>
  128. </ul>
  129. </div>
  130. &nbsp;
  131. </nav>
  132. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  133. <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
  134. <i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
  135. <a href="#">FlatCAM</a>
  136. </nav>
  137. <div class="wy-nav-content">
  138. <div class="rst-content">
  139. <div role="navigation" aria-label="breadcrumbs navigation">
  140. <ul class="wy-breadcrumbs">
  141. <li><a href="#">Docs</a> &raquo;</li>
  142. <li>Welcome to FlatCAM&#8217;s documentation!</li>
  143. <li class="wy-breadcrumbs-aside">
  144. <a href="_sources/index.txt" rel="nofollow"> View page source</a>
  145. </li>
  146. </ul>
  147. <hr/>
  148. </div>
  149. <div role="main">
  150. <div class="section" id="welcome-to-flatcam-s-documentation">
  151. <h1>Welcome to FlatCAM&#8217;s documentation!<a class="headerlink" href="#welcome-to-flatcam-s-documentation" title="Permalink to this headline">¶</a></h1>
  152. <p>Contents:</p>
  153. <div class="toctree-wrapper compound">
  154. <ul>
  155. <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
  156. <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
  157. <li class="toctree-l2"><a class="reference internal" href="installation.html#windows-installer">Windows Installer</a></li>
  158. <li class="toctree-l2"><a class="reference internal" href="installation.html#ubuntu">Ubuntu</a></li>
  159. <li class="toctree-l2"><a class="reference internal" href="installation.html#manual-installation">Manual Installation</a></li>
  160. </ul>
  161. </li>
  162. <li class="toctree-l1"><a class="reference internal" href="basics.html">Basics</a><ul>
  163. <li class="toctree-l2"><a class="reference internal" href="basics.html#source-files">Source Files</a></li>
  164. <li class="toctree-l2"><a class="reference internal" href="basics.html#objects-and-tasks">Objects and Tasks</a></li>
  165. <li class="toctree-l2"><a class="reference internal" href="basics.html#creating-saving-and-loading-projects">Creating, Saving and Loading Projects</a></li>
  166. <li class="toctree-l2"><a class="reference internal" href="basics.html#navigating-plots">Navigating Plots</a></li>
  167. </ul>
  168. </li>
  169. <li class="toctree-l1"><a class="reference internal" href="procedures.html">Common Procedures</a><ul>
  170. <li class="toctree-l2"><a class="reference internal" href="procedures.html#isolation-routing">Isolation Routing</a></li>
  171. <li class="toctree-l2"><a class="reference internal" href="procedures.html#wide-isolation-routing">Wide Isolation Routing</a></li>
  172. <li class="toctree-l2"><a class="reference internal" href="procedures.html#cnc-jobs-for-drill-files">CNC Jobs for Drill Files</a></li>
  173. <li class="toctree-l2"><a class="reference internal" href="procedures.html#side-pcb">2-side PCB</a></li>
  174. <li class="toctree-l2"><a class="reference internal" href="procedures.html#copper-area-clear">Copper Area Clear</a></li>
  175. <li class="toctree-l2"><a class="reference internal" href="procedures.html#board-cutout">Board Cutout</a></li>
  176. <li class="toctree-l2"><a class="reference internal" href="procedures.html#bed-flattening">Bed Flattening</a></li>
  177. </ul>
  178. </li>
  179. <li class="toctree-l1"><a class="reference internal" href="editor.html">Geometry Editor</a><ul>
  180. <li class="toctree-l2"><a class="reference internal" href="editor.html#introduction">Introduction</a></li>
  181. <li class="toctree-l2"><a class="reference internal" href="editor.html#creating-new-geometry-objects">Creating New Geometry Objects</a></li>
  182. <li class="toctree-l2"><a class="reference internal" href="editor.html#editing-existing-geometry-objects">Editing Existing Geometry Objects</a></li>
  183. </ul>
  184. </li>
  185. <li class="toctree-l1"><a class="reference internal" href="flatcamshell.html">Shell Command Line Interface</a><ul>
  186. <li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#the-shell-window">The Shell Window</a></li>
  187. <li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#shell-language">Shell Language</a></li>
  188. </ul>
  189. </li>
  190. <li class="toctree-l1"><a class="reference internal" href="cmdreference.html">Shell Command Reference</a><ul>
  191. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-circle">add_circle</a></li>
  192. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-poly">add_poly</a></li>
  193. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-rect">add_rect</a></li>
  194. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#cncjob">cncjob</a></li>
  195. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#delete">delete</a></li>
  196. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#follow">follow</a></li>
  197. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#geo-union">geo_union</a></li>
  198. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#get-names">get_names</a></li>
  199. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#help">help</a></li>
  200. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#isolate">isolate</a></li>
  201. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#make-docs">make_docs</a></li>
  202. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#new">new</a></li>
  203. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#new-geometry">new_geometry</a></li>
  204. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#offset">offset</a></li>
  205. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#open-excellon">open_excellon</a></li>
  206. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#open-gcode">open_gcode</a></li>
  207. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#open-gerber">open_gerber</a></li>
  208. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#open-project">open_project</a></li>
  209. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#options">options</a></li>
  210. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#paint-poly">paint_poly</a></li>
  211. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#plot">plot</a></li>
  212. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#save-project">save_project</a></li>
  213. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#scale">scale</a></li>
  214. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#set-active">set_active</a></li>
  215. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#write-gcode">write_gcode</a></li>
  216. </ul>
  217. </li>
  218. </ul>
  219. </div>
  220. </div>
  221. <div class="section" id="indices-and-tables">
  222. <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
  223. <ul class="simple">
  224. <li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
  225. <li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li>
  226. <li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
  227. </ul>
  228. </div>
  229. </div>
  230. <footer>
  231. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  232. <a href="introduction.html" class="btn btn-neutral float-right" title="Introduction"/>Next <span class="icon icon-circle-arrow-right"></span></a>
  233. </div>
  234. <hr/>
  235. <div role="contentinfo">
  236. <p>
  237. &copy; Copyright 2014, Juan Pablo Caram.
  238. </p>
  239. </div>
  240. <a href="https://github.com/snide/sphinx_rtd_theme">Sphinx theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>
  241. </footer>
  242. </div>
  243. </div>
  244. </section>
  245. </div>
  246. </body>
  247. </html>