luminarycloud 0.16.0__py3-none-any.whl → 0.16.2__py3-none-any.whl

luminarycloud/simulation_template.py

@@ -8,7 +8,7 @@ from difflib import Differ
 from .enum import (
     TableType,
 )
-from ._helpers.warnings import experimental, deprecated
+from ._helpers.warnings import deprecated
 from ._client import get_default_client
 from ._helpers._simulation_params_from_json import simulation_params_from_json_path
 from ._helpers._timestamp_to_datetime import timestamp_to_datetime
@@ -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:
@@ -438,7 +430,6 @@ class SimulationTemplate(ProtoWrapperBase):
         """
         return delete_stopping_condition(self.id, id)
 
-    @experimental
     def get_general_stopping_conditions(self) -> GeneralStoppingConditions:
         """
         Get the general stopping conditions for this simulation template.
@@ -447,7 +438,6 @@ class SimulationTemplate(ProtoWrapperBase):
         """
         return get_general_stopping_conditions(self.id)
 
-    @experimental
     def update_general_stopping_conditions(
         self,
         max_iterations: int | None = None,
@@ -482,7 +472,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 +481,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/solution.py

@@ -6,7 +6,6 @@ from os import PathLike
 import luminarycloud as lc
 
 from ._client import get_default_client
-from ._helpers.warnings import experimental
 from ._helpers.download import (
     download_surface_solution,
     download_volume_solution,
@@ -146,14 +145,13 @@ class Solution(ProtoWrapperBase):
         stream = download_surface_sensitivity_data(get_default_client(), self.id)
         _handle_surface_data_stream(stream, dst)
 
-    @experimental
     def download_parameter_sensitivity_data(self, dst: Optional[PathLike] = None) -> None:
         """
         Download the parameter sensitivity data associated with an adjoint solution into the
         destination file or into a default-named file. The data consists of parameter names and
         sensitivity values (d "adjoint output" / d "SimulationParam parameter").
 
