luminarycloud 0.17.0__py3-none-any.whl → 0.18.1__py3-none-any.whl

luminarycloud/enum/geometry_status.py

@@ -11,18 +11,25 @@ class GeometryStatus(IntEnum):
     ----------
     UNKNOWN
         Status is unknown.
-    IMPORTING
-        Geometry is still being processed.
-    NEEDS_CHECK
-        Geometry was created but has not yet been checked.
+    BUSY
+        Geometry is being processed (importing, modifying, or other operations).
+    HAS_FEATURE_ERRORS
+        Geometry has feature errors, which should be resolved.
+    READY_FOR_CHECK
+        Geometry has no feature errors and is ready to be checked for meshing validity.
+    CHECKING
+        Geometry check is currently running to validate the geometry.
     FAILED_CHECK
-        Geometry is not well-formed and cannot be used.
+        Geometry is not well-formed and cannot be used for meshing or
+        simulation.
     READY
-        Geometry is ready to use.
+        Geometry is ready to use for meshing and simulation.
     """
 
     UNKNOWN = geometry_pb2.Geometry.UNKNOWN
-    IMPORTING = geometry_pb2.Geometry.IMPORTING
-    NEEDS_CHECK = geometry_pb2.Geometry.NEEDS_CHECK
+    BUSY = geometry_pb2.Geometry.BUSY
+    HAS_FEATURE_ERRORS = geometry_pb2.Geometry.HAS_FEATURE_ERRORS
+    READY_FOR_CHECK = geometry_pb2.Geometry.READY_FOR_CHECK
+    CHECKING = geometry_pb2.Geometry.CHECKING
     FAILED_CHECK = geometry_pb2.Geometry.FAILED_CHECK
     READY = geometry_pb2.Geometry.READY

luminarycloud/enum/moment_convention_type.py

@@ -0,0 +1,19 @@
+# Copyright 2025 Luminary Cloud, Inc. All Rights Reserved.
+from enum import IntEnum
+from .._proto.output import output_pb2 as outputpb
+
+
+class MomentConventionType(IntEnum):
+    """
+    Whether the body frame or stability frame is used for pitch, roll and yaw moment calculations.
+
+    Attributes
+    ----------
+    BODY_FRAME
+    STABILITY_FRAME
+    """
+
+    UNSPECIFIED = outputpb.INVALID_MOMENT_CONVENTION_TYPE
+
+    BODY_FRAME = outputpb.MOMENT_CONVENTION_BODY_FRAME
+    STABILITY_FRAME = outputpb.MOMENT_CONVENTION_STABILITY_FRAME

luminarycloud/enum/pipeline_job_status.py

@@ -0,0 +1,23 @@
+# Copyright 2025 Luminary Cloud, Inc. All Rights Reserved.
+from enum import IntEnum
+from .._proto.api.v0.luminarycloud.pipelines import pipelines_pb2 as pipelinespb
+
+
+class PipelineJobStatus(IntEnum):
+    """
+    Status of a pipeline job.
+
+    Attributes
+    ----------
+    PENDING
+    RUNNING
+    COMPLETED
+    FAILED
+    """
+
+    UNSPECIFIED = pipelinespb.PIPELINE_JOB_STATUS_UNSPECIFIED
+
+    PENDING = pipelinespb.PIPELINE_JOB_STATUS_PENDING
+    RUNNING = pipelinespb.PIPELINE_JOB_STATUS_RUNNING
+    COMPLETED = pipelinespb.PIPELINE_JOB_STATUS_COMPLETED
+    FAILED = pipelinespb.PIPELINE_JOB_STATUS_FAILED

luminarycloud/feature_modification.py

@@ -2,6 +2,8 @@
 from enum import Enum, auto
 from typing import Dict, Iterable, List, Optional, cast
 from copy import deepcopy
+
+from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from ._proto.geometry import geometry_pb2 as gpb
 from .types import Vector3Like
 from .types.vector3 import _to_vector3
@@ -173,7 +175,7 @@ def modify_import(
         feature_copy.import_geometry.geometry_url = geometry_url
 
     if scaling is not None:
-        feature_copy.import_geometry.scaling = scaling
+        feature_copy.import_geometry.scaling.CopyFrom(_to_ad_proto(scaling))
 
     return gpb.Modification(
         mod_type=gpb.Modification.ModificationType.MODIFICATION_TYPE_UPDATE_FEATURE,

luminarycloud/geometry.py

@@ -29,6 +29,7 @@ from .named_variable_set import NamedVariableSet, get_named_variable_set
 
 if TYPE_CHECKING:
     from .project import Project
+    from .geometry_version import GeometryVersion
 
 
 @ProtoWrapper(geometrypb.Geometry)
@@ -289,6 +290,17 @@ class Geometry(ProtoWrapperBase):
             )
         )
 
+    def latest_version(self) -> GeometryVersion:
+        """
+        Get the latest version of the geometry.
+        """
+        from .geometry_version import get_geometry_version
+
+        req = geometrypb.GetGeometryRequest(geometry_id=self.id)
+        res_geo: geometrypb.GetGeometryResponse = get_default_client().GetGeometry(req)
+        geometry_version_id = res_geo.geometry.last_version_id
+        return get_geometry_version(geometry_version_id)
+
     def check(self) -> tuple[bool, list[str]]:
         """
         Check the geometry for any issues that may prevent meshing.

