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

luminarycloud/project.py

@@ -6,7 +6,7 @@ import re
 import uuid
 from datetime import datetime
 from os import PathLike, path
-from typing import TYPE_CHECKING, Any, Dict, Optional, Union
+from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union, Literal
 
 import concurrent
 
@@ -121,22 +121,22 @@ class Project(ProtoWrapperBase):
 
     def create_geometry(
         self,
-        cad_file_path: PathLike | str,
+        cad_file_path: PathLike | str | List[PathLike | str],
         *,
         name: Optional[str] = None,
         scaling: Optional[float] = None,
         wait: bool = False,
     ) -> "Geometry":
         """
-        Create a new geometry in the project by uploading a supported CAD file.
+        Create a new geometry in the project by uploading supported CAD file(s).
 
         For more information on supported formats and best practices, see:
         https://docs.luminarycloud.com/en/articles/9274255-upload-cad
 
         Parameters
         ----------
-        cad_file_path : PathLike or str
-            Path or URL to the CAD file to upload.
+        cad_file_path : PathLike | str | List[PathLike | str]
+            Path(s) or URL to the CAD file(s) to upload.
 
         Other Parameters
         ----------------
@@ -662,6 +662,66 @@ class Project(ProtoWrapperBase):
             return None
         return get_named_variable_set(NamedVariableSetID(res.active_named_variable_set_id))
 
+    def share(self, email: str, role: Literal["viewer", "editor"]) -> None:
+        """
+        Share the project with a user identified by their email address. This function also allows
+        changing the role of the user in the project if the project has already been shared with
+        the input user.
+
+        Parameters
+        ----------
+        email : str
+            Email address of the user to share the project with. It must be an email whose domain
+            is registered within the allowed domains settings of your company account.
+        role : Literal["viewer", "editor"]
+            The role to assign to the user in the project. Must be either "viewer" or "editor".
+        """
+        if not re.match(r"[^@]+@[^@]+\.[^@]+", email):
+            raise ValueError(f"Invalid email address: {email}")
+        if role not in ["viewer", "editor"]:
+            raise ValueError(f"Invalid role: {role}. Must be 'viewer' or 'editor'.")
+        roleModel = (
+            projectpb.ShareProjectRequest.USER_ROLE_VIEWER
+            if role == "viewer"
+            else projectpb.ShareProjectRequest.USER_ROLE_EDITOR
+        )
+        req = projectpb.ShareProjectRequest(id=self.id, email=email, role=roleModel)
+        get_default_client().ShareProject(req)
+
+    def unshare(self, email: str) -> None:
+        """
+        Unshare the project with a user identified by their email address.
+
+        Parameters
+        ----------
+        email : str
+            Email address of the user to unshare the project with. It must be an email whose domain
+            must be registered within the allowed domains settings of your company account.
+        """
+        if not re.match(r"[^@]+@[^@]+\.[^@]+", email):
+            raise ValueError(f"Invalid email address: {email}")
+        req = projectpb.UnshareProjectRequest(id=self.id, email=email)
+        get_default_client().UnshareProject(req)
+
+    def share_with_support(self, message: str = "") -> None:
+        """
+        Share the project with Luminary Cloud support.
+
+        Parameters
+        ----------
+        message : str, optional
+            Message to include with the support share request.
+        """
+        req = projectpb.ShareProjectWithSupportRequest(id=self.id, message=message)
+        get_default_client().ShareProjectWithSupport(req)
+
+    def unshare_with_support(self) -> None:
+        """
+        Unshare the project with Luminary Cloud support.
+        """
+        req = projectpb.UnshareProjectWithSupportRequest(id=self.id)
+        get_default_client().UnshareProjectWithSupport(req)
+
 
 def add_named_variables_from_csv(project: Project, csv_path: str) -> list[NamedVariableSet]:
     """

luminarycloud/simulation_template.py

@@ -17,7 +17,7 @@ from ._proto.api.v0.luminarycloud.simulation_template import (
 )
 from ._proto.client import simulation_pb2 as clientpb
 from ._wrapper import ProtoWrapper, ProtoWrapperBase