-        NOTE: This is a very experimental feature, likely to change in the future in favor of
+        .. warning:: This is a very experimental feature, likely to change in the future in favor of
         including the sensitivities in a SimulationParam object directly.
         """
         stream = download_parameter_sensitivity_data(get_default_client(), self.id)

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
 
@@ -155,12 +156,12 @@ def create_rectilinear_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,

luminarycloud/vis/filters.py

@@ -631,7 +631,7 @@ class RakeStreamlines(Streamlines):
     max_length: float
         The maximum path length of the particle in meters. Default: 10
     quantity: VisQuantity
-        The vector field to used for the particle advection. Default: Velocity
+        The vector field to use for the particle advection. Default: Velocity
     start: Vector3Like
         The start point of the rake. Default: [0,0,0].
     end: Vector3Like
@@ -687,6 +687,130 @@ class RakeStreamlines(Streamlines):
         self.quantity = VisQuantity(filter.streamlines.field.quantity_typ)
 
 
+class GridStreamlines(Streamlines):
+    """
+    Streamlines is a vector field visualization technique that integrates
+    massless particles through a vector field forming curves. Streamlines are
+    used to visualize and analyze fluid flow patterns (e.g., the velocity
+    field), helping to understand how the fluid moves. Streamlines
+    can be use used to visualize any vector field contained in the solution.
+
+    GridStreamlines generates seed particles arranged in a 2D grid pattern
+    inside the volume. GridStreamlines only work with volume data.
+
+    The grid is defined by a center point and two vectors that define the u
+    (rake_direction) and v (seed_direction) directions of the grid. It's
+    recommended that the rake_direction and seed_direction vectors are
+    orthogonal to each other, but it's not required. Rakes (sets of seed
+    particles) are generated in the rake_direction. Seed particles are
+    distributed along the seed_direction. The rake spacing controls the distance
+    between the rakes, and the seed spacing controls the distance between the
+    seed particles along the rake.
+
+    For example, if the rake vector is [1,0,0] and the seed vector is [0,1,0],
+    then the rakes will be generated in the x direction and the seed particles
+    will be generated in the y direction. Lets say we want to create a grid of
+    of 4x4 particles that is 8 meters wide and 2 meters tall. The rake spacing
+    would be 2 meters / 4 = 0.5 meters, and the seed spacing would be 8 meters /
+    4 = 2 meters.
+
+    .. warning:: This feature is experimental and may change or be removed in the future.
+
+    Attributes:
+    -----------
+    max_length: float
+        The maximum path length of the particle in meters. Default: 10
+    quantity: VisQuantity
+        The vector field to use for the particle advection. Default: Velocity
+    rake_direction: Vector3Like
+        The vector defining the u direction of the grid along which the rakes are placed.
+        Default: [1,0,0].
+    seed_direction: Vector3Like
+        The vector defining the v direction of the grid along which the seed particles are placed.
+        Default: [0,1,0].
+    center: Vector3Like
+        The center point of the grid. Default: [0,0,0].
+    rake_res: int
+        The number of rake lines to generate in the u direction. Default: 2.
+    seed_res: int
+        The number of seed particles to generate in the v direction. Default: 10.
+    rake_spacing: float
+        The spacing between the rake lines in meters. Default: 0.5.
+    seed_spacing: float
+        The spacing between the seed particles in meters. Default: 0.1.
+    name : str
+        A user provided name for the filter.
+    display_attrs : DisplayAttributes
+        Specifies this filter's appearance.
+    """
+
+    def __init__(self, name: str = "") -> None:
+        super().__init__(name)
+        self.rake_direction: Vector3Like = Vector3(x=1, y=0, z=0)
+        self.seed_direction: Vector3Like = Vector3(x=0, y=1, z=0)
+        self.center: Vector3Like = Vector3(x=0, y=0, z=0)
+        self.rake_res: int = 2
+        self.seed_res: int = 10
+        self.rake_spacing: float = 0.5
+        self.seed_spacing: float = 0.1
+
+    def _to_proto(self) -> vis_pb2.Filter:
+        # Type checking
+        if not isinstance(self.max_length, (float, int)):
+            raise TypeError(f"Expected 'float or int', got {type(self.max_length).__name__}")
+        if not isinstance(self.quantity, VisQuantity):
+            raise TypeError(f"Expected 'VisQuantity', got {type(self.quantity).__name__}")
+        if not isinstance(self.rake_res, int):
+            raise TypeError(f"Expected 'int', got {type(self.rake_res).__name__}")
+        if not isinstance(self.seed_res, int):
+            raise TypeError(f"Expected 'int', got {type(self.seed_res).__name__}")
+        if not isinstance(self.rake_spacing, (float, int)):
+            raise TypeError(f"Expected 'float or int', got {type(self.rake_spacing).__name__}")
+        if not isinstance(self.seed_spacing, (float, int)):
+            raise TypeError(f"Expected 'float or int', got {type(self.seed_spacing).__name__}")
+
+        vis_filter = vis_pb2.Filter()
+        vis_filter.id = self.id
+        vis_filter.name = self.name
+        vis_filter.streamlines.max_length = self.max_length
+        vis_filter.streamlines.grid.center.CopyFrom(_to_vector3(self.center)._to_proto())
+        vis_filter.streamlines.grid.u_vec.CopyFrom(_to_vector3(self.rake_direction)._to_proto())
+        vis_filter.streamlines.grid.v_vec.CopyFrom(_to_vector3(self.seed_direction)._to_proto())
+        vis_filter.streamlines.grid.rake_res = self.rake_res
+        vis_filter.streamlines.grid.seed_res = self.seed_res
+        vis_filter.streamlines.grid.rake_spacing = self.rake_spacing
+        vis_filter.streamlines.grid.seed_spacing = self.seed_spacing
+
+        if not quantity_type._is_vector(self.quantity):
+            raise ValueError("GridStreamlines: field must be a vector type")
+        vis_filter.streamlines.field.quantity_typ = self.quantity.value
+        return vis_filter
+
+    def _from_proto(self, filter: vis_pb2.Filter) -> None:
+        typ = filter.WhichOneof("value")
+        if typ != "streamlines":
+            raise TypeError(f"Expected 'streamlines', got {typ}")
+        s_typ = filter.streamlines.WhichOneof("seed_type")
+        if s_typ != "grid":
+            raise TypeError(f"Expected 'grid streamlines', got {s_typ}")
+        self.id = filter.id
+        self.name = filter.name
+        self.n_streamlines = filter.streamlines.n_streamlines
+        self.max_length = filter.streamlines.max_length
+
+        self.center = Vector3()
+        self.center._from_proto(filter.streamlines.grid.center)
+        self.rake_direction = Vector3()
+        self.rake_direction._from_proto(filter.streamlines.grid.u_vec)
+        self.seed_direction = Vector3()
+        self.seed_direction._from_proto(filter.streamlines.grid.v_vec)
+        self.rake_res = filter.streamlines.grid.rake_res
+        self.seed_res = filter.streamlines.grid.seed_res
+        self.rake_spacing = filter.streamlines.grid.rake_spacing
+        self.seed_spacing = filter.streamlines.grid.seed_spacing
+        self.quantity = VisQuantity(filter.streamlines.field.quantity_typ)
+
+
 class SurfaceStreamlines(Streamlines):
     """
     Streamlines is a vector field visualization technique that integrates
