bartool/flatcam-wsl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added OS-X installation instructions to manual.

Browse Source
This commit is contained in:
jpcaram
2014-12-27 15:12:49 -05:00
parent 6fae5258db
commit a0d6d1a6a9
5 changed files with 141 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
manual/installation.rst
View File

@@ -4,16 +4,27 @@ Installation
Windows Installer
-----------------
Download the installer from the repository_ and run it in your machine. It includes everything you need.
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.
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.
OS-X
----
See manual instructions below.
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
-------------------
@@ -26,6 +37,9 @@ Requirements
* Matplotlib 1.3.1
* Numpy 1.8
* `Shapely 1.3`_
* GEOS
* RTree
* SpatialIndex
.. _Shapely 1.3: https://pypi.python.org/pypi/Shapely
@@ -34,9 +48,14 @@ 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.
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::
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
@@ -44,11 +63,36 @@ Once the dependencies are installed, download the latest .zip release (or the la
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.
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::
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
python FlatCAM.py
OS-X
~~~~
Start by installing binary packages: pyqt, geos, spatialindex.
One way to do this is using Homebrew_::
brew install name_of_package
.. _Homebrew: http://brew.sh
Now you can install all Python packages (numpy, matplotlib, rtree, scipy,
shapely, simplejson) using pip::
pip install name_of_package
Finally, download the latest FlatCAM .zip package or source code. Change into
its directory and launch it by running::
python FlatCAM.py