luminarycloud/geometry_version.py

@@ -87,6 +87,29 @@ class GeometryVersion(ProtoWrapperBase):
         ]
         return surfaces, volumes
 
+    def copy_to_new_geometry(self, name: str = "") -> Geometry:
+        """
+        Copy this GeometryVersion and create a new Geometry containing only that newly copied version.
+
+        Parameters
+        ----------
+        name : str, optional
+            The name of the new Geometry. If not provided, a default name will be used.
+
+        Returns
+        -------
+        Geometry
+            The new Geometry containing only the newly copied GeometryVersion.
+        """
+        req = geometrypb.CopyGeometryFromVersionRequest(
+            geometry_version_id=self.id,
+            name=name,
+        )
+        res: geometrypb.CopyGeometryFromVersionResponse = (
+            get_default_client().CopyGeometryFromVersion(req)
+        )
+        return Geometry(res.geometry)
+
     def _list_features(
         self,
     ) -> list[gpb.Feature]:

luminarycloud/outputs/output_definitions.py

@@ -9,6 +9,7 @@ from ..types import Vector3
 from typing import cast, overload
 from ..enum import (
     CalculationType,
+    MomentConventionType,
     OutputDefinitionIncludes,
     QuantityType,
     ResidualType,
@@ -185,6 +186,8 @@ class ForceOutputDefinition(CodeRepr):
     "Center point for moment calculations."
     porous: bool = False
     "Whether the surfaces involved are porous."
+    moment_convention_type: MomentConventionType = MomentConventionType.BODY_FRAME
+    "Frame type for moment calculations (body or stability frame)."
     # TODO: it seems clumsy to make the user set `porous` correctly. we could probably set it
     # automatically based on the set of surfaces selected.
 
@@ -201,6 +204,7 @@ class ForceOutputDefinition(CodeRepr):
                     force_direction=self.force_direction._to_ad_proto(),
                     moment_center=self.moment_center._to_ad_proto(),
                     porous=self.porous,
+                    moment_convention_type=self.moment_convention_type.value,
                 ),
             ),
         )
@@ -220,6 +224,7 @@ class ForceOutputDefinition(CodeRepr):
             force_direction=Vector3.from_ad_proto(proto.force.props.force_direction),
             moment_center=Vector3.from_ad_proto(proto.force.props.moment_center),
             porous=proto.force.props.porous,
+            moment_convention_type=MomentConventionType(proto.force.props.moment_convention_type),
         )
 
 

luminarycloud/params/enum/_enum_wrappers.py

@@ -1776,6 +1776,9 @@ class DirectionSpecification(_IntEnum):
         Impose a flow direction normal to the inlet boundary toward the interior of the domain.
     DIRECTION_VECTOR
         Specify a vector for the inlet flow direction.
+    CYLINDRICAL_DIRECTIONS
+        Specify the inlet flow direction in a cylindrical coordinate system whose main axis
+                        is defined by the z axis of the inlet frame.
 
 
     Examples
@@ -1783,11 +1786,37 @@ class DirectionSpecification(_IntEnum):
     >>> from luminarycloud.params.enum import DirectionSpecification
     >>> DirectionSpecification.NORMAL_TO_BOUNDARY
     >>> DirectionSpecification.DIRECTION_VECTOR