@@ -732,7 +856,7 @@ class SurfaceStreamlines(Streamlines):
     max_length: float
         The maximum path length of the particle in meters. Default: 10
     quantity: VisQuantity
-        The vector field to used for the particle advection. Default: Velocity
+        The vector field to use for the particle advection. Default: Velocity
     name : str
         A user provided name for the filter.
     display_attrs : DisplayAttributes
@@ -963,6 +1087,8 @@ def _filter_to_obj_name(filter: Filter) -> str:
         return "threshold"
     elif isinstance(filter, RakeStreamlines):
         return "rake_streamlines"
+    elif isinstance(filter, GridStreamlines):
+        return "grid_streamlines"
     elif isinstance(filter, SurfaceStreamlines):
         return "surface_streamlines"
     elif isinstance(filter, SurfaceLIC):

luminarycloud/vis/visualization.py

@@ -507,7 +507,7 @@ class Scene(CodeRepr):
         display attributes using tags, then surface ids.
         """
         if not surface_id in self._surface_ids:
-            raise ValueError(f"Id {id} not a boundary id")
+            raise ValueError(f"Id {surface_id} not a boundary id")
         self._surface_visibilities[surface_id] = visible
 
         if self._interactive_scene:

luminarycloud/volume_selection.py

@@ -157,8 +157,8 @@ class VolumeSelection:
         cad_url = finish_res.url
 
         feature = gpb.Feature(feature_name=feature_name)
-        getattr(feature, "import").CopyFrom(
-            gpb.Import(
+        feature.import_geometry.CopyFrom(
+            gpb.ImportGeometry(
                 geometry_url=cad_url,
                 scaling=scaling,
                 force_discrete=force_discrete,

{luminarycloud-0.16.0.dist-info → luminarycloud-0.16.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: luminarycloud
-Version: 0.16.0
+Version: 0.16.2
 Summary: Luminary Cloud SDK
 Project-URL: Homepage, https://www.luminarycloud.com/
 Project-URL: Documentation, https://app.luminarycloud.com/docs/api/
@@ -13,13 +13,13 @@ 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: opentelemetry-api~=1.25.0
-Requires-Dist: opentelemetry-exporter-otlp-proto-common~=1.25.0
-Requires-Dist: opentelemetry-exporter-otlp-proto-http~=1.25.0
+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-proto~=1.25.0
-Requires-Dist: opentelemetry-sdk~=1.25.0
+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