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

luminarycloud/pipelines/api.py

@@ -0,0 +1,213 @@
+# Copyright 2023-2024 Luminary Cloud, Inc. All Rights Reserved.
+from dataclasses import dataclass
+
+from datetime import datetime
+
+from luminarycloud._helpers import timestamp_to_datetime
+
+from ..enum.pipeline_job_status import PipelineJobStatus
+from ..pipelines import Pipeline, PipelineArgs
+from .._client import get_default_client
+from .._proto.api.v0.luminarycloud.pipelines import pipelines_pb2 as pipelinespb
+
+
+@dataclass
+class PipelineRecord:
+    id: str
+    name: str
+    description: str | None
+    definition_yaml: str
+    create_time: datetime
+    update_time: datetime
+
+    def pipeline(self) -> Pipeline:
+        return Pipeline._from_yaml(self.definition_yaml)
+
+    @classmethod
+    def from_proto(cls, proto: pipelinespb.Pipeline) -> "PipelineRecord":
+        return cls(
+            id=proto.id,
+            name=proto.name,
+            description=proto.description,
+            definition_yaml=proto.definition_yaml,
+            create_time=timestamp_to_datetime(proto.created_at),
+            update_time=timestamp_to_datetime(proto.updated_at),
+        )
+
+
+@dataclass
+class PipelineJobRecord:
+    id: str
+    pipeline_id: str
+    project_id: str
+    name: str
+    description: str | None
+    status: PipelineJobStatus
+    create_time: datetime
+    update_time: datetime
+    started_at: datetime | None
+    completed_at: datetime | None
+
+    @classmethod
+    def from_proto(cls, proto: pipelinespb.PipelineJob) -> "PipelineJobRecord":
+        return cls(
+            id=proto.id,
+            pipeline_id=proto.pipeline_id,
+            project_id=proto.project_id,
+            name=proto.name,
+            description=proto.description,
+            status=PipelineJobStatus(proto.status),
+            create_time=timestamp_to_datetime(proto.created_at),
+            update_time=timestamp_to_datetime(proto.updated_at),
+            started_at=(
+                timestamp_to_datetime(proto.started_at) if proto.HasField("started_at") else None
+            ),
+            completed_at=(
+                timestamp_to_datetime(proto.completed_at)
+                if proto.HasField("completed_at")
+                else None
+            ),
+        )
+
+
+def create_pipeline(
+    name: str, pipeline: Pipeline | str, description: str | None = None
+) -> PipelineRecord:
+    """
+    Create a new pipeline.
+
+    Parameters
+    ----------
+    name : str
+        Name of the pipeline.
+    pipeline : Pipeline | str
+        The pipeline to create. Accepts a Pipeline object or a YAML-formatted pipeline definition.
+    description : str, optional
+        Description of the pipeline.
+    """
+    if isinstance(pipeline, Pipeline):
+        definition_yaml = pipeline.to_yaml()
+    else:
+        definition_yaml = pipeline
+    req = pipelinespb.CreatePipelineRequest(
+        name=name, definition_yaml=definition_yaml, description=description
+    )
+    res: pipelinespb.CreatePipelineResponse = get_default_client().CreatePipeline(req)
+    return PipelineRecord.from_proto(res.pipeline)
+
+
+def list_pipelines() -> list[PipelineRecord]:
+    """
+    List all pipelines.
+    """
+    req = pipelinespb.ListPipelinesRequest()
+    res: pipelinespb.ListPipelinesResponse = get_default_client().ListPipelines(req)
+    return [PipelineRecord.from_proto(p) for p in res.pipelines]
+
+
+def get_pipeline(id: str) -> PipelineRecord:
+    """
+    Get a pipeline by ID.
+
+    Parameters
+    ----------
+    id : str
+        ID of the pipeline to fetch.
+    """
+    req = pipelinespb.GetPipelineRequest(id=id)
+    res: pipelinespb.GetPipelineResponse = get_default_client().GetPipeline(req)
+    return PipelineRecord.from_proto(res.pipeline)
+
+
+def create_pipeline_job(
+    pipeline_id: str, args: PipelineArgs, project_id: str, name: str, description: str | None = None
+) -> PipelineJobRecord:
+    """
+    Create a new pipeline job.
+
+    Parameters
+    ----------
+    pipeline_id : str
+        ID of the pipeline to invoke.
+    args : PipelineArgs
+        Arguments to pass to the pipeline.
+    project_id : str
+        ID of the project to run the pipeline job in.
+    name : str
+        Name of the pipeline job.
+    description : str, optional
+        Description of the pipeline job.
+    """
+
+    col_values = [[] for _ in args.params]
+    for row in args.rows:
+        for i, v in enumerate(row.row_values):
+            col_values[i].append(v)
+
+    cols = []
+
+    for i, param in enumerate(args.params):
+        if param._represented_type() == str:
+            cols.append(
+                pipelinespb.PipelineJobArgsColumn(
+                    string_column=pipelinespb.PipelineJobArgsColumn.StringColumn(
+                        name=param.name,
+                        values=col_values[i],
+                    )
+                )
+            )
+        elif param._represented_type() == int:
+            cols.append(
+                pipelinespb.PipelineJobArgsColumn(
+                    int_column=pipelinespb.PipelineJobArgsColumn.IntColumn(
+                        name=param.name,
+                        values=col_values[i],
+                    )
+                )
+            )
+        elif param._represented_type() == float:
+            cols.append(
+                pipelinespb.PipelineJobArgsColumn(
+                    double_column=pipelinespb.PipelineJobArgsColumn.DoubleColumn(
+                        name=param.name,
+                        values=col_values[i],
+                    )
+                )
+            )
+        elif param._represented_type() == bool:
+            cols.append(
+                pipelinespb.PipelineJobArgsColumn(
+                    bool_column=pipelinespb.PipelineJobArgsColumn.BoolColumn(
+                        name=param.name,
+                        values=col_values[i],
+                    )
+                )
+            )
+
+    req = pipelinespb.CreatePipelineJobRequest(
+        pipeline_id=pipeline_id,
+        args_columns=cols,
+        name=name,
+        description=description,
+        project_id=project_id,
+    )
+    res: pipelinespb.CreatePipelineJobResponse = get_default_client().CreatePipelineJob(req)
+    return PipelineJobRecord.from_proto(res.pipeline_job)
+
+
+def get_pipeline_job(id: str) -> PipelineJobRecord:
+    """
+    Get a pipeline job by ID.
+    """
+    req = pipelinespb.GetPipelineJobRequest(id=id)
+    res: pipelinespb.GetPipelineJobResponse = get_default_client().GetPipelineJob(req)
+    return PipelineJobRecord.from_proto(res.pipeline_job)
+
+
+def list_pipeline_jobs() -> list[PipelineJobRecord]:
+    """
+    List all pipeline jobs.
+    """
+    req = pipelinespb.ListPipelineJobsRequest()
+    res: pipelinespb.ListPipelineJobsResponse = get_default_client().ListPipelineJobs(req)
+    return [PipelineJobRecord.from_proto(p) for p in res.pipeline_jobs]