+    >>> DirectionSpecification.CYLINDRICAL_DIRECTIONS
     """
 
     INVALID = _clientpb.INVALID_DIRECTION_SPECIFICATION
     NORMAL_TO_BOUNDARY = _clientpb.NORMAL_TO_BOUNDARY
     DIRECTION_VECTOR = _clientpb.DIRECTION_VECTOR
+    CYLINDRICAL_DIRECTIONS = _clientpb.CYLINDRICAL_DIRECTIONS
+
+
+class DirectionFrame(_IntEnum):
+    """
+    Frame used to define the flow direction.
+
+    Attributes
+    ----------
+    DIRECTION_FRAME_GLOBAL
+        The direction vectors are defined by the global frame.
+    DIRECTION_FRAME_BOUNDARY
+        The direction vectors are defined by the frame to which the boundary surfaces are attached.
+
+
+    Examples
+    --------
+    >>> from luminarycloud.params.enum import DirectionFrame
+    >>> DirectionFrame.DIRECTION_FRAME_GLOBAL
+    >>> DirectionFrame.DIRECTION_FRAME_BOUNDARY
+    """
+
+    INVALID = _clientpb.INVALID_DIRECTION_FRAME
+    DIRECTION_FRAME_GLOBAL = _clientpb.DIRECTION_FRAME_GLOBAL
+    DIRECTION_FRAME_BOUNDARY = _clientpb.DIRECTION_FRAME_BOUNDARY
 
 
 class OutletPressureConstraint(_IntEnum):

luminarycloud/params/simulation/monitor_plane_.py

@@ -40,7 +40,7 @@ class MonitorPlane(CodeRepr, ParamGroupWrapper[clientpb.MonitorPlane]):
     "Rotation vector of Euler angles (XYZ order) that transforms the box used to clip the monitor plane."
     enable_volume_clip: bool = False
     "Turn on or off the ability to constrain a monitor plane to specific volumes of the geometry."
-    volumes: list[EntityIdentifier] = field(default_factory=_create_entity_identifier, init=True)
+    volumes: list[EntityIdentifier] = field(default_factory=list)
     "List of volumes used to clip the monitor plane."
 
     def _to_proto(self) -> clientpb.MonitorPlane:

luminarycloud/params/simulation/physics/fluid/boundary_conditions/inlet/fan_curve_inlet_.py

@@ -32,7 +32,7 @@ class FanCurveInlet(Inlet):
     )
     "Method of defining the flow direction at the inlet."
     direction: Vector3 = field(default_factory=lambda: Vector3(1.0, 0.0, 0.0))
-    "Vector (x,y,z) defining the flow direction. Automatically scaled to a unit vector internally."
+    "Vector (x,y,z) or (ρ,φ,z) defining the flow direction. Automatically scaled to a unit vector internally."
     fan_curve_table: RectilinearTable | None = None
     "Correlation between fan pressure rise and volume flow rate."
     head_loss_coefficient: LcFloat = 0.0

luminarycloud/params/simulation/physics/fluid/boundary_conditions/inlet/mach_inlet_.py

@@ -33,8 +33,10 @@ class MachInlet(Inlet):
         enum.DirectionSpecification.NORMAL_TO_BOUNDARY
     )
     "Method of defining the flow direction at the inlet."
+    direction_frame: enum.DirectionFrame = enum.DirectionFrame.DIRECTION_FRAME_GLOBAL
+    "Frame used to define the flow direction."
     direction: Vector3 = field(default_factory=lambda: Vector3(1.0, 0.0, 0.0))
-    "Vector (x,y,z) defining the flow direction. Automatically scaled to a unit vector internally."
+    "Vector (x,y,z) or (ρ,φ,z) defining the flow direction. Automatically scaled to a unit vector internally."
 
     def _to_proto(self) -> clientpb.BoundaryConditionsFluid:
         _proto = super()._to_proto()
@@ -42,6 +44,7 @@ class MachInlet(Inlet):
         _proto.farfield_mach_number.CopyFrom(_to_ad_proto(self.mach_number))
         _proto.farfield_pressure.CopyFrom(_to_ad_proto(self.pressure))
         _proto.direction_specification = self.direction_specification.value
+        _proto.direction_frame = self.direction_frame.value
         _proto.flow_direction.CopyFrom(self.direction._to_ad_proto())
         return _proto
 
@@ -51,5 +54,6 @@ class MachInlet(Inlet):
         self.mach_number = _from_ad_proto(proto.farfield_mach_number)
         self.pressure = _from_ad_proto(proto.farfield_pressure)
         self.direction_specification = enum.DirectionSpecification(proto.direction_specification)
+        self.direction_frame = enum.DirectionFrame(proto.direction_frame)
         self.direction._from_ad_proto(proto.flow_direction)
         return None

luminarycloud/params/simulation/physics/fluid/boundary_conditions/inlet/mass_flow_inlet_.py

@@ -31,14 +31,17 @@ class MassFlowInlet(Inlet):
         enum.DirectionSpecification.NORMAL_TO_BOUNDARY
     )
     "Method of defining the flow direction at the inlet."
+    direction_frame: enum.DirectionFrame = enum.DirectionFrame.DIRECTION_FRAME_GLOBAL
+    "Frame used to define the flow direction."
     direction: Vector3 = field(default_factory=lambda: Vector3(1.0, 0.0, 0.0))
-    "Vector (x,y,z) defining the flow direction. Automatically scaled to a unit vector internally."
+    "Vector (x,y,z) or (ρ,φ,z) defining the flow direction. Automatically scaled to a unit vector internally."
 
     def _to_proto(self) -> clientpb.BoundaryConditionsFluid:
         _proto = super()._to_proto()
         _proto.inlet_momentum = clientpb.InletMomentum.MASS_FLOW_INLET
         _proto.mass_flow_rate.CopyFrom(_to_ad_proto(self.mass_flow_rate))
         _proto.direction_specification = self.direction_specification.value
+        _proto.direction_frame = self.direction_frame.value
         _proto.flow_direction.CopyFrom(self.direction._to_ad_proto())
         return _proto
 
@@ -47,5 +50,6 @@ class MassFlowInlet(Inlet):
         assert proto.inlet_momentum == clientpb.InletMomentum.MASS_FLOW_INLET
         self.mass_flow_rate = _from_ad_proto(proto.mass_flow_rate)
         self.direction_specification = enum.DirectionSpecification(proto.direction_specification)
+        self.direction_frame = enum.DirectionFrame(proto.direction_frame)
         self.direction._from_ad_proto(proto.flow_direction)
         return None

luminarycloud/params/simulation/physics/fluid/boundary_conditions/inlet/total_pressure_inlet_.py

@@ -33,8 +33,10 @@ class TotalPressureInlet(Inlet):
         enum.DirectionSpecification.NORMAL_TO_BOUNDARY
     )
     "Method of defining the flow direction at the inlet."
+    direction_frame: enum.DirectionFrame = enum.DirectionFrame.DIRECTION_FRAME_GLOBAL
+    "Frame used to define the flow direction."
     direction: Vector3 = field(default_factory=lambda: Vector3(1.0, 0.0, 0.0))
-    "Vector (x,y,z) defining the flow direction. Automatically scaled to a unit vector internally."
+    "Vector (x,y,z) or (ρ,φ,z) defining the flow direction. Automatically scaled to a unit vector internally."
 
     def _to_proto(self) -> clientpb.BoundaryConditionsFluid:
         _proto = super()._to_proto()
@@ -42,6 +44,7 @@ class TotalPressureInlet(Inlet):
         _proto.total_pressure.CopyFrom(_to_ad_proto(self.total_pressure))
         _proto.total_pressure_col.value = self.total_pressure_column_index
         _proto.direction_specification = self.direction_specification.value
+        _proto.direction_frame = self.direction_frame.value
         _proto.flow_direction.CopyFrom(self.direction._to_ad_proto())
         return _proto
 
@@ -51,5 +54,6 @@ class TotalPressureInlet(Inlet):
         self.total_pressure = _from_ad_proto(proto.total_pressure)
         self.total_pressure_column_index = proto.total_pressure_col.value
         self.direction_specification = enum.DirectionSpecification(proto.direction_specification)
+        self.direction_frame = enum.DirectionFrame(proto.direction_frame)
         self.direction._from_ad_proto(proto.flow_direction)
         return None

luminarycloud/params/simulation/physics/fluid/boundary_conditions/inlet/velocity_magnitude_inlet_.py

@@ -33,8 +33,10 @@ class VelocityMagnitudeInlet(Inlet):
         enum.DirectionSpecification.NORMAL_TO_BOUNDARY
     )
     "Method of defining the flow direction at the inlet."
+    direction_frame: enum.DirectionFrame = enum.DirectionFrame.DIRECTION_FRAME_GLOBAL
+    "Frame used to define the flow direction."
     direction: Vector3 = field(default_factory=lambda: Vector3(1.0, 0.0, 0.0))
-    "Vector (x,y,z) defining the flow direction. Automatically scaled to a unit vector internally."
+    "Vector (x,y,z) or (ρ,φ,z) defining the flow direction. Automatically scaled to a unit vector internally."
     pressure: LcFloat = 101325
     "Static pressure at the boundary relative to the material reference pressure."
 
@@ -44,6 +46,7 @@ class VelocityMagnitudeInlet(Inlet):
         _proto.inlet_velocity_magnitude.CopyFrom(_to_ad_proto(self.velocity))
         _proto.inlet_velocity_magnitude_col.value = self.velocity_column_index
         _proto.direction_specification = self.direction_specification.value
+        _proto.direction_frame = self.direction_frame.value
         _proto.flow_direction.CopyFrom(self.direction._to_ad_proto())
         _proto.farfield_pressure.CopyFrom(_to_ad_proto(self.pressure))
         return _proto
@@ -54,6 +57,7 @@ class VelocityMagnitudeInlet(Inlet):
         self.velocity = _from_ad_proto(proto.inlet_velocity_magnitude)
         self.velocity_column_index = proto.inlet_velocity_magnitude_col.value
         self.direction_specification = enum.DirectionSpecification(proto.direction_specification)
+        self.direction_frame = enum.DirectionFrame(proto.direction_frame)
         self.direction._from_ad_proto(proto.flow_direction)
         self.pressure = _from_ad_proto(proto.farfield_pressure)
         return None

luminarycloud/physics_ai/inference.py

@@ -1,8 +1,8 @@
 # File: python/sdk/luminarycloud/inference/inference.py
 # Copyright 2025 Luminary Cloud, Inc. All Rights Reserved.
 from datetime import datetime
-from typing import Any, Callable
-from json import loads as json_loads
+from typing import Any, Callable, Dict, Optional
+from json import loads as json_loads, dumps as json_dumps
 from dataclasses import dataclass
 import base64
 import os
@@ -48,7 +48,12 @@ class ExtAeroInferenceResult:
 
 
 def external_aero_inference(
-    project: Project, stl_file: str, checkpoint_file: str, config_name: str, stencil_size: int
+    project: Project,
+    stl_file: str,
+    artifact_url: str,
+    parameters: Optional[Dict[str, Any]] = None,
+    stencil_size: int = 1,
+    write_visualization_data=False,
 ) -> ExtAeroInferenceResult:
     """Performs an inference job returning external aerodynamic results.
     Parameters
