luminarycloud 0.13.1__py3-none-any.whl → 0.14.0__py3-none-any.whl

luminarycloud/params/{param_wrappers/simulation_param → simulation}/time/time_marching_.py

@@ -1,6 +1,6 @@
 # Generated by generate_sdk_wrappers.py. DO NOT EDIT
 
-from abc import ABCMeta
+from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
 from typing import Any, Optional
 from uuid import uuid4
@@ -15,7 +15,7 @@ from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.param_wrappers._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
 
 
 @dataclass(kw_only=True)

luminarycloud/params/{param_wrappers/simulation_param → simulation}/time/time_step_ramp/time_step_ramp_off_.py

@@ -1,6 +1,6 @@
 # Generated by generate_sdk_wrappers.py. DO NOT EDIT
 
-from abc import ABCMeta
+from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
 from typing import Any, Optional
 from uuid import uuid4
@@ -15,10 +15,10 @@ from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.param_wrappers._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
 
-from luminarycloud.params.param_wrappers.simulation_param.time.time_step_ramp_ import TimeStepRamp
-from luminarycloud.params.param_wrappers.simulation_param.time.time_step_ramp_ import *
+from luminarycloud.params.simulation.time.time_step_ramp_ import TimeStepRamp
+from luminarycloud.params.simulation.time.time_step_ramp_ import *
 
 
 @dataclass(kw_only=True)

luminarycloud/params/{param_wrappers/simulation_param → simulation}/time/time_step_ramp/time_step_ramp_on_.py

@@ -1,6 +1,6 @@
 # Generated by generate_sdk_wrappers.py. DO NOT EDIT
 
-from abc import ABCMeta
+from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
 from typing import Any, Optional
 from uuid import uuid4
@@ -15,10 +15,10 @@ from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.param_wrappers._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
 
-from luminarycloud.params.param_wrappers.simulation_param.time.time_step_ramp_ import TimeStepRamp
-from luminarycloud.params.param_wrappers.simulation_param.time.time_step_ramp_ import *
+from luminarycloud.params.simulation.time.time_step_ramp_ import TimeStepRamp
+from luminarycloud.params.simulation.time.time_step_ramp_ import *
 
 
 @dataclass(kw_only=True)

luminarycloud/params/{param_wrappers/simulation_param → simulation}/time/time_step_ramp_.py

@@ -1,6 +1,6 @@
 # Generated by generate_sdk_wrappers.py. DO NOT EDIT
 
-from abc import ABCMeta
+from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
 from typing import Any, Optional
 from uuid import uuid4
@@ -15,7 +15,7 @@ from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.param_wrappers._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
 
 
 @dataclass(kw_only=True)

luminarycloud/params/{param_wrappers/simulation_param → simulation}/time_.py

@@ -1,6 +1,6 @@
 # Generated by generate_sdk_wrappers.py. DO NOT EDIT
 
-from abc import ABCMeta
+from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
 from typing import Any, Optional
 from uuid import uuid4
@@ -15,40 +15,30 @@ from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.param_wrappers._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
 
