luminarycloud 0.19.0__py3-none-any.whl → 0.22.0__py3-none-any.whl

luminarycloud/project.py

@@ -12,6 +12,7 @@ import concurrent
 
 import luminarycloud as lc
 from luminarycloud._helpers.named_variables import _named_variables_to_proto
+from luminarycloud._helpers.pagination import PaginationIterator
 from luminarycloud.params.simulation.adjoint_ import Adjoint
 
 from ._client import get_default_client
@@ -198,8 +199,6 @@ class Project(ProtoWrapperBase):
     def load_geometry_to_setup(self, geometry: "Geometry") -> None:
         """
         Load a geometry to the setup phase.
-        NOTE: this operation is irreversible and deletes all the existing meshes and simulations
-        in the project.
 
         Parameters
         ----------
@@ -324,6 +323,8 @@ class Project(ProtoWrapperBase):
         names_to_file_paths: Dict[str, Union[PathLike[Any], str]],
         params: hexmeshpb.HexMeshSpec,
         use_internal_wrap: bool = False,
+        request_id: Optional[str] = None,
+        n_vcpus: Optional[int] = None,
     ) -> "Mesh":
         """
         Creates a hex mesh. Only for internal use.
@@ -361,7 +362,14 @@ class Project(ProtoWrapperBase):
 
         params.use_wrap = use_internal_wrap
 
-        req = meshpb.CreateHexMeshRequest(project_id=self.id, hex_mesh_config=params)
+        if request_id is None:
+            request_id = str(uuid.uuid4())
+        req = meshpb.CreateHexMeshRequest(
+            project_id=self.id,
+            hex_mesh_config=params,
+            request_id=request_id,
+            n_vcpus=n_vcpus,
+        )
 
         res: meshpb.CreateHexMeshResponse = client.CreateHexMesh(req)
         get_mesh_res = client.GetMesh(meshpb.GetMeshRequest(id=res.mesh_id))
@@ -785,53 +793,13 @@ def list_projects() -> list[Project]:
     return list(iterate_projects())
 
 
-class ProjectIterator:
+class ProjectIterator(PaginationIterator[Project]):
     """Iterator class for projects that provides length hint."""
 
-    def __init__(self, page_size: int):
-        self._page_size: int = page_size
-        self._page_token: str = ""
-        self._total_count: Optional[int] = None
-        self._current_page: Optional[list[projectpb.Project]] = None
-        self._client = get_default_client()
-        self._iterated_count: int = 0
-
-    def __iter__(self) -> "ProjectIterator":
-        return self
-
-    def __next__(self) -> Project:
-        if self._current_page is None:
-            self._fetch_next_page()
-
-        # _current_page really can't be None here, but this assertion is needed to appease mypy
-        assert self._current_page is not None
-
-        if len(self._current_page) == 0:
-            if not self._page_token:
-                raise StopIteration
-            self._fetch_next_page()
-
-        self._iterated_count += 1
-
-        return Project(self._current_page.pop(0))
-
-    def _fetch_next_page(self) -> None:
-        req = projectpb.ListProjectsRequest(page_size=self._page_size, page_token=self._page_token)
+    def _fetch_page(self, page_size: int, page_token: str) -> tuple[list[Project], str, int]:
+        req = projectpb.ListProjectsRequest(page_size=page_size, page_token=page_token)
         res = self._client.ListProjects(req)
-
-        self._current_page = list(res.projects)
-        self._page_token = res.next_page_token
-
-        # Set length hint on first fetch if available
-        if self._total_count is None:
-            self._total_count = res.total_count or 0
-
-    def __length_hint__(self) -> int:
-        if self._total_count is None:
-            # Fetch first page to get total size if not already fetched
-            if self._current_page is None:
-                self._fetch_next_page()
-        return max(0, (self._total_count or 0) - self._iterated_count)
+        return [Project(p) for p in res.projects], res.next_page_token, res.total_count
 
 
 def iterate_projects(page_size: int = 50) -> ProjectIterator:

luminarycloud/simulation.py