@@ -57,12 +62,15 @@ def external_aero_inference(
         The project to which the inference files will be added.
     stl_file : str
         Fullpath the STL file to be used for inference.
-    checkpoint_file : str
-        Fullpath of the model to be used for inference.
-    config_name :str
-        Name of the configuration to be used for inference.
-    stencil_size :int
-        Size of the stencil to be used for inference.
+    artifact_url : str
+        Fullpath of the model artifact directory to be used for inference.
+    parameters : Dict[str, Any], optional
+        Dictionary of parameters to be passed to the inference service (e.g., alpha, beta, etc.).
+    stencil_size : int, optional
+        Size of the stencil to be used for inference. Defaults to 1.
+    write_visualization_data : bool, optional
+        Whether to write LC visualization data for visualization by Luminary.
+
 
     Returns
     ExtAeroInferenceResult
@@ -71,12 +79,19 @@ def external_aero_inference(
     warning:: This feature is experimental and may change or be removed without notice.
     """
 
-    result = perform_inference(project, stl_file, checkpoint_file, config_name, stencil_size)
+    result = perform_inference(
+        project, stl_file, artifact_url, parameters, stencil_size, write_visualization_data
+    )
     return ExtAeroInferenceResult(result)
 
 
 def perform_inference(
-    project: Project, stl_file: str, checkpoint_file: str, config_name: str, stencil_size: int
+    project: Project,
+    stl_file: str,
+    artifact_url: str,
+    parameters: Optional[Dict[str, Any]] = None,
+    stencil_size: int = 1,
+    write_visualization_data=False,
 ) -> dict[str, Any]:
     """Creates an inference service job.
     Parameters
@@ -85,12 +100,14 @@ def perform_inference(
         The project to which the inference files will be added.
     stl_file : str
         Fullpath the STL file to be used for inference.
-    checkpoint_file : str
-        Fullpath of the model to be used for inference.
-    config_name :str
-        Name of the configuration to be used for inference.
-    stencil_size :int
-        Size of the stencil to be used for inference.
+    artifact_url : str
+        Fullpath of the model artifact directory to be used for inference.
+    parameters : Dict[str, Any], optional
+        Dictionary of parameters to be passed to the inference service (e.g., alpha, beta, etc.).
+    stencil_size : int, optional
+        Size of the stencil to be used for inference. Defaults to 1.
+    write_visualization_data : bool, optional
+        Whether to write LC visualization data for visualization by Luminary.
 
 
     Returns
@@ -123,9 +140,10 @@ def perform_inference(
         return download_file
 
     stl_url = upload_if_file(stl_file)
-    check_url = upload_if_file(checkpoint_file)
 
-    raw = start_inference_job(project, stl_url, check_url, config_name, stencil_size)
+    raw = start_inference_job(
+        project, stl_url, artifact_url, parameters, stencil_size, write_visualization_data
+    )
     currated: dict[str, Any] = {}
     for k, v in raw.items():
         if isinstance(v, str) and v.startswith("https://"):
@@ -144,9 +162,10 @@ def perform_inference(
 def start_inference_job(
     project: Project,
     stl_url: str,
-    checkpoint_url: str,
-    config_name: str,
-    stencil_size: int,
+    artifact_url: str,
+    parameters: Optional[Dict[str, Any]] = None,
+    stencil_size: int = 1,
+    write_visualization_data=False,
 ) -> dict[str, Any]:
     """Creates an inference service job.
     Parameters
@@ -155,12 +174,14 @@ def start_inference_job(
         Reference to a project.
     stl_url : str
         URL of the STL file to be used for inference.
-    checkpoint_url : str
-        URL of the model to be used for inference.
-    config_name :str
-        Name of the configuration to be used for inference.
-    stencil_size :int
-        Size of the stencil to be used for inference.
+    artifact_url : str
+        URL of the model artifact directory to be used for inference.
+    parameters : Dict[str, Any], optional
+        Dictionary of parameters to be passed to the inference service (e.g., alpha, beta, etc.).
+    stencil_size : int, optional
+        Size of the stencil to be used for inference. Defaults to 1.
+    write_visualization_data : bool, optional
+        Whether to write LC visualization data for visualization by Luminary.
 
 
     Returns
@@ -170,12 +191,18 @@ def start_inference_job(
     warning:: This feature is experimental and may change or be removed without notice.
     """
 
+    # Convert parameters dict to bytes if provided
+    parameters_bytes = b""
+    if parameters is not None:
+        parameters_bytes = json_dumps(parameters).encode("utf-8")
+
     req = inferencepb.CreateInferenceServiceJobRequest(
         stl_url=stl_url,
-        checkpoint_url=checkpoint_url,
-        config_name=config_name,
+        artifact_url=artifact_url,
+        parameters=parameters_bytes,
         stencil_size=stencil_size,
         project_id=project.id,
+        write_visualization_data=write_visualization_data,
     )
 
     res: inferencepb.CreateInferenceServiceJobResponse = (

luminarycloud/pipelines/__init__.py

@@ -33,3 +33,10 @@ from .arguments import (
     PipelineArgs as PipelineArgs,
     ArgNamedVariableSet as ArgNamedVariableSet,
 )
+
+from .api import (
+    create_pipeline as create_pipeline,
+    list_pipelines as list_pipelines,
+    get_pipeline as get_pipeline,
+    create_pipeline_job as create_pipeline_job,
+)