installation.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324
  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>Installation &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="index.html"/>
  30. <link rel="next" title="Basics" href="basics.html"/>
  31. <link rel="prev" title="Introduction" href="introduction.html"/>
  32. <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
  33. <script>
  34. (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
  35. (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
  36. m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
  37. })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
  38. ga('create', 'UA-55008703-1', 'auto');
  39. ga('send', 'pageview');
  40. </script>
  41. </head>
  42. <body class="wy-body-for-nav" role="document">
  43. <div class="wy-grid-for-nav">
  44. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  45. <div class="wy-side-nav-search" style="background-color: #3d3d3d;">
  46. <!--<a href="index.html" class="icon icon-home"> FlatCAM</a>-->
  47. <!--<a href="http://flatcam.org" class="icon icon-home"> FlatCAM</a>-->
  48. <a href="http://flatcam.org">
  49. <img src="http://flatcam.org/static/images/fcweblogo1.png"
  50. style="height: auto;
  51. width: auto;
  52. border-radius: 0px;
  53. background-color: #3d3d3d;
  54. margin: auto">
  55. </a>
  56. <div role="search">
  57. <form id ="rtd-search-form" class="wy-form" action="search.html" method="get">
  58. <input type="text" name="q" placeholder="Search docs" />
  59. <input type="hidden" name="check_keywords" value="yes" />
  60. <input type="hidden" name="area" value="default" />
  61. </form>
  62. </div>
  63. </div>
  64. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  65. <ul class="current">
  66. <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
  67. <li class="toctree-l1 current"><a class="current reference internal" href="">Installation</a><ul>
  68. <li class="toctree-l2"><a class="reference internal" href="#windows-installer">Windows Installer</a></li>
  69. <li class="toctree-l2"><a class="reference internal" href="#ubuntu">Ubuntu</a></li>
  70. <li class="toctree-l2"><a class="reference internal" href="#os-x">OS-X</a></li>
  71. <li class="toctree-l2"><a class="reference internal" href="#manual-installation">Manual Installation</a></li>
  72. </ul>
  73. </li>
  74. <li class="toctree-l1"><a class="reference internal" href="basics.html">Basics</a><ul>
  75. <li class="toctree-l2"><a class="reference internal" href="basics.html#source-files">Source Files</a></li>
  76. <li class="toctree-l2"><a class="reference internal" href="basics.html#objects-and-tasks">Objects and Tasks</a></li>
  77. <li class="toctree-l2"><a class="reference internal" href="basics.html#creating-saving-and-loading-projects">Creating, Saving and Loading Projects</a></li>
  78. <li class="toctree-l2"><a class="reference internal" href="basics.html#navigating-plots">Navigating Plots</a></li>
  79. </ul>
  80. </li>
  81. <li class="toctree-l1"><a class="reference internal" href="procedures.html">Common Procedures</a><ul>
  82. <li class="toctree-l2"><a class="reference internal" href="procedures.html#isolation-routing">Isolation Routing</a></li>
  83. <li class="toctree-l2"><a class="reference internal" href="procedures.html#wide-isolation-routing">Wide Isolation Routing</a></li>
  84. <li class="toctree-l2"><a class="reference internal" href="procedures.html#cnc-jobs-for-drill-files">CNC Jobs for Drill Files</a></li>
  85. <li class="toctree-l2"><a class="reference internal" href="procedures.html#side-pcb">2-side PCB</a></li>
  86. <li class="toctree-l2"><a class="reference internal" href="procedures.html#copper-area-clear">Copper Area Clear</a></li>
  87. <li class="toctree-l2"><a class="reference internal" href="procedures.html#board-cutout">Board Cutout</a></li>
  88. <li class="toctree-l2"><a class="reference internal" href="procedures.html#bed-flattening">Bed Flattening</a></li>
  89. </ul>
  90. </li>
  91. <li class="toctree-l1"><a class="reference internal" href="editor.html">Geometry Editor</a><ul>
  92. <li class="toctree-l2"><a class="reference internal" href="editor.html#introduction">Introduction</a></li>
  93. <li class="toctree-l2"><a class="reference internal" href="editor.html#creating-new-geometry-objects">Creating New Geometry Objects</a></li>
  94. <li class="toctree-l2"><a class="reference internal" href="editor.html#editing-existing-geometry-objects">Editing Existing Geometry Objects</a></li>
  95. </ul>
  96. </li>
  97. <li class="toctree-l1"><a class="reference internal" href="flatcamshell.html">Shell Command Line Interface</a><ul>
  98. <li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#calling-a-shell-script-on-startup">Calling a Shell script on startup</a></li>
  99. <li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#the-shell-window">The Shell Window</a></li>
  100. <li class="toctree-l2"><a class="reference internal" href="flatcamshell.html#shell-language">Shell Language</a></li>
  101. </ul>
  102. </li>
  103. <li class="toctree-l1"><a class="reference internal" href="cmdreference.html">Shell Command Reference</a><ul>
  104. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-circle">add_circle</a></li>
  105. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-poly">add_poly</a></li>
  106. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#add-rect">add_rect</a></li>
  107. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#cncjob">cncjob</a></li>
  108. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#cutout">cutout</a></li>
  109. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#delete">delete</a></li>
  110. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#drillcncjob">drillcncjob</a></li>
  111. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#follow">follow</a></li>
  112. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#geo-union">geo_union</a></li>
  113. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#get-names">get_names</a></li>
  114. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#help">help</a></li>
  115. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#isolate">isolate</a></li>
  116. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#make-docs">make_docs</a></li>
  117. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#new">new</a></li>
  118. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#mirror">mirror</a></li>
  119. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#new-geometry">new_geometry</a></li>
  120. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#offset">offset</a></li>
  121. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#open-excellon">open_excellon</a></li>
  122. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#open-gcode">open_gcode</a></li>
  123. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#open-gerber">open_gerber</a></li>
  124. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#open-project">open_project</a></li>
  125. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#options">options</a></li>
  126. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#paint-poly">paint_poly</a></li>
  127. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#plot">plot</a></li>
  128. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#save-project">save_project</a></li>
  129. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#scale">scale</a></li>
  130. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#set-active">set_active</a></li>
  131. <li class="toctree-l2"><a class="reference internal" href="cmdreference.html#write-gcode">write_gcode</a></li>
  132. </ul>
  133. </li>
  134. </ul>
  135. </div>
  136. &nbsp;
  137. </nav>
  138. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  139. <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
  140. <i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
  141. <a href="index.html">FlatCAM</a>
  142. </nav>
  143. <div class="wy-nav-content">
  144. <div class="rst-content">
  145. <div role="navigation" aria-label="breadcrumbs navigation">
  146. <ul class="wy-breadcrumbs">
  147. <li><a href="index.html">Docs</a> &raquo;</li>
  148. <li>Installation</li>
  149. <li class="wy-breadcrumbs-aside">
  150. <a href="_sources/installation.txt" rel="nofollow"> View page source</a>
  151. </li>
  152. </ul>
  153. <hr/>
  154. </div>
  155. <div role="main">
  156. <div class="section" id="installation">
  157. <h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
  158. <div class="section" id="windows-installer">
  159. <h2>Windows Installer<a class="headerlink" href="#windows-installer" title="Permalink to this headline">¶</a></h2>
  160. <p>Download the installer from the <a class="reference external" href="https://bitbucket.org/jpcgt/flatcam/downloads">repository</a> and run it in your machine.
  161. It includes everything you need.</p>
  162. </div>
  163. <div class="section" id="ubuntu">
  164. <h2>Ubuntu<a class="headerlink" href="#ubuntu" title="Permalink to this headline">¶</a></h2>
  165. <p>FlatCAM should work on most Linux distributions but Ubuntu has been
  166. chosen as the test platform.</p>
  167. <p>There are several dependencies required to run FlatCAM. These are
  168. listed in the following section. Before attempting a manual installation,
  169. try running the provided setup script <tt class="docutils literal"><span class="pre">setup_ubuntu.sh</span></tt> that will
  170. download and install required packages.</p>
  171. </div>
  172. <div class="section" id="os-x">
  173. <h2>OS-X<a class="headerlink" href="#os-x" title="Permalink to this headline">¶</a></h2>
  174. <p>See manual instructions below.</p>
  175. </div>
  176. <div class="section" id="manual-installation">
  177. <h2>Manual Installation<a class="headerlink" href="#manual-installation" title="Permalink to this headline">¶</a></h2>
  178. <div class="section" id="requirements">
  179. <h3>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h3>
  180. <ul class="simple">
  181. <li>Python 2.7 32-bit</li>
  182. <li>PyQt 4</li>
  183. <li>Matplotlib 1.3.1</li>
  184. <li>Numpy 1.8</li>
  185. <li><a class="reference external" href="https://pypi.python.org/pypi/Shapely">Shapely 1.3</a><ul>
  186. <li>GEOS</li>
  187. </ul>
  188. </li>
  189. <li>RTree<ul>
  190. <li>SpatialIndex</li>
  191. </ul>
  192. </li>
  193. </ul>
  194. <p>These packages might have their own dependencies.</p>
  195. </div>
  196. <div class="section" id="linux">
  197. <h3>Linux<a class="headerlink" href="#linux" title="Permalink to this headline">¶</a></h3>
  198. <p>Under Linux, most modern package installers like <strong>yum</strong> or <strong>apt-get</strong>
  199. will attempt to locate and install the whole tree of dependencies for a
  200. specified package automatically. Refer to the provided setup script
  201. <tt class="docutils literal"><span class="pre">setup_ubuntu.sh</span></tt> for the names and installation order.</p>
  202. <p>Once the dependencies are installed, download the latest .zip release
  203. (or the latest source, although it is not garanteed to work), unpack it,
  204. change into the created folder and run:</p>
  205. <div class="highlight-python"><pre>Python FlatCAM.py</pre>
  206. </div>
  207. </div>
  208. <div class="section" id="windows">
  209. <h3>Windows<a class="headerlink" href="#windows" title="Permalink to this headline">¶</a></h3>
  210. <p>An easy way to get the requirements in your system is to install <a class="reference external" href="http://winpython.sourceforge.net/">WinPython</a>.
  211. This is a standalone distribution of Python which includes all of FlatCAM&#8217;s
  212. dependencies, except for Shapely and RTree. These can be found here:
  213. <a class="reference external" href="http://www.lfd.uci.edu/~gohlke/pythonlibs/">Unofficial Windows Binaries for Python Extension Packages</a>.</p>
  214. <p>Once the dependencies are installed, download the latest .zip
  215. release (or the latest source, although it is not garanteed to work),
  216. unpack it, change into the created folder and run:</p>
  217. <div class="highlight-python"><pre>python FlatCAM.py</pre>
  218. </div>
  219. </div>
  220. <div class="section" id="id1">
  221. <h3>OS-X<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
  222. <p>Start by installing binary packages: pyqt, geos, spatialindex.
  223. One way to do this is using <a class="reference external" href="http://brew.sh">Homebrew</a>:</p>
  224. <div class="highlight-python"><pre>brew install name_of_package</pre>
  225. </div>
  226. <p>Now you can install all Python packages (numpy, matplotlib, rtree, scipy,
  227. shapely, simplejson) using pip:</p>
  228. <div class="highlight-python"><pre>pip install name_of_package</pre>
  229. </div>
  230. <p>Finally, download the latest FlatCAM .zip package or source code. Change into
  231. its directory and launch it by running:</p>
  232. <div class="highlight-python"><pre>python FlatCAM.py</pre>
  233. </div>
  234. </div>
  235. </div>
  236. </div>
  237. </div>
  238. <footer>
  239. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  240. <a href="basics.html" class="btn btn-neutral float-right" title="Basics"/>Next <span class="icon icon-circle-arrow-right"></span></a>
  241. <a href="introduction.html" class="btn btn-neutral" title="Introduction"><span class="icon icon-circle-arrow-left"></span> Previous</a>
  242. </div>
  243. <hr/>
  244. <div role="contentinfo">
  245. <p>
  246. &copy; Copyright 2014, Juan Pablo Caram.
  247. </p>
  248. </div>
  249. <a href="https://github.com/snide/sphinx_rtd_theme">Sphinx theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>
  250. </footer>
  251. </div>
  252. </div>
  253. </section>
  254. </div>
  255. </body>
  256. </html>