@@ -57,6 +57,8 @@ class Simulation(ProtoWrapperBase):
     "ID of the simulation mesh."
     project_id: ProjectID
     "ID of the project containing this simulation."
+    doe_name: str
+    "Name of the design of experiments that created this simulation."
 
     _proto: simulationpb.Simulation
 
@@ -122,8 +124,7 @@ class Simulation(ProtoWrapperBase):
             interval_seconds=interval_seconds,
             timeout_seconds=timeout_seconds,
         )
-        self._proto = get_simulation(self.id)._proto
-        return self.status
+        return self.refresh().status
 
     def refresh(self) -> "Simulation":
         """
@@ -194,6 +195,12 @@ class Simulation(ProtoWrapperBase):
         """
         Downloads surface outputs (e.g. lift, drag, ...) in csv format.
 
+        Unless `reference_values` is explicitly passed, the Simulation's reference values -- i.e.
+        the ones specified when the Simulation was created -- will be used for computing
+        non-dimensional output quantities. While the Luminary Cloud UI lets you update the reference
+        values on a Simulation result after it has run, those updates only affect the output
+        calculations seen in the UI, they have no effect on the ones retrieved by this method.
+
         Parameters
         ----------
         quantity_type : luminarycloud.enum.QuantityType
@@ -205,9 +212,9 @@ class Simulation(ProtoWrapperBase):
         Other Parameters
         ----------------
         reference_values : ReferenceValues, optional
-            Reference values used for computing forces, moments and
-            other non-dimensional output quantities. If not provided, default
-            reference values will be used.
+            Reference values used for computing forces, moments, and other non-dimensional output
+            quantities. If not provided, the simulation's reference values will be used, i.e., the
+            ones specified when the simulation was created.
         calculation_type : CalculationType, optional
             Whether the calculation should be done for all the surfaces together or each surface
             individually. Default is AGGREGATE.
@@ -304,6 +311,19 @@ class Simulation(ProtoWrapperBase):
         req = simulationpb.GetSimulationParametersRequest(id=self.id)
         return SimulationParam.from_proto(get_default_client().GetSimulationParameters(req))
 
+    def _get_workflow_id(self) -> Optional[str]:
+        """
+        Retrieves the workflow ID associated with the current simulation.
+
+        Returns
+        -------
+        str | None
+            The workflow ID corresponding to this simulation's ID, or None if the simulation
+            has no associated workflow.
+        """
+        result = _get_workflow_ids([self.id])
+        return result.get(self.id)
+
     @deprecated(
         "Use get_parameters() instead. This method will be removed in a future release.",
     )
@@ -354,3 +374,47 @@ def get_simulation(id: SimulationID) -> Simulation:
     req = simulationpb.GetSimulationRequest(id=id)
     res = get_default_client().GetSimulation(req)
     return Simulation(res.simulation)
+
+
+def _get_workflow_ids(simulation_ids: list[SimulationID]) -> dict[SimulationID, str]:
+    """
+    Get the workflow IDs corresponding to simulation IDs.
+
+    This is useful for mapping between UI-created simulations (which have workflow IDs)
+    and the simulation IDs used in the API.
+
+    Parameters
+    ----------
+    simulation_ids : list[SimulationID]
+        The simulation IDs to look up.
+
+    Returns
+    -------
+    dict[SimulationID, str]
+        A mapping from simulation ID to workflow ID. Only simulation IDs that were
+        successfully resolved to workflow IDs are present as keys. Simulation IDs are
+        omitted if:
+
+        - The simulation ID does not exist
+        - The user lacks access to the simulation's project
+        - The simulation has no associated workflow ID
+
+    Examples
+    --------
+    >>> import luminarycloud as lc
+    >>> sim_ids = [lc.SimulationID("sim_123"), lc.SimulationID("sim_456")]
+    >>> workflow_ids = lc._get_workflow_ids(sim_ids)
+    >>> print(workflow_ids)
+    {SimulationID('sim_123'): 'wf_abc', SimulationID('sim_456'): 'wf_def'}
+
+    >>> # Check if a simulation has a workflow
+    >>> sim_id = lc.SimulationID("sim_123")
+    >>> if sim_id in workflow_ids:
+    ...     print(f"Workflow ID: {workflow_ids[sim_id]}")
+    ... else:
+    ...     print("No workflow found")
+    """
+    req = simulationpb.GetWorkflowIDsRequest(simulation_ids=simulation_ids)
+    res = get_default_client().GetWorkflowIDs(req)
+    # Return dict with SimulationID keys (not str keys)
+    return {SimulationID(sim_id): wf_id for sim_id, wf_id in res.data.items()}

