v0.7.0

Release date: 2024-10-14

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).

Download

luminarycloud-0.7.0-py3-none-any.whl

See the Upgrade Guide for instructions on how to upgrade a previously installed SDK version.

Release Notes

Breaking Changes

  • The required Python version has been bumped to 3.12.

  • The function signature for create_simulation() has changed.

    • The params_json_path parameter has been replaced by simulation_template_id.

Features

  • Simulation parameters can now be fetched for an existing simulation using get_parameters().

  • SimulationTemplates are now available. Simulations can be created using a SimulationTemplate by passing the simulation_template_id parameter to the create_simulation() function.

  • The ReferenceValues and Vector3 classes are now dataclasses.

Migration Guide

create_simulation()

The create_simulation() function now has a required simulation_template_id parameter.

If you were previously using the params_json_path parameter, you must first create a SimulationTemplate using the create_simulation_template() function, and then pass the simulation_template_id to the create_simulation() function.

Before:

sim = project.create_simulation(mesh.id, "my simulation", "./simulation_template.json",)

After:

sim_template = project.create_simulation_template("my template", "./simulation_template.json")
sim = project.create_simulation(mesh.id, "my simulation", sim_template.id)