luminarycloud/project.py

@@ -6,7 +6,7 @@ import re
 import uuid
 from datetime import datetime
 from os import PathLike, path
-from typing import TYPE_CHECKING, Any, Dict, Optional, Union
+from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union, Literal
 
 import concurrent
 
@@ -38,6 +38,9 @@ from ._proto.api.v0.luminarycloud.simulation import simulation_pb2 as simulation
 from ._proto.api.v0.luminarycloud.simulation_template import (
     simulation_template_pb2 as simtemplatepb,
 )
+from ._proto.api.v0.luminarycloud.project_ui_state import (
+    project_ui_state_pb2 as projectuistatepb,
+)
 from ._proto.client import simulation_pb2 as clientpb
 from ._proto.table import table_pb2 as tablepb
 from ._proto.hexmesh import hexmesh_pb2 as hexmeshpb
@@ -118,23 +121,22 @@ class Project(ProtoWrapperBase):
 
     def create_geometry(
         self,
-        cad_file_path: PathLike | str,
+        cad_file_path: PathLike | str | List[PathLike | str],
         *,
         name: Optional[str] = None,
         scaling: Optional[float] = None,
         wait: bool = False,
-        convert_to_discrete: bool = False,
     ) -> "Geometry":
         """
-        Create a new geometry in the project by uploading a supported CAD file.
+        Create a new geometry in the project by uploading supported CAD file(s).
 
         For more information on supported formats and best practices, see:
         https://docs.luminarycloud.com/en/articles/9274255-upload-cad
 
         Parameters
         ----------
-        cad_file_path : PathLike or str
-            Path or URL to the CAD file to upload.
+        cad_file_path : PathLike | str | List[PathLike | str]
+            Path(s) or URL to the CAD file(s) to upload.
 
         Other Parameters
         ----------------
@@ -148,10 +150,6 @@ class Project(ProtoWrapperBase):
             If set to True, this function will block until the geometry import
             completes. Otherwise, it will return immediately and the import will
             occur in the background. Defaults to False.
-        convert_to_discrete : bool, optional
-            If set to True, the geometry will be converted to a discrete geometry.
-            This allows using the Shrinkwrap operation to create a watertight
-            geometry. Defaults to False.
 
         Returns
         -------
@@ -183,7 +181,6 @@ class Project(ProtoWrapperBase):
             name=name,
             scaling=scaling,
             wait=wait,
-            convert_to_discrete=convert_to_discrete,
         )
         return lc.Geometry(_geometry)
 
@@ -629,12 +626,102 @@ class Project(ProtoWrapperBase):
         return lc.NamedVariableSet(res.named_variable_set)
 
     def list_named_variable_sets(self) -> list[NamedVariableSet]:
+        """
+        .. warning:: This feature is experimental and may change or be removed without notice.
+        """
         req = namedvariablepb.ListNamedVariableSetsRequest(project_id=self.id)
         res: namedvariablepb.ListNamedVariableSetsResponse = (
             get_default_client().ListNamedVariableSets(req)
         )
         return [lc.NamedVariableSet(n) for n in res.named_variable_sets]
 
+    def set_active_named_variable_set(self, named_variable_set: NamedVariableSet) -> None:
+        """
+        This is a purely a construct for setting the active NamedVariableSet in the UI. It does not
+        affect any previous or future SDK behavior.
+
+        .. warning:: This feature is experimental and may change or be removed without notice.
+        """
+        req = projectuistatepb.SetActiveNamedVariableSetRequest(
+            project_id=self.id, named_variable_set_id=named_variable_set.id
+        )
+        get_default_client().SetActiveNamedVariableSet(req)
+
+    def get_active_named_variable_set(self) -> Optional[NamedVariableSet]:
+        """
+        This is a purely a construct for getting the active NamedVariableSet for a project in the UI.
+        It does not affect any previous or future SDK behavior.
+
+        .. warning:: This feature is experimental and may change or be removed without notice.
+        """
+        req = projectuistatepb.GetActiveNamedVariableSetRequest(project_id=self.id)
+        res: projectuistatepb.GetActiveNamedVariableSetResponse = (
+            get_default_client().GetActiveNamedVariableSet(req)
+        )
+        if not res.active_named_variable_set_id:
+            return None
+        return get_named_variable_set(NamedVariableSetID(res.active_named_variable_set_id))
+
+    def share(self, email: str, role: Literal["viewer", "editor"]) -> None:
+        """
+        Share the project with a user identified by their email address. This function also allows
+        changing the role of the user in the project if the project has already been shared with
+        the input user.
+
+        Parameters
+        ----------
+        email : str
+            Email address of the user to share the project with. It must be an email whose domain
+            is registered within the allowed domains settings of your company account.
+        role : Literal["viewer", "editor"]
+            The role to assign to the user in the project. Must be either "viewer" or "editor".
+        """
+        if not re.match(r"[^@]+@[^@]+\.[^@]+", email):
+            raise ValueError(f"Invalid email address: {email}")
+        if role not in ["viewer", "editor"]:
+            raise ValueError(f"Invalid role: {role}. Must be 'viewer' or 'editor'.")
+        roleModel = (
+            projectpb.ShareProjectRequest.USER_ROLE_VIEWER
+            if role == "viewer"
+            else projectpb.ShareProjectRequest.USER_ROLE_EDITOR
+        )
+        req = projectpb.ShareProjectRequest(id=self.id, email=email, role=roleModel)
+        get_default_client().ShareProject(req)
+
+    def unshare(self, email: str) -> None:
+        """
+        Unshare the project with a user identified by their email address.
+
+        Parameters
+        ----------
+        email : str
+            Email address of the user to unshare the project with. It must be an email whose domain
+            must be registered within the allowed domains settings of your company account.
+        """
+        if not re.match(r"[^@]+@[^@]+\.[^@]+", email):
+            raise ValueError(f"Invalid email address: {email}")
+        req = projectpb.UnshareProjectRequest(id=self.id, email=email)
+        get_default_client().UnshareProject(req)
+
+    def share_with_support(self, message: str = "") -> None:
+        """
+        Share the project with Luminary Cloud support.
+
+        Parameters
+        ----------
+        message : str, optional
+            Message to include with the support share request.
+        """
+        req = projectpb.ShareProjectWithSupportRequest(id=self.id, message=message)
+        get_default_client().ShareProjectWithSupport(req)
+
+    def unshare_with_support(self) -> None:
+        """
+        Unshare the project with Luminary Cloud support.
+        """
+        req = projectpb.UnshareProjectWithSupportRequest(id=self.id)
+        get_default_client().UnshareProjectWithSupport(req)
+
 
 def add_named_variables_from_csv(project: Project, csv_path: str) -> list[NamedVariableSet]:
     """

luminarycloud/simulation_template.py

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

luminarycloud/vis/__init__.py

@@ -11,6 +11,7 @@ from .visualization import (
 from .primitives import (
     Plane as Plane,
     Box as Box,
+    AABB as AABB,
 )
 
 from .filters import (
@@ -23,6 +24,7 @@ from .filters import (
     GridStreamlines as GridStreamlines,
     SurfaceStreamlines as SurfaceStreamlines,
     SurfaceLIC as SurfaceLIC,
+    SurfaceLICPlane as SurfaceLICPlane,
     Threshold as Threshold,
     Isosurface as Isosurface,
 )
@@ -46,3 +48,7 @@ from .display import (
 from .interactive_scene import (
     InteractiveScene as InteractiveScene,
 )
+
+from .interactive_inference import (
+    InteractiveInference as InteractiveInference,
+)