luminarycloud 0.20.0__py3-none-any.whl → 0.21.1__py3-none-any.whl

luminarycloud/simulation.py

@@ -195,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
@@ -206,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.

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/vis/__init__.py

@@ -6,6 +6,8 @@ from .visualization import (
     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,

luminarycloud/vis/interactive_report.py

@@ -1,10 +1,6 @@
 import io
-from . import ExtractOutput
-from .vis_util import _InternalToken, _get_status
 from .visualization import RenderOutput
-from ..enum import ExtractStatusType
-from .._client import get_default_client
-from .._proto.api.v0.luminarycloud.vis import vis_pb2
+from .report import ReportEntry
 
 try:
     import luminarycloud_jupyter as lcj
@@ -12,42 +8,24 @@ except ImportError:
     lcj = None
 
 
-# TODO Will/Matt: this could be something like what we store in the DB
-# A report can contain a list of report entries that reference post proc.
-# extracts + styling info for how they should be displayed
-class ReportEntry:
-    def __init__(
-        self, project_id: str, extract_ids: list[str] = [], metadata: dict[str, str | float] = {}
-    ) -> None:
-        self._project_id = project_id
-        self._extract_ids = extract_ids
-        self._extracts: list[ExtractOutput | RenderOutput] = []
-        self._metadata = metadata
-
-    # Download all extracts for this report entry
-    def download_extracts(self) -> None:
-        self._extracts = []
-        for eid in self._extract_ids:
-            status = _get_status(self._project_id, eid)
-            if status != ExtractStatusType.COMPLETED:
-                raise Exception(f"Extract {eid} is not complete")
-            req = vis_pb2.DownloadExtractRequest()
-            req.extract_id = eid
-            req.project_id = self._project_id
-            # TODO: This is a bit awkward in that we download the extract to figure out what type
-            # it is, but this is just a temporary thing, later we'll have a report DB table that
-            # stores the extracts for a report and their types, etc.
-            res: vis_pb2.DownloadExtractResponse = get_default_client().DownloadExtract(req)
-            extract = (
-                ExtractOutput(_InternalToken())
-                if res.HasField("line_data")
-                else RenderOutput(_InternalToken())
-            )
-            extract._set_data(eid, self._project_id, eid, eid, status)
-            self._extracts.append(extract)
+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.
+    """
 
-class InteractiveReport:
     # 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.
@@ -59,62 +37,70 @@ class InteractiveReport:
         if len(self.entries) == 0:
             raise ValueError("Invalid number of entries, must be > 0")
 
-        report_data = []
-        for row, re in enumerate(self.entries):
-            row_data = []
-            re.download_extracts()
-            for extract in re._extracts:
-                if isinstance(extract, RenderOutput):
-                    image_and_label = extract.download_images()
-                    row_data.extend([il[0] for il in image_and_label])
-                else:
-                    plot_data = extract.download_data()
-                    # Plot absolute pressure for each intersection curve we have
-                    # TODO will: make these params of the extract/report entry
-                    # We'll pick the first item that's not x/y/z coordinates to be the data we plot
-                    x_axis = "x"
-                    y_axis = [n for n in plot_data[0][0][0] if n != "x" and n != "y" and n != "z"][
-                        0
-                    ]
-                    scatter_plots = []
-                    for p in plot_data:
-                        data = p[0]
-                        x_idx = data[0].index(x_axis)
-                        y_idx = data[0].index(y_axis)
-
-                        scatter_data = lcj.ScatterPlotData()
-                        scatter_data.name = f"plot-{row}"
-                        for r in data[1:]:
-                            scatter_data.x.append(r[x_idx])
-                            scatter_data.y.append(r[y_idx])
-                        scatter_plots.append(scatter_data)
-                    row_data.append(scatter_plots)
-
-            report_data.append(row_data)
-
-        # TODO Validate the grid configuration is valid, all report entries should have the
-        # same # of extract IDs and metadata keys
-        # maybe not needed, b/c this is something we'd control internally later?
-        nrows = len(report_data)
-        ncols = len(report_data[0]) if len(report_data) > 0 else 0
-
-        for i, r in enumerate(report_data):
-            if len(r) != ncols:
-                raise ValueError(
-                    f"Invalid report configuration: row {i} does not have {ncols} columns"
-                )
+        # 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)
-        for row, row_data in enumerate(report_data):
-            for col, col_data in enumerate(row_data):
-                if isinstance(col_data, list) and isinstance(col_data[0], lcj.ScatterPlotData):
-                    x_axis = "x"
-                    y_axis = "Absolute Pressure (Pa)"
-                    self.widget.set_cell_scatter_plot(
-                        row, col, f"{row} {y_axis} v {x_axis}", x_axis, y_axis, col_data
-                    )
-                elif isinstance(col_data, io.BytesIO):
-                    self.widget.set_cell_data(row, col, col_data.getvalue(), "jpg")
+
+        # 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:
         """

luminarycloud/vis/report.py

@@ -1,19 +1,162 @@
-from .visualization import Scene, RenderOutput
+import json
+import os
+from typing import TYPE_CHECKING
+
+from .visualization import Scene, RenderOutput, range_query
 from .data_extraction import DataExtractor, ExtractOutput
-from ..enum import RenderStatusType, ExtractStatusType
+from ..enum import RenderStatusType, ExtractStatusType, FieldAssociation
 from ..solution import Solution
+from .vis_util import _InternalToken, _get_status
 from time import sleep
+from .._proto.api.v0.luminarycloud.vis import vis_pb2
+from .._client import get_default_client
+from .._helpers._get_project_id import _get_project_id
+import luminarycloud.enum.quantity_type as quantity_type
+
+if TYPE_CHECKING:
+    from .interactive_report import InteractiveReport
+
+
+# TODO Will/Matt: this could be something like what we store in the DB
+# A report can contain a list of report entries that reference post proc.
+# extracts + styling info for how they should be displayed
+class ReportEntry:
+    """
+    A single entry in a report, containing references to extracts and metadata.
+    Each extract can have multiple pieces of data (e.g. multiple images for a
+    RenderOutput, or multiple curves for an ExtractOutput).  Metadata is a
+    dictionary of key/value pairs that can be used to store additional
+    information about the report entry. Typically, the metadata would include
+    things like simulation ID, lift/drag values, and scalar ranges for each
+    solution. The metadata is used to filter and sort data in the ensemble
+    widget.
+    """
+
+    def __init__(
+        self, project_id: str, extract_ids: list[str] = [], metadata: dict[str, str | float] = {}
+    ) -> None:
+        self._project_id = project_id
+        self._extract_ids = extract_ids
+        self._extracts: list[ExtractOutput | RenderOutput] = []
+        self._metadata = metadata
+        self._statuses = statuses = [RenderStatusType.INVALID] * len(self._extract_ids)
+
+    def to_dict(self) -> dict:
+        return {
+            "project_id": self._project_id,
+            "extract_ids": self._extract_ids,
+            "metadata": self._metadata,
+        }
+
+    @classmethod
+    def from_dict(cls, data: dict) -> "ReportEntry":
+        return cls(
+            project_id=data["project_id"],
+            extract_ids=data.get("extract_ids", []),
+            metadata=data.get("metadata", {}),
+        )
+
+    def refresh_statuses(self) -> None:
+        for i, eid in enumerate(self._extract_ids):
+            self._statuses[i] = _get_status(self._project_id, eid)
+
+    def is_complete(self) -> bool:
+        self.refresh_statuses()
+        return all(
+            (status == RenderStatusType.COMPLETED or status == RenderStatusType.FAILED)
+            for status in self._statuses
+        )
+
+    # Download all extracts for this report entry
+    def download_extracts(self) -> None:
+        self._extracts = []
+        for eid in self._extract_ids:
+            status = _get_status(self._project_id, eid)
+            if status != ExtractStatusType.COMPLETED:
+                raise Exception(f"Extract {eid} is not complete")
+            req = vis_pb2.DownloadExtractRequest()
+            req.extract_id = eid
+            req.project_id = self._project_id
+            # TODO: This is a bit awkward in that we download the extract to figure out what type
+            # it is, but this is just a temporary thing, later we'll have a report DB table that
+            # stores the extracts for a report and their types, etc.
+            res: vis_pb2.DownloadExtractResponse = get_default_client().DownloadExtract(req)
+            extract = (
+                ExtractOutput(_InternalToken())
+                if res.HasField("line_data")
+                else RenderOutput(_InternalToken())
+            )
+            extract._set_data(eid, self._project_id, eid, eid, status)
+            self._extracts.append(extract)
 
 
-# Notes(matt): we need a good way to pass "legend" information to the report.
-# The legend is list of scalar values that are associated with each solution in
-# the report. Examples include outputs like lift or drag, scalar ranges in the
-# solutions, or any user provided data. We could add a helper class to auto-produce
-# the legend data for common use cases or the user could provide their own. The data
-# would look like a csv file or a dictionary keyed on the solution/sim id, where each
-# entry is a list of scalar values. We would also need a header to describe what the values
-# are.
 class Report:
+    """
+    A report containing multiple report entries. There is support for
+    serialization and deserialization to/from JSON since generating the extracts
+    and metadata can be expensive.
+    """
+
+    def __init__(self, entries: list[ReportEntry]):
+        self._entries = entries
+
+    def to_dict(self) -> dict:
+        return {"entries": [entry.to_dict() for entry in self._entries]}
+
+    @classmethod
+    def from_dict(cls, data: dict) -> "Report":
+        entries = [ReportEntry.from_dict(e) for e in data.get("entries", [])]
+        return cls(entries)
+
+    def _check_status(self) -> bool:
+        """Check the status of all ReportEntries and their extracts, grouped by entry."""
+        still_pending = False
+        print("\n" + "=" * 60)
+        print("STATUS CHECK".center(60))
+        print("=" * 60)
+
+        if not self._entries:
+            raise RuntimeError("No report entries to check status.")
+
+        print(f"{'Entry':<8} | {'Extract ID':<20} | {'Status':<15}")
+        print("-" * 60)
+        for idx, entry in enumerate(self._entries):
+            entry.refresh_statuses()
+            for eid, status in zip(entry._extract_ids, entry._statuses):
+                if status != RenderStatusType.COMPLETED and status != RenderStatusType.FAILED:
+                    still_pending = True
+                print(f"{idx:<8} | {eid:<20} | {status.name:<15}")
+        print("=" * 60)
+        return still_pending
+
+    def wait_for_completion(self):
+        """Wait for all report entries' extracts to complete."""
+        if not self._entries:
+            raise RuntimeError("No report entries to wait for.")
+        while self._check_status():
+            sleep(5)
+        print("All report entries' extracts have completed.")
+
+    def interact(self) -> "InteractiveReport":
+        from .interactive_report import InteractiveReport
+
+        if not self._check_status:
+            raise ValueError("Error: report entries are still pending")
+        return InteractiveReport(self._entries)
+
+
+class ReportGenerator:
+    """
+    A helper for generating reports from multiple solutions, scenes, data extractors and
+    per solution metatdata.
+
+    Attributes:
+    -----------
+    calculate_ranges: bool
+        Whether to auto-calculate solution quantity ranges and add them to the
+        metadata. Default is False.
+    """
+
     def __init__(self, solutions: list[Solution]):
         self._scenes: list[Scene] = []
         self._data_extractors: list[DataExtractor] = []
@@ -21,6 +164,10 @@ class Report:
         # When we fire off requests we use these objects to track the progress.
         self._extract_outputs: list[ExtractOutput] = []
         self._render_outputs: list[RenderOutput] = []
+        # Controls if we should calculate solution quanity ranges
+        self.calculate_ranges: bool = False
+        # Key is solution ID, value is the metadata dict
+        self._metadata: dict[str, dict[str, str | float]] = {}
         for solution in solutions:
             if not isinstance(solution, Solution):
                 raise TypeError("Expected a list of Solution objects.")
@@ -30,69 +177,76 @@ class Report:
             raise TypeError("Expected a Scene object.")
         self._scenes.append(scene)
 
+    # TODO(Matt): we could just make this a single data extract then control how they
+    # are added to each solution.
     def add_data_extractor(self, data_extractor: DataExtractor):
         if not isinstance(data_extractor, DataExtractor):
             raise TypeError("Expected a DataExtractor object.")
         self._data_extractors.append(data_extractor)
 
-    def _check_status(self) -> bool:
-        """Check the status of all render outputs and extract outputs."""
-        still_pending = False
-        print("\n" + "=" * 60)
-        print("STATUS CHECK".center(60))
-        print("=" * 60)
-
-        if not self._render_outputs and not self._extract_outputs:
-            raise RuntimeError("No render outputs or extract outputs to check status.")
-
-        # Check render outputs
-        if self._render_outputs:
-            print(f"{'Type':<8} | {'ID':<20} | {'Status':<15}")
-            print("-" * 60)
-
-        for output in self._render_outputs:
-            if (
-                output.status != RenderStatusType.COMPLETED
-                and output.status != RenderStatusType.FAILED
-            ):
-                output.refresh()
-                still_pending = True
-            print(f"{'Render':<8} | {str(output._extract_id):<20} | {output.status.name:<15}")
-
-        # Check extract outputs
-        for output in self._extract_outputs:
-            if (
-                output.status != ExtractStatusType.COMPLETED
-                and output.status != ExtractStatusType.FAILED
-            ):
-                output.refresh()
-                still_pending = True
-            print(f"{'Extract':<8} | {str(output._extract_id):<20} | {output.status.name:<15}")
-
-        print("=" * 60)
-        return still_pending
+    def add_metadata(self, solution_id: str, metadata: dict[str, str | float]):
+        if solution_id not in self._metadata:
+            self._metadata[solution_id] = {}
+        self._metadata[solution_id].update(metadata)
 
-    def create_report_data(self):
+    def create_report(self) -> Report:
+        entries = []
         for solution in self._solution:
-            for scene in self._scenes:
-                sol_scene = scene.clone(solution)
-                self._render_outputs.append(
-                    sol_scene.render_images(
-                        name="Report Scene", description="Generated Report Scene"
-                    )
-                )
+            extract_ids = []
+            project_id = _get_project_id(solution)
+            if not project_id:
+                raise ValueError("Solution does not have a project_id.")
+            metadata = self._metadata.get(solution.id, {})
+            metadata["solution id"] = solution.id
+            if self.calculate_ranges:
+                print(f"Calculating solution quantity ranges {solution.id}")
+                ranges = range_query(solution, FieldAssociation.CELLS)
+                for range_res in ranges:
+                    if not quantity_type._is_vector(range_res.quantity):
+                        metadata[f"{range_res.field_name} min"] = range_res.ranges[0].min_value
+                        metadata[f"{range_res.field_name} max"] = range_res.ranges[0].max_value
+                    else:
+                        for r in range(len(range_res.ranges)):
+                            if r == 0:
+                                comp = "x"
+                            elif r == 1:
+                                comp = "y"
+                            elif r == 2:
+                                comp = "z"
+                            elif r == 3:
+                                comp = "mag"
+                            comp_range = range_res.ranges[r]
+                            metadata[f"{range_res.field_name} min ({comp})"] = comp_range.min_value
+                            metadata[f"{range_res.field_name} max ({comp})"] = comp_range.max_value
             for extractor in self._data_extractors:
                 sol_extractor = extractor.clone(solution)
-                self._extract_outputs.append(
-                    sol_extractor.create_extracts(
-                        name="Report Extract", description="Generated Report Extract"
-                    )
+                extract = sol_extractor.create_extracts(
+                    name="Report Extract", description="Generated Report Extract"
                 )
+                extract_ids.append(extract._extract_id)
 
-    def wait_for_completion(self):
-        """Wait for all render and extract outputs to complete."""
-        if not self._render_outputs and not self._extract_outputs:
-            raise RuntimeError("No render outputs or extract outputs to wait for.")
-        while self._check_status():
-            sleep(5)
-        print("All render and extract outputs have completed.")
+            for scene in self._scenes:
+                sol_scene = scene.clone(solution)
+                render_extract = sol_scene.render_images(
+                    name="Report Scene", description="Generated Report Scene"
+                )
+                extract_ids.append(render_extract._extract_id)
+
+            entries.append(ReportEntry(project_id, extract_ids, metadata))
+        return Report(entries)
+
+
+def save_report_to_json(report: Report, name: str, directory: str = ".") -> str:
+    """Save a Report object to a JSON file named {name}_lcreport.json in the specified directory."""
+    filename = f"{name}_lcreport.json"
+    filepath = os.path.join(directory, filename)
+    with open(filepath, "w") as f:
+        json.dump(report.to_dict(), f, indent=2)
+    return filepath
+
+
+def load_report_from_json(filepath: str) -> "Report":
+    """Load a Report object from a JSON file at the given file path."""
+    with open(filepath, "r") as f:
+        data = json.load(f)
+    return Report.from_dict(data)

luminarycloud/vis/visualization.py

@@ -24,6 +24,7 @@ from luminarycloud.enum import (
     SceneMode,
     VisQuantity,
     QuantityType,
+    FieldAssociation,
 )
 from ..exceptions import NotFoundError
 from ..geometry import Geometry, get_geometry
@@ -1094,6 +1095,65 @@ def list_quantities(solution: Solution) -> List[VisQuantity]:
     return result
 
 
+@dc.dataclass
+class RangeResult:
+    ranges: List[DataRange]
+    """
+    A list of ranges per component. Scalars have a single range and vector ranges are in
+    in x,y,z, magnitude order.
+    """
+    quantity: VisQuantity
+    """ The quantity type for the field, if available.  """
+    field_name: str
+    """ Name of the field.  """
+
+
+def range_query(solution: Solution, field_association: FieldAssociation) -> List[RangeResult]:
+    """
+    The range query returns the min/max values for all fields in a solution. Two
+    types of ranges can be chosen: cell-centered and point-centered data. The
+    results will vary based on the choice. The solver natively outputs cell-centered
+    data, so the cell based query will return the actual min/max values
+    from the solver run. Visualization operates on point-centered data, which is
+    recentered from the cell-centered data.
+
+    Parameters
+    ----------
+    solution: Solution
+        The the solution object to query.
+    field_association: FieldAssociation
+        The type of data to query, either cell-centered or point-centered.
+    """
+    if not isinstance(solution, Solution):
+        raise TypeError(f"Expected 'Solution', got {type(solution).__name__}")
+
+    if not isinstance(field_association, FieldAssociation):
+        raise TypeError(f"Expected 'FieldAssociation', got {type(field_association).__name__}")
+
+    sim = get_simulation(solution.simulation_id)
+    req = vis_pb2.RangeQueryRequest()
+    req.entity.simulation.id = solution.simulation_id
+    req.entity.simulation.solution_id = solution.id
+    req.project_id = sim.project_id
+    if field_association == FieldAssociation.POINTS:
+        req.field_association = vis_pb2.FieldAssociation.FIELD_ASSOCIATION_POINTS
+    else:
+        req.field_association = vis_pb2.FieldAssociation.FIELD_ASSOCIATION_CELLS
+    res: vis_pb2.RangeQueryReply = get_default_client().RangeQuery(req)
+    result: List[RangeResult] = []
+    for r in res.range:
+        ranges = []
+        for r_range in r.range:
+            data_range = DataRange()
+            data_range.min_value = r_range.min
+            data_range.max_value = r_range.max
+            ranges.append(data_range)
+        result.append(
+            RangeResult(ranges=ranges, quantity=VisQuantity(r.quantity), field_name=r.field_name)
+        )
+    return result
+
+
 def list_renders(entity: Geometry | Mesh | Solution) -> List[RenderOutput]:
     """
     Lists all previously created renders associated with a project and an entity.