v0.12.0

Release date: 2025-03-18

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 adds features including new visualization filters, an easier-to-use camera, and operations on project outputs, geometry tags, and geometry features.

Breaking Changes

• vis.ImageExtract.download_image() used to save an image to disk, now it returns a byte buffer. Use ImageExtract.save_image() to save an image to disk.

• vis.Clip is now vis.PlaneClip

• The name attribute is now required on meshing.RefinementRegion, and must be unique within the scope of a meshing.MeshGenerationParams.refinement_regions

• The z_axis attribute of params.geometry.OrientedCube has been removed.

• The parameters of params.geometry.Cone have changed to apex, base_center, and base_radius.

Features

• vis.LookAtCamera has been added for easier camera positioning.

• vis.ImageExtract.save_image() added to save an image to disk.

• More visualization filters added: vis.BoxClip, vis.FixedSizeVectorGlyphs, and vis.ScaledVectorGlyphs.

• Project gains methods for manipulating outputs: create_output_node(), list_output_nodes(),get_output_node(),update_output_node(), and delete_output_node(). See also the new outputs module.

• Geometry has new helper functions for working with tags: rename_tag(), untag_entities(), and delete_tags().

• Geometry has new helper functions for working with features: rename_feature(), delete_feature(), undo(), and redo()

• Geometry.add_farfield() now has a new argument propagate_tool_tags. If this argument is true, tags associated with the volumes to be subtracted will be propagated to their surfaces before performing the farfield subtraction.

Deprecations

None.

Bug Fixes / Improvements

• Fluid inlet boundary conditions were not being serialized correctly. This is fixed.

• Refinement regions were not being serialized correctly. This is fixed.

• VolumeMeshingParams were not being serialized correctly. This is fixed.

Migration Guide

Replace ImageExtract.download_image calls with ImageExtract.save_image.

Replace vis.Clip instances with vis.PlaneClip.

If using MeshGenerationParams, ensure every RefinementRegion within it has a unique name.

Remove z_axis argument from any usage of OrientedCube.

For any usage of Cone, replace start with apex, end with base_center, and radius with base_radius.