luminarycloud/simulation_param.py

@@ -232,15 +232,6 @@ class SimulationParam(_SimulationParam):
                 f"physics {_stringify_identifier(v.physics_identifier)}. Overwriting..."
             ),
         )
-        _remove_from_list_with_warning(
-            _list=volume_physics_pairs,
-            _accessor=lambda v: get_id(v.physics_identifier),
-            _to_remove=get_id(physics.physics_identifier),
-            _warning_message=lambda v: (
-                f"Physics {_stringify_identifier(physics.physics_identifier)} has already been "
-                f"assigned to volume {_stringify_identifier(v.volume_identifier)}. Overwriting..."
-            ),
-        )
 
         if volume_identifier.id not in (get_id(v.volume_identifier) for v in self.volume_entity):
             self.volume_entity.append(VolumeEntity(volume_identifier=volume_identifier))

luminarycloud/simulation_template.py

@@ -490,7 +490,8 @@ class SimulationTemplate(ProtoWrapperBase):
         code += "\n\n\n"
         code += '# Create a new simulation template or modify the one that is synced with the UI "Setup" tab.\n'
         code += f'project = luminarycloud.get_project("{self.project_id}")\n'
-        code += f"template = project.create_simulation_template(name={self.name})\n"
+        escaped_name = self.name.replace('\\','\\\\').replace('"','\\"')
+        code += f'template = project.create_simulation_template(name="{escaped_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"
 

luminarycloud/types/matrix3.py

@@ -20,7 +20,19 @@ class Matrix3:
             c=basepb.Vector3(x=self.c.x, y=self.c.y, z=self.c.z),
         )
 
+    def _to_ad_proto(self) -> basepb.AdMatrix3:
+        return basepb.AdMatrix3(
+            a=self.a._to_ad_proto(),
+            b=self.b._to_ad_proto(),
+            c=self.c._to_ad_proto(),
+        )
+
     def _from_proto(self, proto: basepb.Matrix3) -> None:
         self.a = Vector3(x=proto.a.x, y=proto.a.y, z=proto.a.z)
         self.b = Vector3(x=proto.b.x, y=proto.b.y, z=proto.b.z)
         self.c = Vector3(x=proto.c.x, y=proto.c.y, z=proto.c.z)
+
+    def _from_ad_proto(self, proto: basepb.AdMatrix3) -> None:
+        self.a = Vector3.from_ad_proto(proto.a)
+        self.b = Vector3.from_ad_proto(proto.b)
+        self.c = Vector3.from_ad_proto(proto.c)

luminarycloud/vis/__init__.py

