v0.9.0

Release date: 2025-01-02

Early Access

The Luminary Cloud API and Python SDK are Early Access features that are still under development. View the Luminary Cloud Early Access Terms. The interface may change, and you may need to migrate or discard scripts and configuration files multiple times before v1.0.0 is released. In the future, migrations may also be necessary when upgrading to new major versions of the SDK (e.g. v2.0.0).

Release Notes

This release has breaking changes. It also contains new features. We recommend all customers upgrade to this release.

Breaking Changes

  • The Vector3 class has been moved to luminarycloud.types.

  • The MeshAdaptationParameters class has been moved to luminarycloud.meshing.

  • The function signature for Project:create_mesh() has changed.

  • The properties of GeometryEntity have changed.

Features

Migration Guide

Updating imports

If you’re using Vector3 or MeshAdaptationParameters, you’ll need to update your imports. Also, rename MeshAdaptationParameters to MeshAdaptationParams.

from luminarycloud.types import Vector3
from luminarycloud.meshing import MeshAdaptationParams

Updating function signatures

If you were passing a MeshAdaptationParameters using Project:create_mesh() for mesh adaptation, you’ll need to move it so that it’s the first positional argument to the function.

# Before
project.create_mesh(name="my_mesh", adaptation_params=params)

# After
project.create_mesh(params, name="my_mesh")

Install & Upgrade Guide

To install the SDK for the first time:

pip install luminarycloud

Or, to upgrade an existing SDK installation, use the same Python environment where you previously installed the SDK and run:

pip install luminarycloud --upgrade

Tip

To check if you’re using the same Python environment as your previous SDK installation, run the pip list command. The output of the command should include luminarycloud with an earlier SDK version.

After successfully upgrading the SDK using the instructions above, the pip list output should show luminarycloud with the latest version.

If you prefer to download the release artifacts instead, visit the project page on the Python Package Index (PyPI).