Uranium

Uranium is a Python framework for building 3D printing related applications.

License

Uranium is released under terms of the LGPLv3 License. Terms of the license can be found in the LICENSE file. Or at http://www.gnu.org/licenses/lgpl.html

But in general it boils down to:
You need to share the source of any Uranium modifications if you make an application with Uranium.

System Requirements

Windows

• Windows 10 or higher
• Visual Studio with MSVC 2019 or higher
• Python 3.6 or higher
• venv
• CMake 3.20 or higher
• Ninja 1.10 or higher
• Conan 1.48 or higher

Executing from the Powershell is preferred.

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
• altool
• automake
• CMake 3.20 or higher
• Ninja 1.10 or higher
• Conan 1.48 or higher

Linux

• Ubuntu/Debian/Arch/Manjaro (glibc 2.28 or higher)
• gcc-9 or higher
• Python 3.6 or higher
• venv
• CMake 3.20 or higher
• Ninja 1.10 or higher
• Conan 1.48 or higher
• autoreconf

How To Build

Note:
We are currently in the process of switch our builds and pipelines to an approach which uses Conan and pip to manage our dependencies, which are stored on our JFrog Artifactory server and in the pypi.org. At the moment not everything is fully ported yet, so bare with us.

If you want to develop Cura with Uranium see the Cura Wiki: Running Cura from source

If you have never used Conan read their documentation which is quite extensive and well maintained. Conan is a Python program and can be installed using pip

1. Configure Conan

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

Community developers would have to remove the Conan cura repository because it requires credentials.

Ultimaker developers need to request an account for our JFrog Artifactory server at IT

conan remote remove cura

2. Clone Uranium

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

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.

conan install . --build=missing -o cura:devtools=True -g VirtualPythonEnv

4. Running tests

# For Linux/MacOS
source venv/bin/activate
cd tests
pytest

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

Creating a new Uranium Conan package

To create a new Uranium Conan package such that it can be used in Cura and Uranium, run the following command:

conan create . uranium/<version>@<username>/<channel> --build=missing --update

This package will be stored in the local Conan cache (~/.conan/data or C:\Users\username\.conan\data ) and can be used in downstream projects, such as Cura and Uranium by adding it as a requirement in the conanfile.py or in conandata.yml.

Note: Make sure that the used <version> is present in the conandata.yml in the Uranium root

You can also specify the override at the commandline, to use the newly created package, when you execute the conan install command in the root of the consuming project, with:

conan install . -build=missing --update --require-override=uranium/<version>@<username>/<channel>

Developing Uranium In Editable Mode

You can use your local development repository downsteam by adding it as an editable mode package. This means you can test this in a consuming project without creating a new package for this project every time.

    conan editable add . uranium/<version>@<username>/<channel>

Then in your downsteam projects (Cura) root directory override the package with your editable mode package.

conan install . -build=missing --update --require-override=uranium/<version>@<username>/<channel>