-from luminarycloud.params.param_wrappers.simulation_param.time.compute_statistics_ import (
-    ComputeStatistics,
-)
-from luminarycloud.params.param_wrappers.simulation_param.time.compute_statistics_ import *
-from luminarycloud.params.param_wrappers.simulation_param.time.compute_statistics.compute_statistics_off_ import (
+from luminarycloud.params.simulation.time.compute_statistics_ import ComputeStatistics
+from luminarycloud.params.simulation.time.compute_statistics_ import *
+from luminarycloud.params.simulation.time.compute_statistics.compute_statistics_off_ import (
     ComputeStatisticsOff,
 )
-from luminarycloud.params.param_wrappers.simulation_param.time.compute_statistics.compute_statistics_off_ import *
-from luminarycloud.params.param_wrappers.simulation_param.time.compute_statistics.compute_statistics_on_ import (
+from luminarycloud.params.simulation.time.compute_statistics.compute_statistics_off_ import *
+from luminarycloud.params.simulation.time.compute_statistics.compute_statistics_on_ import (
     ComputeStatisticsOn,
 )
-from luminarycloud.params.param_wrappers.simulation_param.time.compute_statistics.compute_statistics_on_ import *
-from luminarycloud.params.param_wrappers.simulation_param.time.time_marching.time_explicit_ import (
-    TimeExplicit,
-)
-from luminarycloud.params.param_wrappers.simulation_param.time.time_marching.time_explicit_ import *
-from luminarycloud.params.param_wrappers.simulation_param.time.time_marching.time_implicit_ import (
-    TimeImplicit,
-)
-from luminarycloud.params.param_wrappers.simulation_param.time.time_marching.time_implicit_ import *
-from luminarycloud.params.param_wrappers.simulation_param.time.time_marching_ import TimeMarching
-from luminarycloud.params.param_wrappers.simulation_param.time.time_marching_ import *
-from luminarycloud.params.param_wrappers.simulation_param.time.time_step_ramp_ import TimeStepRamp
-from luminarycloud.params.param_wrappers.simulation_param.time.time_step_ramp_ import *
-from luminarycloud.params.param_wrappers.simulation_param.time.time_step_ramp.time_step_ramp_off_ import (
-    TimeStepRampOff,
-)
-from luminarycloud.params.param_wrappers.simulation_param.time.time_step_ramp.time_step_ramp_off_ import *
-from luminarycloud.params.param_wrappers.simulation_param.time.time_step_ramp.time_step_ramp_on_ import (
-    TimeStepRampOn,
-)
-from luminarycloud.params.param_wrappers.simulation_param.time.time_step_ramp.time_step_ramp_on_ import *
+from luminarycloud.params.simulation.time.compute_statistics.compute_statistics_on_ import *
+from luminarycloud.params.simulation.time.time_marching.time_explicit_ import TimeExplicit
+from luminarycloud.params.simulation.time.time_marching.time_explicit_ import *
+from luminarycloud.params.simulation.time.time_marching.time_implicit_ import TimeImplicit
+from luminarycloud.params.simulation.time.time_marching.time_implicit_ import *
+from luminarycloud.params.simulation.time.time_marching_ import TimeMarching
+from luminarycloud.params.simulation.time.time_marching_ import *
+from luminarycloud.params.simulation.time.time_step_ramp_ import TimeStepRamp
+from luminarycloud.params.simulation.time.time_step_ramp_ import *
+from luminarycloud.params.simulation.time.time_step_ramp.time_step_ramp_off_ import TimeStepRampOff
+from luminarycloud.params.simulation.time.time_step_ramp.time_step_ramp_off_ import *
+from luminarycloud.params.simulation.time.time_step_ramp.time_step_ramp_on_ import TimeStepRampOn
+from luminarycloud.params.simulation.time.time_step_ramp.time_step_ramp_on_ import *
 
 
 @dataclass(kw_only=True)

luminarycloud/params/{param_wrappers/simulation_param → simulation}/volume_entity_.py

@@ -1,6 +1,6 @@
 # Generated by generate_sdk_wrappers.py. DO NOT EDIT
 
-from abc import ABCMeta
+from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
 from typing import Any, Optional
 from uuid import uuid4
@@ -15,7 +15,7 @@ from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.param_wrappers._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
 
 
 @dataclass(kw_only=True)

luminarycloud/project.py

@@ -4,12 +4,14 @@ from __future__ import annotations
 import re
 from datetime import datetime
 from os import PathLike, path
-from typing import TYPE_CHECKING, Optional
+from typing import TYPE_CHECKING, Any, Dict, Optional, Union
+
+import concurrent
 
 import grpc
 
 import luminarycloud as lc
-from luminarycloud.params.param_wrappers.simulation_param.adjoint_ import Adjoint
+from luminarycloud.params.simulation.adjoint_ import Adjoint
 
 from ._client import get_default_client
 from ._helpers import (
@@ -337,22 +339,44 @@ class Project(ProtoWrapperBase):
                     return lc.Mesh(res.mesh)
             raise
 
-    def create_hex_mesh(self, file_path: PathLike | str, params: hexmeshpb.HexMeshSpec) -> "Mesh":
+    def create_hex_mesh(
+        self,
+        names_to_file_paths: Dict[str, Union[PathLike[Any], str]],
+        params: hexmeshpb.HexMeshSpec,
+    ) -> "Mesh":
         """
         Creates a hex mesh. Only for internal use.
         """
         client = get_default_client()
-        if not str(file_path).endswith(".stl"):
-            raise ValueError("File must be a .stl file")
 
-        file_meta = util.get_file_metadata(file_path)
-        finish_res = upload_file(
-            client,
-            self.id,
-            uploadpb.ResourceParams(geometry_params=uploadpb.GeometryParams()),
-            file_path,
-        )[1]
-        params.file_url = finish_res.url
+        def upload_single_file(name: str, file_path: Union[PathLike[Any], str]) -> tuple[str, str]:
+            if not str(file_path).endswith(".stl"):
+                raise ValueError(f"File {file_path} must be a .stl file")
+            finish_res = upload_file(
+                client,
+                self.id,
+                uploadpb.ResourceParams(geometry_params=uploadpb.GeometryParams()),
+                file_path,
+            )[1]
+            return name, finish_res.url
+
+        names_to_uploaded_file_paths = {}
+        with concurrent.futures.ThreadPoolExecutor() as executor:
+            future_to_name = {
+                executor.submit(upload_single_file, name, file_path): name
+                for name, file_path in names_to_file_paths.items()
+            }
+
+            for future in concurrent.futures.as_completed(future_to_name):
+                try:
+                    name, url = future.result()
+                    names_to_uploaded_file_paths[name] = url
+                except Exception as exc:
+                    name = future_to_name[future]
+                    raise RuntimeError(f"Upload failed for {name}: {exc}")
+
+        for name, url in names_to_uploaded_file_paths.items():
+            params.names_to_file_urls[name] = url
 
         req = meshpb.CreateHexMeshRequest(project_id=self.id, hex_mesh_config=params)
 
@@ -503,7 +527,8 @@ class Project(ProtoWrapperBase):
 
     def list_simulation_templates(self) -> "list[SimulationTemplate]":
         """
-        List all simulation templates in project.
+        List all simulation templates in project. The first one in the list is the "setup" template,
+        which is the one that is synced to the Setup tab in the UI.
         """
         req = simtemplatepb.ListSimulationTemplatesRequest(project_id=self.id)
         res = get_default_client().ListSimulationTemplates(req)
@@ -513,7 +538,7 @@ class Project(ProtoWrapperBase):
         self,
         name: str,
         *,
-        parameters: Optional[clientpb.SimulationParam] = None,
+        parameters: Optional[Union[clientpb.SimulationParam, SimulationParam]] = None,
         params_json_path: Optional[PathLike | str] = None,
     ) -> "SimulationTemplate":
         """
@@ -533,11 +558,17 @@ class Project(ProtoWrapperBase):
             Path to local JSON file containing simulation params.
         """
         if params_json_path is not None:
-            parameters = simulation_params_from_json_path(params_json_path)
-        elif parameters is None:
+            param_proto = simulation_params_from_json_path(params_json_path)
+        elif parameters is not None:
+            if isinstance(parameters, SimulationParam):
+                param_proto = parameters._to_proto()
+            else:
+                param_proto = clientpb.SimulationParam()
+                param_proto.CopyFrom(parameters)
+        else:
             raise Exception("Either parameters or params_json_path must be set")
         req = simtemplatepb.CreateSimulationTemplateRequest(
-            project_id=self.id, name=name, parameters=parameters
+            project_id=self.id, name=name, parameters=param_proto
         )
         res = get_default_client().CreateSimulationTemplate(req)
         return lc.SimulationTemplate(res.simulation_template)

luminarycloud/reference_values.py

@@ -5,7 +5,7 @@ from ._proto.base.base_pb2 import AdFloatType
 from ._proto.output import reference_values_pb2 as refvalpb
 from .enum import ReferenceValuesType
 
-from .params.param_wrappers._lib import CodeRepr
+from .params.simulation._lib import CodeRepr
 
 
 @dataclass(kw_only=True)

luminarycloud/simulation.py

@@ -10,6 +10,7 @@ from ._proto.api.v0.luminarycloud.common import common_pb2 as commonpb
 from ._proto.api.v0.luminarycloud.simulation import simulation_pb2 as simulationpb
 from ._proto.api.v0.luminarycloud.solution import solution_pb2 as solutionpb
 from ._proto.client import simulation_pb2 as clientpb
+from ._proto.quantity import quantity_options_pb2 as quantityoptspb
 from ._wrapper import ProtoWrapper, ProtoWrapperBase
 from .enum import (
     AveragingType,
@@ -19,6 +20,7 @@ from .enum import (
     SimulationStatus,
     Vector3Component,
 )
+from .simulation_param import SimulationParam
 from .reference_values import ReferenceValues
 from .solution import Solution
 from .types import MeshID, ProjectID, SimulationID, Vector3Like
@@ -178,7 +180,7 @@ class Simulation(ProtoWrapperBase):
         surface_ids: list[str],
         *,
         reference_values: ReferenceValues = None,
-        calculation_type: CalculationType = CalculationType.PER_SURFACE,
+        calculation_type: CalculationType = CalculationType.AGGREGATE,
         frame_id: str = "",
         force_direction: Optional[Vector3Like] = None,
         moment_center: Optional[Vector3Like] = None,
@@ -204,7 +206,7 @@ class Simulation(ProtoWrapperBase):
             reference values will be used.
         calculation_type : CalculationType, optional
             Whether the calculation should be done for all the surfaces together or each surface
-            individually. Default is PER_SURFACE.
+            individually. Default is AGGREGATE.
         frame_id: str, optional
             The ID of the reference frame that this output should be
             reported in for "force" quantity types.
@@ -242,6 +244,8 @@ class Simulation(ProtoWrapperBase):
         ...     with open(dl.filename, "w") as fp:
         ...         fp.write(dl.read())
         """
+        if quantity_type._has_tag(quantityoptspb.TAG_COEFFICIENT) and reference_values is None:
+            print("WARNING: Quantity is a coefficient but reference values were not specified.")
         req = simulationpb.GetSimulationSurfaceQuantityOutputRequest(
             id=self.id,
             quantity_type=quantity_type.value,
@@ -288,6 +292,13 @@ class Simulation(ProtoWrapperBase):
         req = simulationpb.GetSimulationParametersRequest(id=self.id)
         return get_default_client().GetSimulationParameters(req)
 
+    def get_simulation_param(self) -> SimulationParam:
+        """
+        Returns the simulation parameters associated with this template to allow customization of
+        the parameters.
+        """
+        return SimulationParam.from_proto(self.get_parameters())
+
 
 def get_simulation(id: SimulationID) -> Simulation:
     """

luminarycloud/simulation_param.py

@@ -17,24 +17,24 @@ from luminarycloud._proto.output import output_pb2 as outputpb
 from luminarycloud._proto.quantity import quantity_options_pb2 as quantityoptspb
 from luminarycloud.enum import AveragingType, QuantityType, SpaceAveragingType
 from luminarycloud.params.geometry import Volume
-from luminarycloud.params.param_wrappers.simulation_param import (
+from luminarycloud.params.simulation import (
     EntityRelationships,
 )
-from luminarycloud.params.param_wrappers.simulation_param.adjoint_ import Adjoint
-from luminarycloud.params.param_wrappers.simulation_param.entity_relationships.volume_material_relationship_ import (
+from luminarycloud.params.simulation.adjoint_ import Adjoint
+from luminarycloud.params.simulation.entity_relationships.volume_material_relationship_ import (
     VolumeMaterialRelationship,
 )
-from luminarycloud.params.param_wrappers.simulation_param.entity_relationships.volume_physics_relationship_ import (
+from luminarycloud.params.simulation.entity_relationships.volume_physics_relationship_ import (
     VolumePhysicsRelationship,
 )
-from luminarycloud.params.param_wrappers.simulation_param.material_entity_ import (
+from luminarycloud.params.simulation.material_entity_ import (
     MaterialEntity,
 )
-from luminarycloud.params.param_wrappers.simulation_param.physics_ import Physics
-from luminarycloud.params.param_wrappers.simulation_param.volume_entity_ import (
+from luminarycloud.params.simulation.physics_ import Physics
+from luminarycloud.params.simulation.volume_entity_ import (
     VolumeEntity,
 )
-from luminarycloud.params.param_wrappers.simulation_param_ import (
+from luminarycloud.params.simulation import (
     SimulationParam as _SimulationParam,
 )
 from luminarycloud.reference_values import ReferenceValues, ReferenceValuesType

luminarycloud/solution.py

@@ -79,12 +79,17 @@ class Solution(ProtoWrapperBase):
             mode="r|gz",
         )
 
-    def download_volume_data(self) -> tarfile.TarFile:
+    def download_volume_data(self, single_precision: bool = False) -> tarfile.TarFile:
         """
         Download volume solution for a completed steady simulation as a gzipped tarball containing .vtu & .vtp files.
 
         The output may be broken up into multiple .vtu files for large simulations.
 
+        Parameters
+        ----------
+        single_precision : bool
+            If True, outputs floating point fields in single precision. Defaults to False.
+
         Returns
         -------
         tarfile.Tarfile
@@ -108,6 +113,7 @@ class Solution(ProtoWrapperBase):
         stream = download_volume_solution(
             get_default_client(),
             self.id,
+            single_precision=single_precision,
         )
         return tarfile.open(
             name=stream.filename,

luminarycloud/types/vector3.py

@@ -1,6 +1,6 @@
 # Copyright 2023-2024 Luminary Cloud, Inc. All Rights Reserved.
 from dataclasses import dataclass
-from typing import TypeAlias
+from typing import TypeAlias, Iterator
 
 from .._proto.api.v0.luminarycloud.common import common_pb2 as commonpb
 from .._proto.base.base_pb2 import AdVector3, Vector3 as Vector3Proto
@@ -12,7 +12,23 @@ from .adfloat import (
 
 @dataclass
 class Vector3:
-    """Represents a 3-dimensional vector."""
+    """Represents a 3-dimensional vector.
+
+    Supports direct component access, indexing, iteration, and conversion to numpy arrays.
+
+    Examples:
+        >>> from luminarycloud.types import Vector3
+        >>> v = Vector3(1.0, 2.0, 3.0)
+        >>> v.x, v.y, v.z  # Direct component access
+        (1.0, 2.0, 3.0)
+        >>> v[0]  # Access by index
+        1.0
+        >>> list(v)  # Iterate over components
+        [1.0, 2.0, 3.0]
+        >>> import numpy as np
+        >>> np.array(v)  # Convert to numpy array
+        array([1., 2., 3.])
+    """
 
     x: float = 0.0
     y: float = 0.0
@@ -60,6 +76,16 @@ class Vector3:
         else:
             raise IndexError(f"Index {index} out of bounds for Vector3")
 
+    def __iter__(self) -> Iterator[float]:
+        """Enable iteration over the vector components."""
+        yield self.x
+        yield self.y
+        yield self.z
+
+    def __len__(self) -> int:
+        """Return the number of components in the vector."""
+        return 3
+
 
 Vector3Like: TypeAlias = Vector3 | list[float] | tuple[float, float, float]  # type: ignore
 

luminarycloud/vis/__init__.py

@@ -1,5 +1,5 @@
 from .visualization import (
-    RenderOutput as RenderOuptut,
+    RenderOutput as RenderOutput,
     Scene as Scene,
     ColorMapPreset as ColorMapPreset,
     EntityType as EntityType,
@@ -19,6 +19,7 @@ from .filters import (
     ScaledVectorGlyphs as ScaledVectorGlyphs,
     RakeStreamlines as RakeStreamlines,
     SurfaceStreamlines as SurfaceStreamlines,
+    SurfaceLIC as SurfaceLIC,
     Threshold as Threshold,
     Isosurface as Isosurface,
 )

luminarycloud/vis/display.py

@@ -11,19 +11,17 @@ class Field:
 
     .. warning:: This feature is experimental and may change or be removed in the future.
 
-    Attribues:
-    ----------
-    quantity : VisQuantity
-        The quantity to color by.
-    component : FieldComponent
-        The component of the field to use, applicable to vector fields. If the field is a
-        scalar, use the default X component.
     """
 
     quantity: VisQuantity = VisQuantity.ABSOLUTE_PRESSURE
+    """The quantity to color by."""
     component: FieldComponent = FieldComponent.X
+    """
+    The component of the field to use, applicable to vector fields. If the field is a
+    scalar, use the default X component.
+    """
 
-    def __hash__(self):
+    def __hash__(self) -> int:
         return hash((self.quantity, self.component))
 
 
@@ -35,25 +33,23 @@ class DisplayAttributes:
 
     .. warning:: This feature is experimental and may change or be removed in the future.
 
-    Attributes:
-    ----------
-    visible : bool
-        If the object is visible or not. Default: True
-    opacity : float
-        How opaque the object is. This is a normalized number between
-        0 (i.e., fully transparent) and 1 (i.e., fully opaque). Default: 1
-    field : Field
-        What field quantity/component to color by, if applicable.
-    representation : Representation
-        how the object is represented in the scene (e.g., surface, surface with
-        edges, wireframe or points). Default: surface.
     """
 
     visible: bool = True
+    """If the object is visible or not. Default: True"""
     # TODO(matt): opacity not hooked up yet.
     opacity: float = 1.0
+    """
+    How opaque the object is. This is a normalized number between
+    0 (i.e., fully transparent) and 1 (i.e., fully opaque). Default: 1
+    """
     field: Field = dc.field(default_factory=Field)
+    """What field quantity/component to color by, if applicable."""
     representation: Representation = Representation.SURFACE
+    """
+    how the object is represented in the scene (e.g., surface, surface with
+    edges, wireframe or points). Default: surface.
+    """
 
     def _to_proto(self) -> vis_pb2.DisplayAttributes:
         attrs = vis_pb2.DisplayAttributes()
@@ -73,16 +69,12 @@ class DataRange:
 
     .. warning:: This feature is experimental and may change or be removed in the future.
 
-    Attributes:
-    -----------
-    min_value : float
-        The minimum value of the range.
-    max_value : float
-        The maximum value of the range.
     """
 
     min_value: float = float("inf")
+    """The minimum value of the range."""
     max_value: float = float("-inf")
+    """The maximum value of the range."""
 
     def is_valid(self) -> bool:
         return self.max_value >= self.min_value
@@ -101,30 +93,26 @@ class ColorMapAppearance:
 
     .. warning:: This feature is experimental and may change or be removed in the future.
 
-    Attributes
-    ----------
-    visible: bool
-        Controls if the color map is displayed or not. Default: True
-    width: float
-        The width of the color map in normalized device coordinates. Default: 0.034
-    height: float
-        The height of the color map in normalized device coordinates. Default: 0.146
-    text_size: int
-        The text size for the color map legend in pixels. Default: 36
-    lower_left_x: float
-        The lower left x position of the color map in normalized device
-        coordinates. Default: 0.8
-    lower_left_y: float
-        The lower left y position of the color map in normalized device
-        coordinates. Default: 0.8
     """
 
     visible: bool = True
+    """Controls if the color map is displayed or not. Default: True"""
     width: float = 0.034
+    """The width of the color map in normalized device coordinates. Default: 0.034"""
     height: float = 0.146
+    """The height of the color map in normalized device coordinates. Default: 0.146"""
     text_size: int = 36
+    """The text size for the color map legend in pixels. Default: 36"""
     lower_left_x: float = 0.8
+    """
+    The lower left x position of the color map in normalized device
+    coordinates. Default: 0.8
+    """
     lower_left_y: float = 0.8
+    """
+    The lower left y position of the color map in normalized device
+    coordinates. Default: 0.8
+    """
 
 
 @dc.dataclass
@@ -140,39 +128,41 @@ class ColorMap:
 
     .. warning:: This feature is experimental and may change or be removed in the future.
 
-    Attributes
-    ----------
-    field : Field
-        The field and component this color map applies to.
-    preset : ColorMapPreset
-        The color map preset to use. This defines the colors used in the color
-        map. Default is 'JET'.
-    data_range : DataRange
-        An optional data range to use for the color map. The user must explicity
-        set the data ranges. If not set explicitly, the fields global data range
-        is used. For comparing multiple results, either with different solutions
-        in the same simulation or with different simulations, its highly
-        recommended that a range is provided so the color scales are the same
-        between the resulting images. Default: is an invalid data range.
-    discretize : bool
-        Use discrete color bins instead of a continuous range. When True,
-        'n_colors' indicates how many discrete bins to use. Default: False.
-    n_colors : int
-        How many discrete bins to use when discretize is True. Valid n_colors
-        values are [1, 256]. Default: 8.
-    appearance: Optional[ColorMapAppearance]
-        This attribute controls how the color map annotation appears in the image, including
-        location, size, and visibility. When the scene is set to automatic color maps, these
-        attributes are automatically populated unless overridden. When setting the appearance,
-        the user is responsible for setting all values.
     """
 
     field: Field = dc.field(default_factory=Field)
+    """The field and component this color map applies to."""
     preset: ColorMapPreset = ColorMapPreset.JET
+    """
+    The color map preset to use. This defines the colors used in the color
+    map. Default is 'JET'.
+    """
     data_range: DataRange = dc.field(default_factory=DataRange)
+    """
+    An optional data range to use for the color map. The user must explicity
+    set the data ranges. If not set explicitly, the fields global data range
+    is used. For comparing multiple results, either with different solutions
+    in the same simulation or with different simulations, its highly
+    recommended that a range is provided so the color scales are the same
+    between the resulting images. Default: is an invalid data range.
+    """
     discretize: bool = False
+    """
+    Use discrete color bins instead of a continuous range. When True,
+    'n_colors' indicates how many discrete bins to use. Default: False.
+    """
     n_colors: int = 8
+    """
+    How many discrete bins to use when discretize is True. Valid n_colors
+    values are [1, 256]. Default: 8.
+    """
     appearance: Optional[ColorMapAppearance] = None
+    """
+    This attribute controls how the color map annotation appears in the image, including
+    location, size, and visibility. When the scene is set to automatic color maps, these
+    attributes are automatically populated unless overridden. When setting the appearance,
+    the user is responsible for setting all values.
+    """
 
     def _to_proto(self) -> vis_pb2.ColorMap:
         res: vis_pb2.ColorMap = vis_pb2.ColorMap()