luminarycloud 0.15.5__py3-none-any.whl → 0.16.1__py3-none-any.whl

luminarycloud/simulation_param.py

@@ -6,7 +6,6 @@ from os import PathLike
 from pprint import pformat
 from typing import Optional, TypeVar, cast
 
-import luminarycloud.params.enum._enum_wrappers as enum
 from luminarycloud._helpers._simulation_params_from_json import (
     simulation_params_from_json_path,
     simulation_params_from_json_dict,
@@ -38,7 +37,7 @@ from luminarycloud.params.simulation.volume_entity_ import (
 from luminarycloud.params.simulation import (
     SimulationParam as _SimulationParam,
 )
-from luminarycloud.reference_values import ReferenceValues, ReferenceValuesType
+from luminarycloud.reference_values import ReferenceValues
 from luminarycloud.types import Vector3Like
 from luminarycloud.types.vector3 import _to_vector3_ad_proto
 
@@ -152,7 +151,10 @@ class SimulationParam(_SimulationParam):
             _list=volume_material_pairs,
             _accessor=lambda v: get_id(v.volume_identifier),
             _to_remove=volume_identifier.id,
-            _warning_message=lambda v: f"Volume {_stringify_identifier(volume_identifier)} has already been assigned material {_stringify_identifier(v.material_identifier)}. Overwriting...",
+            _warning_message=lambda v: (
+                f"Volume {_stringify_identifier(volume_identifier)} has already been assigned "
+                f"material {_stringify_identifier(v.material_identifier)}. Overwriting..."
+            ),
         )
 
         if volume_identifier.id not in (get_id(v.volume_identifier) for v in self.volume_entity):
@@ -226,13 +228,19 @@ class SimulationParam(_SimulationParam):
             _list=volume_physics_pairs,
             _accessor=lambda v: get_id(v.volume_identifier),
             _to_remove=volume_identifier.id,
-            _warning_message=lambda v: f"Volume {_stringify_identifier(volume_identifier)} has already been assigned physics {_stringify_identifier(v.physics_identifier)}. Overwriting...",
+            _warning_message=lambda v: (
+                f"Volume {_stringify_identifier(volume_identifier)} has already been assigned "
+                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 assigned to volume {_stringify_identifier(v.volume_identifier)}. Overwriting...",
+            _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):
@@ -268,25 +276,25 @@ class SimulationParam(_SimulationParam):
         .. warning:: This feature is experimental and may change or be removed without notice.
         """
         self.adjoint = self.adjoint or Adjoint()
-        self.adjoint.output = outputpb.Output()
-        self.adjoint.output.quantity = quantity_type.value
-        self.adjoint.output.in_surfaces.extend(surface_ids)
-        self.adjoint.output.frame_id = frame_id
+        self.adjoint._output = outputpb.Output()
+        self.adjoint._output.quantity = quantity_type.value
+        self.adjoint._output.in_surfaces.extend(surface_ids)
+        self.adjoint._output.frame_id = frame_id
         if QuantityType._is_average(quantity_type):
             if averaging_type == AveragingType.UNSPECIFIED:
-                self.adjoint.output.surface_average_properties.averaging_type = (
+                self.adjoint._output.surface_average_properties.averaging_type = (
                     SpaceAveragingType.NO_AVERAGING.value
                 )
             elif averaging_type == AveragingType.AREA:
-                self.adjoint.output.surface_average_properties.averaging_type = (
+                self.adjoint._output.surface_average_properties.averaging_type = (
                     SpaceAveragingType.AREA.value
                 )
             elif averaging_type == AveragingType.MASS_FLOW:
-                self.adjoint.output.surface_average_properties.averaging_type = (
+                self.adjoint._output.surface_average_properties.averaging_type = (
                     SpaceAveragingType.MASS_FLOW.value
                 )
         elif QuantityType._is_force(quantity_type):
-            self.adjoint.output.force_properties.CopyFrom(
+            self.adjoint._output.force_properties.CopyFrom(
                 outputpb.ForceProperties(
                     force_dir_type=(
                         outputpb.FORCE_DIRECTION_BODY_ORIENTATION_AND_FLOW_DIR
@@ -332,9 +340,15 @@ from luminarycloud import outputs, SimulationParam, EntityIdentifier
 
 
 """
-        return code + self._to_code_helper("obj", hide_defaults, use_tmp_objs).replace(
-            "luminarycloud.simulation_param.SimulationParam()", "SimulationParam()", 1
+        code += self._to_code_helper("obj", hide_defaults, use_tmp_objs).replace(
+            "luminarycloud.simulation_param.SimulationParam()", "luminarycloud.SimulationParam()", 1
         )
+        if self.adjoint.primal_simulation_id != "":
+            code += """
+# TODO(USER): Select appropriate parameters to configure the adjoint output.
+obj.configure_adjoint_output("...")
+"""
+        return code
 
     def find_parameter(self, parameter: str) -> None:
         """

luminarycloud/simulation_template.py

@@ -119,14 +119,6 @@ class SimulationTemplate(ProtoWrapperBase):
                 param_proto.CopyFrom(parameters)
             else:
                 param_proto = simulation_params_from_json_path(parameters)
-
-            if isinstance(parameters, (SimulationParam, clientpb.SimulationParam)):
-                # Table references are manipulated via the simulation template, hence we need to persist
-                # them when we update the parameters.
-                param_proto.table_references.clear()
-                for k, v in self._proto.parameters.table_references.items():
-                    param_proto.table_references[k].CopyFrom(v)
-
             req.parameters.CopyFrom(param_proto)
 
         if copy_from is not None:
@@ -482,7 +474,8 @@ class SimulationTemplate(ProtoWrapperBase):
         By default parameters with default values are omitted, this change be changed with
         hide_defaults=False.
         """
-        param_code = self.get_parameters().to_code(hide_defaults)
+        parameters = self.get_parameters()
+        param_code = parameters.to_code(hide_defaults)
         code, param_code = param_code.split("\n\n\n")
 
         # Modify the header note included by SimulationParam.to_code.
@@ -490,10 +483,21 @@ 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 += "# TODO(USER): Replace ... with project ID, or create a project.\n"
-        code += 'project = get_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"
 
+        if parameters._table_references:
+            code += "# Upload tabular data.\n"
+            code += (
+                "# TODO(USER): Provide the local file paths (they are not stored by Luminary).\n"
+            )
+            for name, table in sorted(parameters._table_references.items()):
+                table_type = TableType(table.table_type).__repr__().split(": ")[0][1:]
+                code += f'project.create_table({table_type}, "path/to/{table.uploaded_filename}", template)\n'
+            code += "# This shows the available tables:\n"
+            code += "# print(template.list_tables())\n\n"
+
         code += "# Define the simulation parameters.\n"
         code += param_code
         code += "\n# Update the simulation template with the parameters.\n"

luminarycloud/tables.py

@@ -8,6 +8,7 @@ import csv
 from typing import Union
 
 from .enum import TableType, QuantityType
+from ._helpers import CodeRepr
 from ._proto.table import table_pb2 as tablepb
 from ._proto.quantity import quantity_pb2 as quantitypb
 
@@ -121,11 +122,11 @@ def create_rectilinear_table(
             table.header.record_label[-1].name = label
         else:
             table.header.record_label[-1].quantity = QuantityType(label).value
-        table.record.append(tablepb.Record())
 
     types = data_types(table_type, len(header))
 
     for row in rows:
+        record = tablepb.Record()
         for i, val in enumerate(row):
             # Axis coordinates are always adfloats and cannot be missing.
             if i == 0 and has_axis(table_type):
@@ -133,36 +134,34 @@ def create_rectilinear_table(
                 table.axis[0].coordinate[-1].adfloat.value = float(val)
                 continue
 
-            j = i - has_axis(table_type)
             if val == "":
                 if allow_missing_entries(table_type):
-                    table.record[j].entry.append(
-                        tablepb.Record.Entry(empty=tablepb.Record.Entry.Empty())
-                    )
+                    record.entry.append(tablepb.Record.Entry(empty=tablepb.Record.Entry.Empty()))
                     pass
                 else:
                     raise ValueError(f"Entry {i} in row {row} is missing.")
                 continue
 
-            table.record[j].entry.append(tablepb.Record.Entry())
+            record.entry.append(tablepb.Record.Entry())
             try:
                 if types[i] == float:
-                    table.record[j].entry[-1].adfloat.value = float(val)
+                    record.entry[-1].adfloat.value = float(val)
                 else:
-                    table.record[j].entry[-1].string = val
+                    record.entry[-1].string = val
             except ValueError:
                 raise ValueError(f"Expected type {types[i]} for entry {i} in row {row}.")
+        table.record.append(record)
 
     return table
 
 
 @dataclass(kw_only=True)
-class RectilinearTable:
+class RectilinearTable(CodeRepr):
     """Represents an uploaded table."""
 
-    id: str
-    name: str
-    table_type: TableType
+    id: str = ""
+    name: str = ""
+    table_type: TableType = TableType.INVALID
 
 
 def _param_name_to_table_type(name: str) -> TableType:

luminarycloud/thirdparty/__init__.py

@@ -0,0 +1,12 @@
+# Copyright 2025 Luminary Cloud, Inc. All Rights Reserved.
+"""
+Third-party integration functionality for the Luminary SDK.
+
+This package provides modules for interacting with various third-party services.
+Each service has its own submodule with specific functionality.
+
+Available integrations:
+- onshape: Onshape CAD platform integration
+"""
+
+from . import onshape as onshape

luminarycloud/thirdparty/onshape.py

@@ -0,0 +1,170 @@
+# Copyright 2025 Luminary Cloud, Inc. All Rights Reserved.
+"""
+Onshape integration functionality for the Luminary SDK.
+
+This module provides functions for interacting with Onshape CAD platform,
+allowing users to check authentication status and fetch variables using
+native Python types. This is in addition to our more integrated uses of
+Onshape within the SDK, such as allowing Onshape URLs in create_geometry.
+"""
+
+from typing import NamedTuple
+from dataclasses import dataclass
+import re
+
+from .._client import get_default_client
+from .._proto.api.v0.luminarycloud.thirdpartyintegration.onshape import onshape_pb2 as onshapepb
+
+
+@dataclass
+class OnshapeVariable:
+    """
+    Represents a variable from Onshape according to its variable studio definition.
+
+    Attributes
+    ----------
+    type : str
+        The type of the variable (e.g., "LENGTH", "ANGLE", "NUMBER", "ANY")
+    name : str
+        The name of the variable
+    description : str
+        A description of the variable
+    value : str
+        The current value of the variable as a string
+    expression : str
+        The expression defining the variable
+    """
+
+    type: str
+    name: str
+    description: str
+    value: str
+    expression: str
+
+
+class AuthenticationStatus(NamedTuple):
+    """
+    Authentication status for Onshape.
+
+    Attributes
+    ----------
+    is_authenticated : bool
+        Whether the use has active authentication with Onshape.
+    """
+
+    is_authenticated: bool
+
+
+def _parse_onshape_url(url: str) -> onshapepb.OnshapePath:
+    """
+    Parse an Onshape URL to extract the necessary components and return an OnshapePath.
+
+    Parameters
+    ----------
+    url : str
+        The Onshape URL to parse
+
+    Returns
+    -------
+    OnshapePath
+        A protobuf OnshapePath object with all fields populated
+
+    Raises
+    ------
+    ValueError
+        If the URL format is invalid or cannot be parsed
+    """
+
+    # Expected format: https://{company_prefix}.onshape.com/documents/{document_id}/{w_or_v}/{wv_id}/e/{element_id}
+    url_pattern = (
+        r"https://([^.\s]+)\.onshape\.com/documents/([^/\s]+)/([wv])/([^/\s]+)/e/([^/\s?#]+)$"
+    )
+    match = re.match(url_pattern, url)
+
+    if not match:
+        raise ValueError(f"Invalid Onshape URL format: {url}")
+
+    company_prefix, document_id, w_or_v, wv_id, element_id = match.groups()
+
+    return onshapepb.OnshapePath(
+        company_prefix=company_prefix,
+        document_id=document_id,
+        w_or_v=w_or_v,
+        wv_id=wv_id,
+        element_id=element_id,
+    )
+
+
+def get_authentication_status() -> AuthenticationStatus:
+    """
+    Check whether the current user has valid authentication with Onshape.
+
+    Returns
+    -------
+    AuthenticationStatus
+        The authentication status containing whether the user is authenticated
+
+    Examples
+    --------
+    >>> import luminarycloud.thirdparty.onshape as onshape
+    >>> status = onshape.get_authentication_status()
+    >>> if status.is_authenticated:
+    ...     print("User is authenticated with Onshape")
+    ... else:
+    ...     print("User needs to authenticate with Onshape")
+    """
+    req = onshapepb.GetAuthenticationStatusRequest()
+    res = get_default_client().GetAuthenticationStatus(req)
+    return AuthenticationStatus(is_authenticated=res.auth_active)
+
+
+def fetch_variables(onshape_url: str) -> list[OnshapeVariable]:
+    """
+    Fetch variables from an Onshape document using an Onshape URL.
+
+    Parameters
+    ----------
+    onshape_url : str
+        The Onshape URL pointing to the document element.
+        Expected format: https://{company}.onshape.com/documents/{doc_id}/{w_or_v}/{workspace_or_version_id}/e/{element_id}
+
+    Returns
+    -------
+    list[OnshapeVariable]
+        A list of variables available in the specified Onshape element
+
+    Raises
+    ------
+    ValueError
+        If the URL format is invalid or cannot be parsed
+
+    Examples
+    --------
+    >>> import luminarycloud.thirdparty.onshape as onshape
+    >>> # Fetch variables from a workspace URL
+    >>> fake_url = "https://cad.onshape.com/documents/abc123/w/def456/e/ghi789"
+    >>> variables = onshape.fetch_variables(fake_url)
+    >>> for var in variables:
+    ...     print(f"{var.name}: {var.value} ({var.type})")
+
+    >>> # Fetch variables from a version URL
+    >>> fake_url = "https://cad.onshape.com/documents/abc123/v/xyz999/e/ghi789"
+    >>> variables = onshape.fetch_variables(fake_url)
+    """
+
+    path = _parse_onshape_url(onshape_url)
+    req = onshapepb.FetchVariablesRequest(path=path)
+    res = get_default_client().FetchVariables(req)
+    variables = []
+    for proto_var in res.variables:
+        variables.append(
+            OnshapeVariable(
+                type=proto_var.type,
+                name=proto_var.name,
+                value=proto_var.value,
+                expression=proto_var.expression,
+                description=proto_var.description,
+            )
+        )
+
+    return variables

luminarycloud/vis/__init__.py

@@ -20,6 +20,7 @@ from .filters import (
     FixedSizeVectorGlyphs as FixedSizeVectorGlyphs,
     ScaledVectorGlyphs as ScaledVectorGlyphs,
     RakeStreamlines as RakeStreamlines,
+    GridStreamlines as GridStreamlines,
     SurfaceStreamlines as SurfaceStreamlines,
     SurfaceLIC as SurfaceLIC,
     Threshold as Threshold,
@@ -30,6 +31,7 @@ from .data_extraction import (
     IntersectionCurve as IntersectionCurve,
     DataExtractor as DataExtractor,
     ExtractOutput as ExtractOutput,
+    LineSample as LineSample,
     list_data_extracts as list_data_extracts,
 )
 

luminarycloud/vis/data_extraction.py

@@ -8,7 +8,7 @@ from typing import List, Tuple, cast, Union
 from abc import ABC, abstractmethod
 from .._proto.api.v0.luminarycloud.vis import vis_pb2
 from .primitives import Plane
-from ..types.vector3 import _to_vector3
+from ..types.vector3 import _to_vector3, Vector3Like, Vector3
 from .._client import get_default_client
 import logging
 from ..solution import Solution
@@ -122,6 +122,45 @@ class IntersectionCurve(DataExtract):
         return vis_filter
 
 
+class LineSample(DataExtract):
+    """
+
+    Generate line data by computing intersections between volumetric data and a line.
+
+    Extracts a 1D curve where the line intersects cell faces with solution field
+    values at intersection points.
+
+    .. warning:: This feature is experimental and may change or be removed in the future.
+
+    Attributes:
+    -----------
+    start: Vector3Like
+        The start of the line segment. Defaults to (0, 0, 0).
+    end: Vector3Like
+        The end of the line segment. Defaults to (1, 0, 0).
+    label: str
+        A user provided label for the line sample.
+    name : str
+        A user provided name for the filter.
+    """
+
+    def __init__(self, name: str) -> None:
+        super().__init__(generate_id("line-sample"))
+        self.name = name
+        self.start: Vector3Like = Vector3(x=0, y=0, z=0)
+        self.end: Vector3Like = Vector3(x=1, y=0, z=0)
+        self.label: str = ""
+
+    def _to_proto(self) -> vis_pb2.Filter:
+        vis_filter = vis_pb2.Filter()
+        vis_filter.id = self.id
+        vis_filter.name = self.name
+        vis_filter.line_sample.label = self.label
+        vis_filter.line_sample.start.CopyFrom(_to_vector3(self.start)._to_proto())
+        vis_filter.line_sample.end.CopyFrom(_to_vector3(self.end)._to_proto())
+        return vis_filter
+
+
 class ExtractOutput:
     """
     The extract output represents the request to extract data from a solution,
@@ -381,12 +420,11 @@ class DataExtractor:
         simulation = get_simulation(self._solution.simulation_id)
         mesh_meta = get_mesh_metadata(simulation.mesh_id)
         mesh = get_mesh(simulation.mesh_id)
-        try:
-            geom = mesh.geometry_version().geometry()
-        except NotFoundError:
+        geo_ver = mesh.geometry_version()
+        if geo_ver is None:
             self._has_tags = False
-        except Exception as e:
-            raise ValueError("An unknow error occurred retrieving tags")
+        else:
+            geom = geo_ver.geometry()
 
         self._surface_ids: List[str] = []
         for zone in mesh_meta.zones:

luminarycloud/vis/display.py

@@ -4,10 +4,11 @@ from luminarycloud.enum import Representation, ColorMapPreset, FieldComponent, V
 from .._proto.api.v0.luminarycloud.vis import vis_pb2
 from typing import Optional
 import luminarycloud.enum.quantity_type as quantity_type
+from .._helpers._code_representation import CodeRepr
 
 
 @dc.dataclass
-class Field:
+class Field(CodeRepr):
     """
     The field controls the field displayed on the object. If the field doesn't
     exist, we show a solid color.
@@ -16,8 +17,8 @@ class Field:
 
     """
 
-    quantity: VisQuantity = VisQuantity.ABSOLUTE_PRESSURE
-    """The quantity to color by."""
+    quantity: VisQuantity = VisQuantity.NONE
+    """The quantity to color by. Default: NONE."""
     component: FieldComponent = FieldComponent.MAGNITUDE
     """
     The component of the field to use, applicable to vector fields. If the field is a
@@ -45,9 +46,25 @@ class Field:
                 self.component = FieldComponent(field.component)
         # If its a scalar, just ignore the component.
 
+    def _to_code(self, hide_defaults: bool = True, use_tmp_objs: bool = True) -> str:
+        # We have to handle this case specially because we need to omit the field
+        # component if the quantity is a scalar. Otherwise, it could confuse the user.
+        # Also we omit the instantiation line because all classes that use a Field already
+        # instantiate a default one in their own constructor. (Hopefully that invariant continues to
+        # hold)
+        def enum_to_string(val: VisQuantity | FieldComponent) -> str:
+            str_val = val.__repr__()
+            return str_val.split(": ")[0][1:]
+
+        code = ""
+        code += f".quantity = {enum_to_string(self.quantity)}\n"
+        if quantity_type._is_vector(self.quantity):
+            code += f".component = {enum_to_string(self.component)}\n"
+        return code
+
 
 @dc.dataclass
-class DisplayAttributes:
+class DisplayAttributes(CodeRepr):
     """
     Display attributes specify how objects such as meshes, geometries, and
     filters appear in the scene.
@@ -86,7 +103,7 @@ class DisplayAttributes:
 
 
 @dc.dataclass
-class DataRange:
+class DataRange(CodeRepr):
     """
     The data range represents a range of values. Ranges are only valid if the
     max value is greater than the or equal to the min_value. The default is
@@ -106,7 +123,7 @@ class DataRange:
 
 
 @dc.dataclass
-class ColorMapAppearance:
+class ColorMapAppearance(CodeRepr):
     """
     ColorMapAppearance controls how the color maps appear in the image, including
     visibility, position and size.
@@ -141,7 +158,7 @@ class ColorMapAppearance:
 
 
 @dc.dataclass
-class ColorMap:
+class ColorMap(CodeRepr):
     """
     The color map allows user control over how field values are mapped to
     colors. Color maps are assigned to fields (e.g., the quantity and component)
@@ -213,10 +230,8 @@ class ColorMap:
         return res
 
     def _from_proto(self, color_map: vis_pb2.ColorMap) -> None:
-        self.field = Field(
-            component=FieldComponent(color_map.field.component),
-            quantity=VisQuantity(color_map.field.quantity_typ),
-        )
+        self.field._from_proto(color_map.field)
+
         if color_map.HasField("range"):
             self.data_range = DataRange(
                 min_value=color_map.range.min,