cura-build

This repository contains build scripts used to build Cura and all dependencies from scratch.

The build has a number of dependencies. Ideally, these dependencies should be installed by the cura-build-environment repository. Even with cura-build-environment though, some things may still be missing from your system that we haven't thought of.

Build with Docker (Linux and Windows)

To build Cura releases for Linux and Windows, you can use the cura-build-environment docker images. Check the repository for more details on how to build the docker images on Linux and Windows.

Build Cura Linux AppImage with Docker

Assume that you have a working cura-build-environment docker image. To build a Cura AppImage, you can use the commands below:

./scripts/linux/build.sh

This script by default uses a docker image tagged as cura-build-env:centos7 to build Cura AppImage, so make sure that your image is tagged accordingly. If the build is successful, the resulting AppImage and its checksum will be placed in the appimages/ directory. Check the script scripts/linux/build.sh for more details if you want to customize it.

To configure your AppImage build, you can use the following environment variables:

CURA_VERSION_MAJOR: Major version number of Cura (default 0)
CURA_VERSION_MINOR: Minor version number of Cura (default 0)
CURA_VERSION_PATCH: Patch version number of Cura (default 0)
CURA_VERSION_EXTRA: Extra version string of Cura, which will be appended after x.y.z in the format of x.y.z-<extra> (default an empty string "")
CURA_CLOUD_API_ROOT: Root URL of Cura Cloud API (default https://api.ultimaker.com)
CURA_CLOUD_API_VERSION: Cura Cloud API version to use (default 1)
CURA_CLOUD_ACCOUNT_API_ROOT: Root URL of Cura Cloud Account API (default https://account.ultimaker.com)

Build Cura Windows Installer with Docker

Similar to the Linux build instructions, you first need a workding cura-build-environment docker image for Windows. To build the Cura installer, you can use the commands below:

# Do this in PowerShell
.\scripts\windows\build.ps1

The script by default uses a docker image tagged as cura-build-environment:1809-vs2015-amd64, so make sure that your image is tagged accordingly. If the build is successful, the resulting installer will be placed in the windows-installers/ directory. Check the script scripts\windows\build.ps1 for more details if you want to customize it.

You will be asked for some mandatory variables for building Cura, including:

CuraVersionMajor: Major version number of Cura (default 0)
CuraVersionMinor: Minor version number of Cura (default 0)
CuraVersionPatch: Patch version number of Cura (default 0)
CuraVersionExtra: Extra version string of Cura, which will be appended after x.y.z in the format of x.y.z-<extra> (default an empty string "")
CuraCloudApiRoot: Root URL of Cura Cloud API (default https://api.ultimaker.com)
CuraCloudApiVersion: Cura Cloud API version to use (default 1)
CuraCloudAccountApiRoot: Root URL of Cura Cloud Account API (default https://account.ultimaker.com)

Build on Native Machine

OS X

Install CMake (available via homebrew or cmake.org)
Install latest version of Xcode.
On Mac OS X > 10.10, execute command: brew link openssl --force
Because Fortran is necessary: brew install gcc gfortran
Run these commands:

git clone git@github.com:Ultimaker/cura-build.git
cd cura-build
mkdir build
cd build
cmake ..
make

Windows

On Windows, the following dependencies are needed for building:

git for windows (https://git-for-windows.github.io/) The git command should be available on your %PATH%. Make sure that the cmd directory in the git for windows installation directory is on the %PATH% and not its bin directory, otherwise mingw32 will complain about sh.exe being on the path.
CMake (http://www.cmake.org/) Once CMake is installed make sure it is available on your %PATH%. Check this by running cmake --version in the Windows console.
MinGW-W64 >= 5.3.0 (http://mingw-w64.org/doku.php) Once installed, its bin directory should be available on your %PATH%. Test this by running mingw32-make --version in the Windows console.
Python 3.5 (http://python.org/, note that the version "3.5" is hardcoded across this project)
NumPy (http://www.lfd.uci.edu/~gohlke/pythonlibs/#numpy) You'll need to download a .whl from this site for Python 3.5 and install it via pip install <your_whl_file>.whl.
SciPy (http://www.lfd.uci.edu/~gohlke/pythonlibs/#scipy) You'll need to download a .whl from this site for Python 3.5 and install it via pip install <your_whl_file>.whl.
PySerial from https://pypi.python.org/pypi/pyserial/3.2.1 It can be easily installed via pip3 install pyserial
PyQt5 from https://pypi.python.org/pypi/PyQt5/5.7 It can be easily installed via pip3 install PyQt5
SIP from https://pypi.python.org/pypi/SIP/4.18.1 It can be easily installed via pip3 install sip
Trimesh from https://pypi.python.org/pypi/trimesh/2.32.1 It can be easily installed via pip3 install trimesh
PyCollada from https://pypi.org/project/pycollada/0.6 It can be easily installed via pip3 install pycollada
Shapely from https://pypi.python.org/pypi/Shapely/1.6.4.post2 It can be easily installed via pip3 install shapely[vectorized]. If it doesn't work, you'll need to download a .whl from https://www.lfd.uci.edu/~gohlke/pythonlibs/#shapely for Python 3.5 and install it via pip install <your_whl_file>.whl.
Zeroconf from https://pypi.python.org/pypi/zeroconf/0.17.6 It can be easily installed via pip3 install zeroconf
NumPy-STL from https://pypi.python.org/pypi/numpy-stl/2.0.0 It can be easily installed via pip3 install numpy-stl
LibArcus from https://github.com/Ultimaker/libArcus
Microsoft Visual Studio 2015 (community edition): Install Programming languages: Visual c++ (all), Python Tools for Visual Studio (Nov 2015) Windows & Web Development: Universal Windows App Development Tools (Tools 1.2 & windows 10 SDK-10/0/10586; Windows 10 SDK -10.0.10240)
cx_Freeze (https://pypi.python.org/pypi/cx_Freeze) The easiest way to install this is to use a wheel (*.whl file) and install it via pip install <your_whl_file>.whl. You may have to add <python dir>/Scripts to your %PATH%. (Last tested version was: cx_Freeze-5.0-cp35-cp35m-win_amd64.whl)
NSIS 3 (http://nsis.sourceforge.net/Main_Page) for creating the installer. Additional NSIS scripts are shipped with this project.

Make sure these dependencies are available from your path.

REM 64-bit
git clone git@github.com:Ultimaker/cura-build.git
cd cura-build
mkdir build
cd build
..\env_win64.bat
cmake -G "MinGW Makefiles" ..
mingw32-make
mingw32-make package

Before make package - copy arduino to cura-build/

Ubuntu/Linux

cura-build can build AppImage packages of Cura. The following dependencies are required:

apt install git cmake gcc python3
python3 -m pip install numpy scipy pyserial pyqt5 sip trimesh shapely zeroconf numpy-stl
LibArcus from https://github.com/Ultimaker/libArcus
cx_Freeze (https://pypi.python.org/pypi/cx_Freeze) The easiest way to install this is to use a wheel (*.whl file) and install it via pip install <your_whl_file>.whl. You may have to add <python dir>/Scripts to your PATH.
AppImageKit from https://github.com/AppImage/AppImageKit

To build, make sure these dependencies are installed, then clone this repository and run the following commands from your clone:

# Clone the repo
git clone http://github.com/Ultimaker/cura-build.git
cd cura-build

# Create a build directory
mkdir build
cd build

# Build and package
cmake ..
make
make package

CentOS/Linux

cura-build can build CentOS/RHEL packages of Cura.

Dependencies:

gcc-gfortran
python34.x86_64
python34-devel.x86_64
python34-numpy.x86_64
pyserial.noarch
PyOpenGL.noarch
python34-setuptools.noarch
wxPython.x86_64
libstdc++-static.x86_64
libstdc++-devel.x86_64
openssl.x86_64
openblas-devel.x86_64
python34-numpy-f2py.x86_64