@@ -4,8 +4,14 @@ from .visualization import (
     EntityType as EntityType,
     list_renders as list_renders,
     list_quantities as list_quantities,
+    list_quantities as list_quantities,
+    list_cameras as list_cameras,
+    RangeResult as RangeResult,
+    range_query as range_query,
+    get_camera as get_camera,
     DirectionalCamera as DirectionalCamera,
     LookAtCamera as LookAtCamera,
+    CameraEntry as CameraEntry,
 )
 
 from .primitives import (
@@ -52,3 +58,14 @@ from .interactive_scene import (
 from .interactive_inference import (
     InteractiveInference as InteractiveInference,
 )
+
+# Unreleased/internal for testing now
+
+# from .report import (
+#    Report as Report,
+# )
+
+# from .interactive_report import (
+#    InteractiveReport as InteractiveReport,
+#    ReportEntry as ReportEntry,
+# )

luminarycloud/vis/data_extraction.py

@@ -22,6 +22,7 @@ from luminarycloud.params.simulation.physics.fluid.boundary_conditions import Fa
 from .._helpers._code_representation import CodeRepr
 from ..types import SimulationID
 from collections import defaultdict
+import copy
 
 
 logger = logging.getLogger(__name__)
@@ -227,14 +228,14 @@ class ExtractOutput:
         extract_id: str,
         project_id: str,
         name: str,
-        desciption: str,
+        description: str,
         status: ExtractStatusType,
     ) -> None:
         self._extract_id = extract_id
         self._project_id = project_id
         self.status = status
         self.name = name
-        self.description = desciption
+        self.description = description
 
     def __repr__(self) -> str:
         return f"ExtractOutput (Id: {self._extract_id} status: {self.status})"
@@ -563,7 +564,7 @@ class DataExtractor:
             extract_id=res.extract.extract_id,
             project_id=self._project_id,
             name=name,
-            desciption=description,
+            description=description,
             status=ExtractStatusType(res.extract.status),
         )
         return extract_output
@@ -657,6 +658,21 @@ class DataExtractor:
 
         return imports + code
 