-from .types import SimulationTemplateID
+from .types import SimulationTemplateID, ProjectID
 from .tables import RectilinearTable
 from .simulation_param import SimulationParam
 from .outputs import (
@@ -59,7 +59,9 @@ class SimulationTemplate(ProtoWrapperBase):
     id: SimulationTemplateID
     "Simulation template ID."
     name: str
-    "Simulation name."
+    "Simulation template name."
+    project_id: ProjectID
+    "Project this simulation template belongs to."
 
     _proto: simtemplatepb.SimulationTemplate
 
@@ -71,6 +73,13 @@ class SimulationTemplate(ProtoWrapperBase):
     def update_time(self) -> datetime:
         return timestamp_to_datetime(self._proto.update_time)
 
+    def sync_to_ui(self) -> None:
+        """
+        Sets this simulation template as the one that is used for the "Setup" tab in the UI.
+        """
+        req = simtemplatepb.SyncSimulationTemplateToUIRequest(id=self.id)
+        get_default_client().SyncSimulationTemplateToUI(req)
+
     def update(
         self,
         *,
@@ -480,10 +489,10 @@ class SimulationTemplate(ProtoWrapperBase):
         code = code.replace("SimulationParam", "SimulationTemplate")
         code += "\n\n\n"
         code += '# Create a new simulation template or modify the one that is synced with the UI "Setup" tab.\n'
-        code += "# TODO(USER): Replace ... with project ID, or create a project.\n"
-        code += 'project = luminarycloud.get_project("...")\n'
-        code += f"# template = project.create_simulation_template(name={self.name})\n"
-        code += "template = project.list_simulation_templates()[0] # Setup template\n\n"
+        code += f'project = luminarycloud.get_project("{self.project_id}")\n'
+        code += f"template = project.create_simulation_template(name={self.name})\n"
+        code += '# TODO(USER): To modify the "Setup" template, uncomment the line below and comment out the line above.\n'
+        code += "# template = project.list_simulation_templates()[0] # Setup template\n\n"
 
         if parameters._table_references:
             code += "# Upload tabular data.\n"

luminarycloud/vis/__init__.py

@@ -48,3 +48,7 @@ from .display import (
 from .interactive_scene import (
     InteractiveScene as InteractiveScene,
 )
+
+from .interactive_inference import (
+    InteractiveInference as InteractiveInference,
+)

luminarycloud/vis/interactive_inference.py

@@ -0,0 +1,153 @@
+# Copyright 2025 Luminary Cloud, Inc. All Rights Reserved.
+import json
+from .._proto.api.v0.luminarycloud.vis import vis_pb2
+from .display import DisplayAttributes
+from luminarycloud.enum.vis_enums import SceneMode, VisQuantity, Representation, FieldComponent
+from luminarycloud.vis import Field
+from typing import TYPE_CHECKING
+import luminarycloud.enum.quantity_type as quantity_type
+from .interactive_scene import InteractiveScene
+
+from .._proto.api.v0.luminarycloud.vis import vis_pb2
+
+if TYPE_CHECKING:
+    from .visualization import Scene, LookAtCamera, DirectionalCamera, ColorMap
+    from ..geometry import Geometry
+    from ..mesh import Mesh
+    from ..solution import Solution
+
+try:
+    import luminarycloud_jupyter as lcj
+
+    if TYPE_CHECKING:
+        from luminarycloud_jupyter import InteractiveLCVisWidget, LCVisPlaneWidget
+except ImportError:
+    lcj = None
+
+
+_SOURCE_FILTER_ID = "___LC_SOURCE_FILTER___"
+
+# Global workspace state configuration
+# We use this to provide a constructed context to the LCVis widget so that we can visualize
+# the surface inference results.
+WORKSPACE_STATE_CONFIG = {
+    "connections": {_SOURCE_FILTER_ID: []},
+    "filters": [
+        {
+            "id": _SOURCE_FILTER_ID,
+            "name": "LcMeshSource",
+            "params": {
+                "fvm_params": "",
+                "url": "dummy",
+            },
+        }
+    ],
+    "workspace_params": {"edge_mode": "boundary"},
+}
+
+
+class InteractiveInference(InteractiveScene):
+    """
+    The InteractiveInference acts as the bridge between the RenderData and
+    the Jupyter widget, handling checking if we have the widget package
+    before passing calls to the widget to handle it being an optional
+    dependency
+    """
+
+    def __init__(self, signed_url: str, mode: SceneMode = SceneMode.INLINE) -> None:
+        # Initialize the widget directly without calling parent constructor
+        # since we don't have a real Scene object and override set_scene anyway
+        if not lcj:
+            raise ImportError(
+                "Interactive visualization requires luminarycloud[jupyter] to be installed"
+            )
+        self.widget = lcj.LCVisWidget(scene_mode=mode)
+        self._scene = None  # Not used in InteractiveInference
+
+        # Do inference-specific setup
+        self.set_signed_url(signed_url, False)
+        # Known quantities written by inference
+        self._valid_quantities = [
+            VisQuantity.NONE,
+            VisQuantity.PRESSURE,
+            VisQuantity.WALL_SHEAR_STRESS,
+        ]
+
+    def set_signed_url(self, signed_url: str, isComparator: bool) -> None:
+        # TODO(matt): we could make isCompartor an index so we could compare
+        # more than two scenes at once.
+
+        # Import here to avoid circular import issue
+        from .visualization import LookAtCamera
+
+        WORKSPACE_STATE_CONFIG["filters"][0]["params"]["url"] = signed_url
+        resp = vis_pb2.GetRenderDataUrlsResponse()
+        resp.urls.filter_ids.append(_SOURCE_FILTER_ID)
+        file = resp.urls.data_files.add()
+        file.signed_url = signed_url
+        resp.urls.data_files.append(file)
+        resp.workspace_state = json.dumps(WORKSPACE_STATE_CONFIG)
+
+        self.widget.set_workspace_state(resp, isComparator)
+
+        self.reset_camera()
+        self.widget.set_flat_shading(True)
+
+    def get_field_range(self, quantity: VisQuantity) -> list[float]:
+        """
+        Get the field range for a given quantity.
+        """
+        if quantity not in self._valid_quantities:
+            raise ValueError(
+                f"Invalid field quantity: {quantity}. Valid quantities are: {self._valid_quantities}"
+            )
+        return self.widget.get_field_range(quantity)
+
+    def set_display_field(self, field: Field) -> None:
+        if field.quantity not in self._valid_quantities:
+            raise ValueError(
+                f"Invalid field quantity: {field.quantity}. Valid quantities are: {self._valid_quantities}"
+            )
+        if not quantity_type._is_vector(field.quantity):
+            # We normally handle this on the backend, but we are sending this directly
+            # to lcvis, so we need to make sure scalars are set to the X component
+            field.component = FieldComponent.X
+        attrs = DisplayAttributes()
+        attrs.field = field
+        attrs.visible = True
+        attrs.representation = Representation.SURFACE
+        self.widget.set_display_attributes(_SOURCE_FILTER_ID, attrs)
+
+    def get_field_ranges(self) -> dict[str, list[float]]:
+        """
+        Get the field ranges from the widget.
+        """
+        return self.widget.field_data_map
+
+    def set_color_map(self, color_map: "ColorMap") -> None:
+        if color_map.field.quantity not in self._valid_quantities:
+            raise ValueError(
+                f"Invalid field quantity: {color_map.field.quantity}. Valid quantities are: {self._valid_quantities}"
+            )
+        if not quantity_type._is_vector(color_map.field.quantity):
+            # We normally handle this on the backend, but we are sending this directly
+            # to lcvis, so we need to make sure scalars are set to the X component
+            color_map.field.component = FieldComponent.X
+        super().set_color_map(color_map)
+
+    def set_scene(self, scene: "Scene", isComparator: bool = False) -> None:
+        """
+        InteractiveInference does not support setting scenes.
+        Use set_signed_url() instead to load inference data.
+        """
+        raise NotImplementedError(
+            "InteractiveInference does not support set_scene(). Use set_signed_url() to load inference data."
+        )
+
+    def compare(self, entity) -> None:
+        """
+        InteractiveInference does not support scene comparison.
+        """
+        raise NotImplementedError(
+            "InteractiveInference does not support compare(). This feature is only available for InteractiveScene."
+        )

luminarycloud/vis/interactive_scene.py

@@ -8,13 +8,16 @@ from typing import TYPE_CHECKING, cast, Union
 from .._proto.api.v0.luminarycloud.vis import vis_pb2
 
 if TYPE_CHECKING:
-    from .visualization import Scene, LookAtCamera, ColorMap
+    from .visualization import Scene, LookAtCamera, DirectionalCamera, ColorMap
     from ..geometry import Geometry
     from ..mesh import Mesh
     from ..solution import Solution
 
 try:
     import luminarycloud_jupyter as lcj
+
+    if TYPE_CHECKING:
+        from luminarycloud_jupyter import InteractiveLCVisWidget, LCVisPlaneWidget
 except ImportError:
     lcj = None
 
@@ -105,7 +108,7 @@ class InteractiveScene:
         # is moved there. Matt: this would be a lot of work. The current vis service
         # call used in the backend doesn't use the streaming version. Further, there is
         # a lot of extra code to manage the streaming callbacks.
-        self.widget.set_workspace_state(scene, resp, isComparator)
+        self.widget.set_workspace_state(resp, isComparator)
 
         # Sync display attributes and visibilities for surfaces
         self.set_display_attributes(_SOURCE_FILTER_ID, scene.global_display_attrs)
@@ -115,21 +118,16 @@ class InteractiveScene:
         for f in scene._filters:
             self.set_display_attributes(f.id, f.display_attrs)
 
-        # Find and apply the first look at camera, if any, in the scene
-        set_camera = False
-        for c in scene._cameras:
-            if not isinstance(c, LookAtCamera):
-                continue
-            set_camera = True
-            self.set_camera(c)
-
         # Set any color maps we have. TODO(matt): only a few attributes are connected atm.
         for color_map in scene._color_maps:
             self.set_color_map(color_map)
 
+        # Apply the first camera, if any, in the scene
         # If we don't have an initial camera to use, reset the camera after loading
         # the workspace state
-        if not set_camera:
+        if len(scene._cameras) > 0:
+            self.set_camera(scene._cameras[0])
+        else:
             self.reset_camera()
 
     def set_surface_visibility(self, surface_id: str, visible: bool) -> None:
@@ -144,11 +142,26 @@ class InteractiveScene:
     def reset_camera(self) -> None:
         self.widget.reset_camera()
 
-    def set_camera(self, camera: "LookAtCamera") -> None:
-        self.widget.camera_pan = [camera.pan_x, camera.pan_y]
-        self.widget.camera_position = [camera.position[0], camera.position[1], camera.position[2]]
-        self.widget.camera_look_at = [camera.look_at[0], camera.look_at[1], camera.look_at[2]]
-        self.widget.camera_up = [camera.up[0], camera.up[1], camera.up[2]]
+    def set_camera(self, camera: "LookAtCamera | DirectionalCamera") -> None:
+        # Import here to avoid circular import issue
+        from .visualization import LookAtCamera
+
+        # Clear any prev camera state
+        self.widget.camera_position = []
+        self.widget.camera_look_at = []
+        self.widget.camera_up = []
+        self.widget.camera_pan = []
+        if isinstance(camera, LookAtCamera):
+            self.widget.camera_position = [
+                camera.position[0],
+                camera.position[1],
+                camera.position[2],
+            ]
+            self.widget.camera_look_at = [camera.look_at[0], camera.look_at[1], camera.look_at[2]]
+            self.widget.camera_up = [camera.up[0], camera.up[1], camera.up[2]]
+            self.widget.camera_pan = [camera.pan_x, camera.pan_y, 0]
+        else:
+            self.widget.set_camera_orientation(camera.direction)
 
     def set_color_map(self, color_map: "ColorMap") -> None:
         self.widget.set_color_map(color_map)
@@ -170,6 +183,12 @@ class InteractiveScene:
     def set_triad_visible(self, visible: bool) -> None:
         self.widget.set_triad_visible(visible)
 
+    def add_plane_widget(self) -> "LCVisPlaneWidget":
+        return self.widget.add_plane_widget()
+
+    def delete_widget(self, widget: "InteractiveLCVisWidget") -> None:
+        self.widget.delete_widget(widget)
+
     def compare(self, entity: Union["Geometry", "Mesh", "Solution"]) -> None:
         # The entity can be a Geometry, Mesh, or Solution and is checked by the
         # clone method. This can raise error if the scenes are incompatiable.

luminarycloud/vis/primitives.py

@@ -33,6 +33,9 @@ class Plane(CodeRepr):
         self.normal = Vector3()
         self.normal._from_proto(proto.normal)
 
+    def __repr__(self) -> str:
+        return self._to_code_helper(obj_name="plane")
+
 
 @dc.dataclass
 class Box(CodeRepr):
@@ -78,6 +81,9 @@ class Box(CodeRepr):
         self.angles.y = proto.angles.y * (180 / math.pi)
         self.angles.z = proto.angles.z * (180 / math.pi)
 
+    def __repr__(self) -> str:
+        return self._to_code_helper(obj_name="box")
+
 
 @dc.dataclass
 class AABB(CodeRepr):
@@ -114,3 +120,6 @@ class AABB(CodeRepr):
         max_point = Vector3()
         max_point._from_proto(proto.max)
         self.max = max_point
+
+    def __repr__(self) -> str:
+        return self._to_code_helper(obj_name="aabb")

luminarycloud/vis/visualization.py

@@ -99,6 +99,9 @@ class DirectionalCamera(CodeRepr):
         self.height = static_ani.resolution.height
         self.projection = CameraProjection(static_ani.camera.projection)
 
+    def __repr__(self) -> str:
+        return self._to_code_helper(obj_name="camera")
+
 
 @dc.dataclass
 class LookAtCamera(CodeRepr):
@@ -158,6 +161,9 @@ class LookAtCamera(CodeRepr):
         self.height = static_ani.resolution.height
         self.projection = CameraProjection(static_ani.camera.projection)
 
+    def __repr__(self) -> str:
+        return self._to_code_helper(obj_name="camera")
+
 
 class RenderOutput:
     """

luminarycloud/volume_selection.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 
 import logging
 from os import PathLike
-from typing import Iterable, Iterator, Optional, TYPE_CHECKING
+from typing import TYPE_CHECKING, Iterable, Iterator, Optional
 from uuid import uuid4
 
 from luminarycloud._helpers import util
@@ -12,6 +12,7 @@ from luminarycloud._proto.api.v0.luminarycloud.geometry import (
     geometry_pb2 as geometrypb,
 )
 from luminarycloud._proto.upload import upload_pb2 as uploadpb
+from luminarycloud.types.adfloat import _from_ad_proto, _to_ad_proto
 
 from ._client import get_default_client
 from ._proto.base import base_pb2 as basepb
@@ -157,7 +158,7 @@ class VolumeSelection:
         feature.import_geometry.CopyFrom(
             gpb.ImportGeometry(
                 geometry_url=cad_url,
-                scaling=scaling,
+                scaling=_to_ad_proto(scaling),
             )
         )
         self.__create_feature(feature)

{luminarycloud-0.17.0.dist-info → luminarycloud-0.18.0.dist-info}/METADATA

@@ -1,34 +1,34 @@
 Metadata-Version: 2.4
 Name: luminarycloud
-Version: 0.17.0
+Version: 0.18.0
 Summary: Luminary Cloud SDK
 Project-URL: Homepage, https://www.luminarycloud.com/
 Project-URL: Documentation, https://app.luminarycloud.com/docs/api/
 Author-email: "Luminary Cloud Inc." <support@luminarycloud.com>
 Keywords: Luminary Cloud,SDK
 Requires-Python: >=3.10
-Requires-Dist: google-crc32c~=1.6.0
-Requires-Dist: googleapis-common-protos~=1.58
-Requires-Dist: grpcio-status~=1.51
-Requires-Dist: grpcio-tools~=1.51
-Requires-Dist: grpcio~=1.51
-Requires-Dist: importlib-metadata~=6.0.0
+Requires-Dist: google-crc32c~=1.7
+Requires-Dist: googleapis-common-protos~=1.70
+Requires-Dist: grpcio-status~=1.65
+Requires-Dist: grpcio-tools~=1.65
+Requires-Dist: grpcio~=1.65
+Requires-Dist: importlib-metadata~=8.7
 Requires-Dist: opentelemetry-api~=1.25
 Requires-Dist: opentelemetry-exporter-otlp-proto-common~=1.25
 Requires-Dist: opentelemetry-exporter-otlp-proto-http~=1.25
-Requires-Dist: opentelemetry-instrumentation-grpc~=0.46b0
-Requires-Dist: opentelemetry-instrumentation~=0.46b0
+Requires-Dist: opentelemetry-instrumentation-grpc~=0.55b1
+Requires-Dist: opentelemetry-instrumentation~=0.55b1
 Requires-Dist: opentelemetry-proto~=1.25
 Requires-Dist: opentelemetry-sdk~=1.25
-Requires-Dist: opentelemetry-semantic-conventions~=0.46b0
-Requires-Dist: protobuf~=4.21
-Requires-Dist: pyjwt~=2.6
-Requires-Dist: python-dotenv~=1.0.0
-Requires-Dist: pyyaml~=6.0.2
-Requires-Dist: requests~=2.28
-Requires-Dist: waitress~=3.0.1
-Requires-Dist: werkzeug~=3.0.1
-Requires-Dist: zstandard
+Requires-Dist: opentelemetry-semantic-conventions~=0.55b1
+Requires-Dist: protobuf~=5.29
+Requires-Dist: pyjwt~=2.10
+Requires-Dist: python-dotenv~=1.1
+Requires-Dist: pyyaml~=6.0
+Requires-Dist: requests~=2.32
+Requires-Dist: waitress~=3.0
+Requires-Dist: werkzeug~=3.1
+Requires-Dist: zstandard~=0.23
 Provides-Extra: jupyter
 Requires-Dist: luminarycloud-jupyter; extra == 'jupyter'
 Description-Content-Type: text/markdown