Running Cura from Source

Note: We're currently still in the process of updating our workflow how to run Cura from source. Although most of the workflow has been determined already, there are bound to be some changes along the way. If you run into any issues, please feel free to to open an issue on our Cura repository.

System requirements

Make sure that the binaries for the system dependencies can be found on the PATH

Windows

• Windows 10 or higher
• Visual Studio with MSVC 2022 or higher
• Python 3.10.4 or higher
• venv (Python)
• sip (Python) 6.5.1
• CMake 3.23 or higher
• Ninja 1.10 or higher
• Conan 1.56.0

Executing from the Powershell is preferred. To be completely safe, start powershell inside of the x64 Native Command Tools Prompt.

macOS

For M1 Mac users you must follow the build instructions using a Rossetta terminal

We recommend using brew to install these dependencies.

• macOS 10.15 or higher
• xcode 11.4 or higher
• apple-clang-9.0 or higher
• Python 3.6 or higher
• venv (Python)
• sip (Python) 6.5.0 or higher
• altool
• automake
• CMake 3.23 or higher
• Ninja 1.10 or higher
• Conan 1.56.0

Linux

• Ubuntu/Debian/Arch/Manjaro (glibc 2.28 or higher)
• gcc-12 or higher
• Python 3.6 or higher
• venv (Python)
• sip (Python) 6.5.0 or higher
• CMake 3.23 or higher
• Ninja 1.10 or higher
• Conan 1.56.0
• autoreconf
• ( xtrans )

Installation

1. Configure Conan

pip install conan==1.56
conan config install https://github.com/ultimaker/conan-config.git
conan profile new default --detect --force

External developers must run conan remote remove cura. Internal developers can contact IT about getting Artifactory Access.

2. Clone Cura

Clone Cura and enter the Cura root directory.

git clone https://github.com/Ultimaker/Cura.git 
cd Cura

3. Initialize the Virtual Python Development Environment

Install the dependencies for the development environment and initialize a virtual Python environment. Execute the following command in the root directory of the Cura repository.

# optional for a specific version: conan install . cura/<version>@<user>/<channel> --build=missing --update
conan install . --build=missing --update -o cura:devtools=True -g VirtualPythonEnv

If you use PyCharm, append -g PyCharmRunEnv. This will create a run/debug/test configurations. You must click Add Configuration..., and click Apply for these to be displayed.

4. Activate the Virtual Python Environment

Activate the virtual environment by executing the following command in the root directory of the Cura repository.

# For Linux/MacOS
source venv/bin/activate

# For Windows (Powershell)
.\venv\Scripts\activate.ps1

5. Run Cura

python cura_app.py