v0.15.0

Release date: 2025-05-19

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 and some sweet new features.

Breaking Changes

• Geometry.modify() has been removed.

• Project.create_hex_mesh() has been removed.

• The parameters attribute has been removed from SimulationTemplate.

• The return type of get_mesh_metadata() is now MeshMetadata.

• The return type of Simulation.get_parameters() is now luminarycloud.SimulationParam.

• The argument type of params in Project.create_simulation_template() is now luminarycloud.SimulationParam.

• list_features() and list_feature_issues() have been removed from Geometry and GeometryVersion.

Features

• NamedVariableSet class has been added, along with Project.create_named_variable_set() and get_named_variable_set() methods.

• A helper function SimulationParam.find_parameter() has been added to search for parameters in SimulationParam (via generated code) to help users find the parameters they may want to change. find_parameter is similar to using grep on the generated code for a SimulationParam object.

• Geometry now has attributes status and update_time

• Project.create_simulation_template now takes a copy_from arg, allowing you to create a copy of an existing template.

• A new subpackage luminarycloud.meshing.metadata has been added.

• Project now has an url attribute, which links to the project page in the Luminary Cloud web app.

Bug Fixes / Improvements

• The tool_volumes argument of chop() and subtract() in VolumeSelection now supports any iterable of volumes (including other instances of VolumeSelection) instead of just lists of volumes.

• Changes to the reference values via SimulationTemplate and its SimulationParam, are now reflected in the UI.

Deprecations

• get_simulation_param() in Simulation and SimulationTemplate has been deprecated in favor of get_parameters().

Migration Guide

Migrating from Geometry.modify()

It’s unlikely that you were using Geometry.modify() directly, but if you were, you’ll need to switch to using the methods in Geometry or VolumeSelection that are equivalent to whichever modification operation you were using.

Migrating to SimulationParam

get_parameters() now returns a SimulationParam object instead of a raw proto message. It’s unlikely that you were accessing methods and attributes of the proto message directly, but if you were, you’ll need to switch to using the methods and attributes of the SimulationParam object instead.

The params argument of create_simulation_template() also now takes a SimulationParam object instead of a raw proto message, so if you were passing it the result of get_parameters(), there’s no need to change anything.

Also, if you were using get_simulation_param() to get a SimulationParam object, you should switch to get_parameters() (which is identical) since get_simulation_param() is now deprecated.

Migrating to MeshMetadata

It’s again unlikely that you were accessing the protos returned by get_mesh_metadata() directly, but if you were, the returned values are now instances of MeshMetadata instead of raw protos, so you’ll need to switch to using the methods and attributes of the MeshMetadata object instead. Fortunately, the interface should be largely the same.