README.md

   1 Cura
   2 ====
   3
   4 If you are reading this, then you are looking at the *development* version of Cura. If you just want to use Cura look at the following location: https://github.com/daid/Cura/wiki
   5
   6 Development
   7 ===========
   8
   9 Cura is developed in Python. Getting Cura up and running for development is not very difficult. If you copy the python and pypy from a release into your Cura development checkout then you can use Cura right away, just like you would with a release.
  10 For development with git, check the help on github. Pull requests is the fastest way to get changes into Cura.
  11
  12
  13 Packaging
  14 ---------
  15
  16 Cura development comes with a script "package.sh", this script has been designed to run under unix like OSes (Linux, MacOS). Running it from sygwin is not a priority.
  17 The "package.sh" script generates a final release package. You should not need it during development, unless you are changing the release process. If you want to distribute your own version of Cura, then the package.sh script will allow you to do that.
  18
  19 Debian and Ubuntu Linux
  20 --------
  21
  22 To build and install Cura, run the following commands:
  23
  24 ```bash
  25 git clone https://github.com/daid/Cura.git
  26
  27 sudo apt-get install python-opengl
  28 sudo apt-get install python-numpy
  29 sudo apt-get install python-serial
  30 sudo apt-get install python-setuptools
  31 sudo apt-get install cx-freeze
  32
  33 cd Cura
  34
  35 sudo ./package.sh debian
  36
  37 sudo dpkg -i ./scripts/linux/Cura*.deb
  38 ```
  39
  40 Mac OS X
  41 --------
  42 The following section describes how to prepare working environment for developing and packaing for Mac OS X.
  43 The working environment consist of build of Python, build of wxPython and all required Python packages.
  44
  45 We assume you already have Apple hardware with [64bit processor](http://support.apple.com/kb/HT3696) and you are familiar with tools like [virtualenv](http://pypi.python.org/pypi/virtualenv), [virtualenvwrapper](http://virtualenvwrapper.readthedocs.org/en/latest/) and [pip](http://www.pip-installer.org/en/latest/). Also ensure you have modern compiler installed.
  46
  47
  48 ###Install Python
  49 You'll need **non-system**, **framework-based**, **universal** with **deployment target set to 10.6** build of Python 2.7
  50
  51 **non-system**: Output of
  52 `python -c "import sys; print sys.prefix"`
  53 should *not* start with *"/System/Library/Frameworks/Python.framework/"*.
  54
  55 **framework-based**: Output of
  56 `python -c "import distutils.sysconfig as c; print(c.get_config_var('PYTHONFRAMEWORK'))"`
  57 should be non-empty string. E.g. *Python*.
  58
  59 **universal**: Output of
  60 ``lipo -info `which python` ``
  61 should include both i386 and x86_64. E.g *"Architectures in the fat file: /usr/local/bin/python are: i386 x86_64"*.
  62
  63 **deployment target set to 10.6**: Output of
  64 ``otool -l `which python` ``
  65 should contain *"cmd LC_VERSION_MIN_MACOSX ... version 10.6"*.
  66
  67 The easiest way to install it is via [Homebrew](http://mxcl.github.com/homebrew/) using the formula from Cura's repo:
  68 `brew install --build-bottle --fresh Cura/scripts/darwin/python.rb --universal`
  69 Note if you already have Python installed via Homebrew, you have to uninstall it first.
  70
  71 You can also install [official build](http://www.python.org/ftp/python/2.7.3/python-2.7.3-macosx10.6.dmg).
  72
  73
  74 ###Configure Virtualenv
  75 Create new virtualenv. If you have [virtualenvwrapper](http://virtualenvwrapper.readthedocs.org/en/latest/) installed:
  76 `mkvirtualenv Cura`
  77
  78 wxPython cannot be installed via pip, we have to build it from source by specifing prefix to our virtualenv.
  79
  80 Assuming you have virtualenv at *~/.virtualenvs/Cura/* and [wxPython sources](http://sourceforge.net/projects/wxpython/files/wxPython/2.9.4.0/wxPython-src-2.9.4.0.tar.bz2) at *~/Downloads/wxPython-src-2.9.4.0/*:
  81
  82 1. `cd` into *~/Downloads/wxPython-src-2.9.4.0/* and configure the sources:
  83
  84         ./configure \
  85         CFLAGS='-msse2 -mno-sse3 -mno-sse4' \
  86         CXXFLAGS='-msse2 -mno-sse3 -mno-sse4' \
  87         --disable-debug \
  88         --enable-clipboard \
  89         --enable-display \
  90         --enable-dnd \
  91         --enable-monolithic \
  92         --enable-optimise \
  93         --enable-std_string \
  94         --enable-svg \
  95         --enable-unicode \
  96         --enable-universal_binary=i386,x86_64 \
  97         --enable-webkit \
  98         --prefix=$HOME/.virtualenvs/Cura/ \
  99         --with-expat \
 100         --with-libjpeg=builtin \
 101         --with-libpng=builtin \
 102         --with-libtiff=builtin \
 103         --with-macosx-version-min=10.6 \
 104         --with-opengl \
 105         --with-osx_cocoa \
 106         --with-zlib=builtin
 107
 108 2. `make install`
 109     Note to speedup the process I recommend you to enable multicore build by adding the -j*cores* flag:
 110     `make -j4 install`
 111 3. `cd` into *~/Downloads/wxPython-src-2.9.4.0/wxPython/*
 112 4. Build wxPython (Note `python` is the python of your virtualenv):
 113
 114         python setup.py build_ext \
 115         BUILD_GIZMOS=1 \
 116         BUILD_GLCANVAS=1 \
 117         BUILD_STC=1 \
 118         INSTALL_MULTIVERSION=0 \
 119         UNICODE=1 \
 120         WX_CONFIG=$HOME/.virtualenvs/Cura/bin/wx-config \
 121         WXPORT=osx_cocoa
 122
 123 5. Install wxPython (Note `python` is the python of your virtualenv):
 124
 125         python setup.py install \
 126         --prefix=$HOME/.virtualenvs/Cura \
 127         BUILD_GIZMOS=1 \
 128         BUILD_GLCANVAS=1 \
 129         BUILD_STC=1 \
 130         INSTALL_MULTIVERSION=0 \
 131         UNICODE=1 \
 132         WX_CONFIG=$HOME/.virtualenvs/Cura/bin/wx-config \
 133         WXPORT=osx_cocoa
 134
 135 6. Create file *~/.virtualenvs/Cura/bin/pythonw* with the following content:
 136
 137         #!/bin/bash
 138         ENV=`python -c "import sys; print sys.prefix"`
 139         PYTHON=`python -c "import sys; print sys.real_prefix"`/bin/python
 140         export PYTHONHOME=$ENV
 141         exec $PYTHON "$@"
 142
 143 At this point virtualenv is configured for wxPython development.
 144 Remember to use `python` for pacakging and `pythonw` to run app for debugging.
 145
 146
 147 ###Install Python Packages
 148 Required python packages are specified in *requirements.txt* and *requirements_darwin.txt*
 149 If you use virtualenv, installing requirements as easy as `pip install -r requirements_darwin.txt`
 150
 151
 152 ###Package Cura into application
 153 Ensure that virtualenv is activated, so `python` points to the python of your virtualenv (e.g. ~/.virtualenvs/Cura/bin/python).Use package.sh to build Cura:
 154 `./package.sh darwin`
 155
 156 Note that application is only guaranteed to work on Mac OS X version used to build and higher, but may not support lower versions.
 157 E.g. Cura built on 10.8 will work on 10.8 and 10.7, but not on 10.6. In other hand, Cura built on 10.6 will work on 10.6, 10.7 and 10.8.
 158