+    def clone(self, solution: Solution) -> "DataExtractor":
+        """
+        Clone this extract based on a new solution. This is a deep copy
+        operation. Both solution must be compatible with one another, meaning
+        they share tags or surfaces ids for extractors such as
+        IntersectionCurve.
+        """
+        if not isinstance(solution, Solution):
+            raise TypeError("Expected a Solution object.")
+        cloned = DataExtractor(solution)
+        for extract in self._extracts:
+            copied_extract = copy.deepcopy(extract)
+            cloned.add_data_extract(copied_extract)
+        return cloned
+
 
 def list_data_extracts(solution: Solution) -> list[ExtractOutput]:
     """
@@ -700,7 +716,7 @@ def list_data_extracts(solution: Solution) -> list[ExtractOutput]:
             extract_id=extract.extract_id,
             project_id=extract.project_id,
             name=extract.name,
-            desciption=extract.description,
+            description=extract.description,
             status=ExtractStatusType(extract.status),
         )
         # This need to be fixed on the backend, but manually refreshing works for now.

luminarycloud/vis/interactive_report.py

@@ -0,0 +1,110 @@
+import io
+from .visualization import RenderOutput
+from .report import ReportEntry
+
+try:
+    import luminarycloud_jupyter as lcj
+except ImportError:
+    lcj = None
+
+
+class InteractiveReport:
+    """
+    Interactive report widget with lazy loading for large datasets.
+
+    How it works:
+    1. on initialization:
+       - sends metadata for all rows (for filtering/selection)
+       - downloads the first row (to determine grid dimensions)
+       - other rows remain unloaded
+
+    2. on user request:
+       - _load_row_data() is called with row index
+       - downloads and sends images/plots for that specific row
+       - python sets row_states to 'loading' -> 'loaded' (or 'error')
+
+    This allows working with 1000+ row datasets without waiting for all data upfront.
+    """
+
+    # TODO Will/Matt: this list of report entries could be how we store stuff in the DB
+    # for interactive reports, to reference the post proc. extracts. A report is essentially
+    # a bunch of extracts + metadata.
+    def __init__(self, entries: list[ReportEntry]) -> None:
+        if not lcj:
+            raise ImportError("InteractiveScene requires luminarycloud[jupyter] to be installed")
+
+        self.entries = entries
+        if len(self.entries) == 0:
+            raise ValueError("Invalid number of entries, must be > 0")
+
+        # Determine grid dimensions by downloading first entry
+        # to understand the structure (number of columns)
+        first_entry = self.entries[0]
+        first_entry.download_extracts()
+
+        # Calculate actual number of columns by counting how many cells
+        # each extract produces (RenderOutput can produce multiple images)
+        ncols = 0
+        for extract in first_entry._extracts:
+            if isinstance(extract, RenderOutput):
+                image_and_label = extract.download_images()
+                ncols += len(image_and_label)
+            else:
+                ncols += 1  # Plot data extracts produce one cell
+
+        nrows = len(self.entries)
+
+        # Create widget with metadata but without data
+        self.widget = lcj.EnsembleWidget([re._metadata for re in self.entries], nrows, ncols)
+
+        # Set the callback for lazy loading row data
+        self.widget.set_row_data_callback(self._load_row_data)
+
+    def _load_row_data(self, row: int) -> None:
+        """
+        Load and send data for a specific row to the widget.
+        This is called on-demand when the user requests data for a row.
+        """
+        re = self.entries[row]
+
+        # Download extracts if not already downloaded
+        if len(re._extracts) == 0:
+            re.download_extracts()
+
+        # Process each extract and send to widget
+        # Track the actual column index as we may have multiple cells per extract
+        col = 0
+        for extract in re._extracts:
+            if isinstance(extract, RenderOutput):
+                image_and_label = extract.download_images()
+                # Each image gets its own column
+                for il in image_and_label:
+                    self.widget.set_cell_data(row, col, il[0].getvalue(), "jpg")
+                    col += 1
+            else:
+                plot_data = extract.download_data()
+                data = plot_data[0][0]
+                all_axis_labels = data[0]
+
+                axis_data = []
+                for axis_idx in range(len(all_axis_labels)):
+                    axis_values = [row[axis_idx] for row in data[1:]]
+                    axis_data.append(axis_values)
+
+                self.widget.set_cell_scatter_plot(
+                    row,
+                    col,
+                    f"Row #{row} - Multi-axis Plot",
+                    all_axis_labels,
+                    axis_data,
+                    plot_name=f"plot-{row}",
+                    plot_mode="markers",
+                )
+                col += 1
+
+    def _ipython_display_(self) -> None:
+        """
+        When the InteractiveReport is shown in Jupyter we show the underlying widget
+        to run the widget's frontend code
+        """
+        self.widget._ipython_display_()

luminarycloud/vis/interactive_scene.py

@@ -18,7 +18,16 @@ try:
     import luminarycloud_jupyter as lcj
 
     if TYPE_CHECKING:
-        from luminarycloud_jupyter import InteractiveLCVisWidget, LCVisPlaneWidget
+        from luminarycloud_jupyter import (
+            InteractiveLCVisWidget,
+            LCVisPlaneWidget,
+            LCVisLineWidget,
+            LCVisBoxWidget,
+            LCVisCylinderWidget,
+            LCVisHalfSphereWidget,
+            LCVisSphereWidget,
+            LCVisFinitePlaneWidget,
+        )
 except ImportError:
     lcj = None
 
@@ -134,7 +143,7 @@ class InteractiveScene:
     def set_surface_visibility(self, surface_id: str, visible: bool) -> None:
         self.widget.set_surface_visibility(surface_id, visible)
 
-    def set_surface_color(self, surface_id: str, color: list[float]) -> None:
+    def set_surface_color(self, surface_id: str, color: "list[float]") -> None:
         self.widget.set_surface_color(surface_id, color)
 
     def set_display_attributes(self, object_id: str, attrs: DisplayAttributes) -> None:
@@ -199,6 +208,24 @@ class InteractiveScene:
     def add_plane_widget(self) -> "LCVisPlaneWidget":
         return self.widget.add_plane_widget()
 
+    def add_line_widget(self) -> "LCVisLineWidget":
+        return self.widget.add_line_widget()
+
+    def add_box_widget(self) -> "LCVisBoxWidget":
+        return self.widget.add_box_widget()
+
+    def add_cylinder_widget(self) -> "LCVisCylinderWidget":
+        return self.widget.add_cylinder_widget()
+
+    def add_half_sphere_widget(self) -> "LCVisHalfSphereWidget":
+        return self.widget.add_half_sphere_widget()
+
+    def add_finite_plane_widget(self) -> "LCVisFinitePlaneWidget":
+        return self.widget.add_finite_plane_widget()
+
+    def add_sphere_widget(self) -> "LCVisSphereWidget":
+        return self.widget.add_sphere_widget()
+
     def delete_widget(self, widget: "InteractiveLCVisWidget") -> None:
         self.widget.delete_widget(widget)