v0.10.0

Release date: 2025-02-04

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 default value for batch_processing in Project:create_simulation() has been changed to True.

• Geometry:modify() no longer has a return value.

• The parameter params_json_path has been removed from SimulationTemplate:update().

• The classes GeometryEntity, Volume, and Surface are now immutable.

See the Migration Guide for more details on how to update your code.

Features

• API key support

  • luminarycloud.Client has a new optional api_key parameter.

  • The default client will use the LC_API_KEY environment variable if it is set.

• New types FirstOrderAdFloat and SecondOrderAdFloat has been added to luminarycloud.types.

• New exceptions AuthenticationError, InvalidRequestError, PermissionDeniedError, NotFoundError, AlreadyExistsError, and FailedPreconditionError have been added to luminarycloud.exceptions.

• create_tag() and list_tags() have been added to luminarycloud.Geometry.

• get_simulation_param() has been added to luminarycloud.SimulationTemplate.

• EntityIdentifier has been added to luminarycloud.

• Support for RectilinearTable parameters in simulation parameters.

  • New enum TableType has been added to luminarycloud.enum.

  • create_table() has been added to luminarycloud.Project.

  • list_tables() has been added to luminarycloud.SimulationTemplate.

Deprecations

• create_mesh() has been deprecated in favor of create_or_get_mesh().

Bug Fixes / Improvements

• Fixed a bug where the min_size and max_size parameters of MeshGenerationParams did not work.

• Fixed an issue where a second interactive authentication session would be be started when the first one failed.

• Silenced error log when silent authentication fails.

• Server errors are now raised as RpcError exceptions, and their tracebacks are simplified.

Migration Guide

Explicitly set the batch_processing parameter to False

The batch_processing parameter in Project:create_simulation() now defaults to True. If you want to disable batch processing, you must explicitly set the parameter to False.

Replacing the return values of Geometry:modify()

Geometry:modify() used to return volumes, features, and feature issues. You can retrieve these values separately using list_entities(), list_features(), and list_feature_issues().

If you had code that looked like this:

volumes, features, feature_issues = geometry.modify(...)

You should now update it to look like this:

geometry.modify(...)
volumes, _ = geometry.list_entities()
features = geometry.list_features()
feature_issues = geometry.list_feature_issues()

Note: the volumes returned by list_entities() are now Volume objects instead of protos.

Specifying the path to a parameters JSON file in SimulationTemplate:update()

If you were using the params_json_path parameter in SimulationTemplate:update(), you should now pass the path to the JSON file as the parameters parameter instead.