luminarycloud 0.14.1__py3-none-any.whl → 0.15.0__py3-none-any.whl

luminarycloud/params/simulation/time/compute_statistics/compute_statistics_on_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,9 +13,10 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 from luminarycloud.params.simulation.time.compute_statistics_ import ComputeStatistics
 from luminarycloud.params.simulation.time.compute_statistics_ import *

luminarycloud/params/simulation/time/compute_statistics_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,9 +13,10 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 
 @dataclass(kw_only=True)

luminarycloud/params/simulation/time/time_marching/time_explicit_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,9 +13,10 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 from luminarycloud.params.simulation.time.time_marching_ import TimeMarching
 from luminarycloud.params.simulation.time.time_marching_ import *

luminarycloud/params/simulation/time/time_marching/time_implicit_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,9 +13,10 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 from luminarycloud.params.simulation.time.time_marching_ import TimeMarching
 from luminarycloud.params.simulation.time.time_marching_ import *

luminarycloud/params/simulation/time/time_marching_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,9 +13,10 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 
 @dataclass(kw_only=True)

luminarycloud/params/simulation/time/time_step_ramp/time_step_ramp_off_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,9 +13,10 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 from luminarycloud.params.simulation.time.time_step_ramp_ import TimeStepRamp
 from luminarycloud.params.simulation.time.time_step_ramp_ import *

luminarycloud/params/simulation/time/time_step_ramp/time_step_ramp_on_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,9 +13,10 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 from luminarycloud.params.simulation.time.time_step_ramp_ import TimeStepRamp
 from luminarycloud.params.simulation.time.time_step_ramp_ import *

luminarycloud/params/simulation/time/time_step_ramp_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,9 +13,10 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 
 @dataclass(kw_only=True)

luminarycloud/params/simulation/time_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,9 +13,10 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 from luminarycloud.params.simulation.time.compute_statistics_ import ComputeStatistics
 from luminarycloud.params.simulation.time.compute_statistics_ import *
@@ -46,13 +47,13 @@ class Time(CodeRepr, ParamGroupWrapper[clientpb.Time]):
     """Time parameters used by a transient solution (required if flow_behavior = transient)."""
 
     time_marching: TimeMarching = field(default_factory=TimeImplicit)
-    "Scheme for time-accurate integration."
+    "Scheme for time-accurate integration. Possible types: ``TimeImplicit``, ``TimeExplicit`` from the ``time_marching`` module."
     time_step: float = 0.0001
     "The fixed physical time step."
     time_step_ramp: TimeStepRamp = field(default_factory=TimeStepRampOff)
-    "Use a larger time step value during the initial transients of a simulation and then ramp linearly towards the target value, to accelerate statistical convergence. Only applicable to transient problems with time implicit integration (dual time stepping)."
+    "Use a larger time step value during the initial transients of a simulation and then ramp linearly towards the target value, to accelerate statistical convergence. Only applicable to transient problems with time implicit integration (dual time stepping). Possible types: ``TimeStepRampOff``, ``TimeStepRampOn`` from the ``time_step_ramp`` module."
     compute_statistics: ComputeStatistics = field(default_factory=ComputeStatisticsOff)
-    "Compute time-averaged values of flow variables (e.g. Velocity)."
+    "Compute time-averaged values of flow variables (e.g. Velocity). Possible types: ``ComputeStatisticsOff``, ``ComputeStatisticsOn`` from the ``compute_statistics`` module."
 
     def _to_proto(self) -> clientpb.Time:
         _proto = clientpb.Time()

luminarycloud/params/simulation/volume_entity_.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Any
 from uuid import uuid4
 
 from luminarycloud.tables import RectilinearTable, _param_name_to_table_type
@@ -13,17 +13,18 @@ from luminarycloud.types import Vector3
 from luminarycloud.types.adfloat import _to_ad_proto, _from_ad_proto
 from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
+from luminarycloud._helpers import CodeRepr
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, create_unique_id
 
 
 @dataclass(kw_only=True)
 class VolumeEntity(CodeRepr, ParamGroupWrapper[clientpb.VolumeEntity]):
     """Volume entity."""
 
-    volume_identifier: Optional[EntityIdentifier] = None
-    "Unique identifier for a volume entity"
+    volume_identifier: EntityIdentifier | None = None
+    "Unique identifier for a volume entity."
 
     def _to_proto(self) -> clientpb.VolumeEntity:
         _proto = clientpb.VolumeEntity()

luminarycloud/physics_ai/__init__.py

@@ -0,0 +1,8 @@
+from .architectures import (
+    list_architectures as list_architectures,
+    PhysicsAiArchitecture as PhysicsAiArchitecture,
+)
+from .models import (
+    list_pretrained_models as list_pretrained_models,
+    PhysicsAiModel as PhysicsAiModel,
+)

luminarycloud/physics_ai/architectures.py

@@ -0,0 +1,38 @@
+# Copyright 2025 Luminary Cloud, Inc. All Rights Reserved.
+from __future__ import annotations
+
+from typing import List
+
+from .._client import get_default_client
+from .._proto.api.v0.luminarycloud.physics_ai import physics_ai_pb2 as physaipb
+from .._wrapper import ProtoWrapper, ProtoWrapperBase
+from .._helpers.warnings import experimental
+from ..types.ids import PhysicsAiArchitectureID
+
+
+@experimental
+@ProtoWrapper(physaipb.PhysicsAiArchitecture)
+class PhysicsAiArchitecture(ProtoWrapperBase):
+    """
+    Represents a Physics AI architecture.
+
+    warning:: This feature is experimental and may change or be removed without notice.
+    """
+
+    id: PhysicsAiArchitectureID
+    name: str
+    description: str
+    version: str
+    _proto: physaipb.PhysicsAiArchitecture
+
+
+@experimental
+def list_architectures() -> List[PhysicsAiArchitecture]:
+    """
+    List available Physics AI architectures for model training.
+
+    warning:: This feature is experimental and may change or be removed without notice.
+    """
+    req = physaipb.ListArchitecturesRequest()
+    res = get_default_client().ListArchitectures(req)
+    return [PhysicsAiArchitecture(arch) for arch in res.architectures]

luminarycloud/physics_ai/models.py

@@ -0,0 +1,42 @@
+# Copyright 2025 Luminary Cloud, Inc. All Rights Reserved.
+from __future__ import annotations
+
+from datetime import datetime
+from typing import List
+
+from .._client import get_default_client
+from .._helpers._timestamp_to_datetime import timestamp_to_datetime
+from .._proto.api.v0.luminarycloud.physics_ai import physics_ai_pb2 as physaipb
+from .._wrapper import ProtoWrapper, ProtoWrapperBase
+from .._helpers.warnings import experimental
+from ..types.ids import PhysicsAiModelID
+
+
+@experimental
+@ProtoWrapper(physaipb.PhysicsAiModel)
+class PhysicsAiModel(ProtoWrapperBase):
+    """Represents a Physics AI model."""
+
+    id: PhysicsAiModelID
+    name: str
+    version: str
+
+    _proto: physaipb.PhysicsAiModel
+
+    @property
+    def create_time(self) -> datetime:
+        return timestamp_to_datetime(self._proto.create_time)
+
+    @property
+    def update_time(self) -> datetime:
+        return timestamp_to_datetime(self._proto.update_time)
+
+
+@experimental
+def list_pretrained_models() -> List[PhysicsAiModel]:
+    """
+    List available pretrained Physics AI models.
+    """
+    req = physaipb.ListPretrainedModelsRequest()
+    res = get_default_client().ListPretrainedModels(req)
+    return [PhysicsAiModel(model) for model in res.models]

luminarycloud/project.py

@@ -45,7 +45,7 @@ from .enum import GPUType, MeshType, TableType
 from .meshing import MeshAdaptationParams, MeshGenerationParams
 from .simulation_param import SimulationParam
 from .tables import RectilinearTable, create_rectilinear_table
-from .types import MeshID, ProjectID
+from .types import MeshID, ProjectID, SimulationTemplateID
 
 if TYPE_CHECKING:
     from .geometry import Geometry
@@ -109,6 +109,10 @@ class Project(ProtoWrapperBase):
         )
         get_default_client().DeleteProject(req)
 
+    @property
+    def url(self) -> str:
+        return f"https://{get_default_client().primary_domain}/project/{self.id}"
+
     def create_geometry(
         self,
         cad_file_path: PathLike | str,
@@ -257,7 +261,7 @@ class Project(ProtoWrapperBase):
     @deprecated("Use create_or_get_mesh() instead", "0.10.0")
     def create_mesh(
         self,
-        params: meshpb.MeshGenerationParams | MeshAdaptationParams | MeshGenerationParams,
+        params: MeshAdaptationParams | MeshGenerationParams,
         *,
         name: str,
     ) -> "Mesh":
@@ -312,7 +316,7 @@ class Project(ProtoWrapperBase):
 
     def create_or_get_mesh(
         self,
-        params: meshpb.MeshGenerationParams | MeshAdaptationParams | MeshGenerationParams,
+        params: MeshAdaptationParams | MeshGenerationParams,
         *,
         name: str,
     ) -> "Mesh":
@@ -344,7 +348,7 @@ class Project(ProtoWrapperBase):
                     return lc.Mesh(res.mesh)
             raise
 
-    def create_hex_mesh(
+    def _create_hex_mesh(
         self,
         names_to_file_paths: Dict[str, Union[PathLike[Any], str]],
         params: hexmeshpb.HexMeshSpec,
@@ -432,12 +436,11 @@ class Project(ProtoWrapperBase):
             raise RuntimeError("The table upload failed.")
 
         # Update the simulation template with the new table reference.
-        simulation_template.parameters.table_references[name].url = url
-        simulation_template.parameters.table_references[name].table_type = table_type.value
-        simulation_template.parameters.table_references[name].uploaded_filename = uploaded_filename
-        simulation_template.update(
-            name=simulation_template.name, parameters=simulation_template.parameters
-        )
+        params: clientpb.SimulationParam = simulation_template._proto.parameters
+        params.table_references[name].url = url
+        params.table_references[name].table_type = table_type.value
+        params.table_references[name].uploaded_filename = uploaded_filename
+        simulation_template._update(name=simulation_template.name, parameters=params)
 
         return RectilinearTable(id=name, name=uploaded_filename, table_type=table_type)
 
@@ -543,8 +546,9 @@ class Project(ProtoWrapperBase):
         self,
         name: str,
         *,
-        parameters: Optional[Union[clientpb.SimulationParam, SimulationParam]] = None,
+        parameters: Optional[SimulationParam] = None,
         params_json_path: Optional[PathLike | str] = None,
+        copy_from: Optional["SimulationTemplate" | SimulationTemplateID | str] = None,
     ) -> "SimulationTemplate":
         """
         Create a new simulation template object.
@@ -561,19 +565,35 @@ class Project(ProtoWrapperBase):
             Complete simulation parameters. Ignored if `params_json_path` is set.
         params_json_path : PathLike or str, optional
             Path to local JSON file containing simulation params.
-        """
+        copy_from : SimulationTemplate or str, optional
+            Simulation template to copy. If provided, the new template will be a copy of this one.
+            Can pass a SimulationTemplate object or an ID of the template to copy.
+        """
+        if (
+            int(params_json_path is not None)
+            + int(parameters is not None)
+            + int(copy_from is not None)
+            != 1
+        ):
+            raise ValueError(
+                "Exactly one of parameters, params_json_path, or copy_from must be set"
+            )
+
+        param_proto: clientpb.SimulationParam | None = None
+        copy_from_id: str | None = None
+
         if params_json_path is not 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()
+            param_proto = parameters._to_proto()
+        elif copy_from is not None:
+            if isinstance(copy_from, lc.SimulationTemplate):
+                copy_from_id = copy_from.id
             else:
-                param_proto = clientpb.SimulationParam()
-                param_proto.CopyFrom(parameters)
-        else:
-            raise Exception("Either parameters or params_json_path must be set")
+                copy_from_id = copy_from
+
         req = simtemplatepb.CreateSimulationTemplateRequest(
-            project_id=self.id, name=name, parameters=param_proto
+            project_id=self.id, name=name, parameters=param_proto, copy_from=copy_from_id
         )
         res = get_default_client().CreateSimulationTemplate(req)
         return lc.SimulationTemplate(res.simulation_template)

luminarycloud/reference_values.py

@@ -3,10 +3,10 @@ from dataclasses import dataclass
 from typing import Any
 from ._proto.base.base_pb2 import AdFloatType
 from ._proto.output import reference_values_pb2 as refvalpb
+from ._proto.client import simulation_pb2 as clientpb
+from ._helpers import CodeRepr
 from .enum import ReferenceValuesType
 
-from .params.simulation._lib import CodeRepr
-
 
 @dataclass(kw_only=True)
 class ReferenceValues(CodeRepr):
@@ -75,7 +75,24 @@ class ReferenceValues(CodeRepr):
         self._to_proto_common(proto)
         return proto
 
-    def _from_proto_common(self, proto: Any) -> None:
+    def _to_client_proto(self) -> clientpb.ReferenceValues:
+        proto = clientpb.ReferenceValues()
+        if self.reference_value_type == ReferenceValuesType.PRESCRIBE_VALUES:
+            proto.reference_type = clientpb.PRESCRIBE_VALUES
+        elif self.reference_value_type == ReferenceValuesType.FARFIELD_VALUES:
+            proto.reference_type = clientpb.REFERENCE_FARFIELD_VALUES
+        else:
+            proto.reference_type = clientpb.INVALID_REFERENCE_TYPE
+        self._to_proto_common(proto)
+        return proto
+
+    def _from_client_proto(self, proto: clientpb.ReferenceValues) -> None:
+        if proto.reference_type == clientpb.PRESCRIBE_VALUES:
+            self.reference_value_type = ReferenceValuesType.PRESCRIBE_VALUES
+        elif proto.reference_type == clientpb.REFERENCE_FARFIELD_VALUES:
+            self.reference_value_type = ReferenceValuesType.FARFIELD_VALUES
+        else:
+            self.reference_value_type = ReferenceValuesType.UNSPECIFIED
         self.area_ref = proto.area_ref.value
         self.length_ref = proto.length_ref.value
         self.use_aero_moment_ref_lengths = proto.use_aero_moment_ref_lengths

luminarycloud/simulation.py

@@ -6,6 +6,7 @@ from typing import Optional
 from ._client import get_default_client
 from ._helpers._timestamp_to_datetime import timestamp_to_datetime
 from ._helpers._wait_for_simulation import wait_for_simulation
+from ._helpers.warnings import deprecated
 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
@@ -22,6 +23,7 @@ from .enum import (
 )
 from .simulation_param import SimulationParam
 from .reference_values import ReferenceValues
+from .simulation_param import SimulationParam
 from .solution import Solution
 from .types import MeshID, ProjectID, SimulationID, Vector3Like
 from .types.vector3 import _to_vector3_proto
@@ -288,16 +290,19 @@ class Simulation(ProtoWrapperBase):
         res = get_default_client().ListSolutions(req)
         return [Solution(s) for s in res.solutions]
 
-    def get_parameters(self) -> clientpb.SimulationParam:
+    def get_parameters(self) -> SimulationParam:
         req = simulationpb.GetSimulationParametersRequest(id=self.id)
-        return get_default_client().GetSimulationParameters(req)
+        return SimulationParam.from_proto(get_default_client().GetSimulationParameters(req))
 
+    @deprecated(
+        "Use get_parameters() instead. This method will be removed in a future release.",
+    )
     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())
+        return self.get_parameters()
 
 
 def get_simulation(id: SimulationID) -> Simulation:

luminarycloud/simulation_param.py

@@ -9,6 +9,7 @@ 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,
 )
 from luminarycloud._helpers.warnings import experimental
 from luminarycloud._proto.client import simulation_pb2 as clientpb
@@ -46,7 +47,29 @@ logger = getLogger(__name__)
 
 @dataclass(kw_only=True, repr=False)
 class SimulationParam(_SimulationParam):
-    """Simulation configuration that supports multiple physics."""
+    """
+    Solver configuration parameters that support multi-physics simulations.
+
+    The structure of these parameters is related to the decision tree of selecting different models,
+    boundary conditions, etc. for the simulation.
+    Most of these choices are made by picking one class for a given field over a number of
+    alternatives. For example:
+
+    >>> import luminarycloud.params.simulation as sim_params
+    >>> params = SimulationParam()
+    >>> params.physics[0].fluid.turbulence = sim_params.physics.fluid.turbulence.KomegaSst()
+    >>> params.physics[0].fluid.turbulence = sim_params.physics.fluid.turbulence.SpalartAllmaras()
+
+    The alternatives are listed in the documentation of each field (turbulence in this case), and
+    the (sub)module that provides them is always named after the field.
+    Therefore, even without consulting the documentation, it is possible to list the alternatives
+    using Python's ``dir`` function, in this case:
+
+    >>> dir(sim_params.physics.fluid.turbulence)
+
+    The alternative classes have different fields, which may again have their own alternative
+    classes thereby repeating the pattern and creating the tree structure.
+    """
 
     reference_values: ReferenceValues = field(default_factory=ReferenceValues)
     "Reference values for outputs and stopping conditions."
@@ -56,26 +79,21 @@ class SimulationParam(_SimulationParam):
 
     def _to_proto(self) -> clientpb.SimulationParam:
         _proto = super()._to_proto()
-        transient = self.basic is not None and self.basic.time == enum.FlowBehavior.TRANSIENT
-        if self.reference_values.reference_value_type == ReferenceValuesType.FARFIELD_VALUES:
-            raise ValueError(
-                "ReferenceValuesType.FARFIELD_VALUES cannot be used in SimulationParam yet."
-            )
-        self.reference_values._to_proto_common(_proto.reference_values)
+        _proto.reference_values.CopyFrom(self.reference_values._to_client_proto())
         return _proto
 
     @classmethod
     def from_proto(self, proto: clientpb.SimulationParam) -> "SimulationParam":
         _wrapper = cast(SimulationParam, super().from_proto(proto))
-        transient = (
-            _wrapper.basic is not None and _wrapper.basic.time == enum.FlowBehavior.TRANSIENT
-        )
-        _wrapper.reference_values._from_proto_common(proto.reference_values)
+        _wrapper.reference_values._from_client_proto(proto.reference_values)
         return _wrapper
 
     @classmethod
-    def from_json(cls, path: PathLike) -> "SimulationParam":
-        return cls.from_proto(simulation_params_from_json_path(path))
+    def from_json(cls, source: PathLike | dict) -> "SimulationParam":
+        if isinstance(source, PathLike):
+            return cls.from_proto(simulation_params_from_json_path(source))
+        else:
+            return cls.from_proto(simulation_params_from_json_dict(source))
 
     def assign_material(self, material: MaterialEntity, volume: Volume | str) -> None:
         """
@@ -290,16 +308,17 @@ class SimulationParam(_SimulationParam):
     def __repr__(self) -> str:
         return pformat(vars(self), compact=True, sort_dicts=True)
 
-    def to_code(self) -> str:
+    def to_code(self, hide_defaults: bool = True) -> str:
         """
         Returns the python code that generates an identical SimulationParam object.
-        This is a verbose representation where every parameter is set, even if its value
-        corresponds to the default, or a preset would override the value.
+        This is a verbose representation that does not make use of helper functions like
+        assign_material and assign_physics.
+        Parameters with default values are omitted by default, with hide_defaults=False, code will
+        also be generated for those parameters.
         """
         code = """## NOTE: This is a verbose representation of a SimulationParam object as the
 ## code that creates an identical object. The verbosity is intended to facilitate
-## the discovery of available parameters. However, note that when presets are used
-## (e.g. for material properties) some lines of this representation become redundant.
+## the discovery of available parameters.
 import luminarycloud
 from luminarycloud import *
 from luminarycloud.types import Vector3
@@ -308,16 +327,20 @@ from luminarycloud.params.enum import *
 from luminarycloud.params import simulation as params
 
 
-obj = SimulationParam()
 """
-        for line in _SimulationParam.to_code(self).split("\n")[1:]:
-            if line.startswith("new_") or line.startswith("#"):
-                code += f"{line}\n"
-            elif line.startswith(".new_"):
-                code += f"{line[1:]}\n"
-            elif line:
-                code += f"obj{line}\n"
-        return code
+        return code + self._to_code_helper("obj", hide_defaults).replace(
+            "luminarycloud.simulation_param.SimulationParam()", "SimulationParam()", 1
+        )
+
+    def find_parameter(self, parameter: str) -> None:
+        """
+        Searches the full output of "to_code()" for occurrences of "parameter" and prints the lines
+        with matches. This is a helper function to assist users in finding, for example, how to
+        change farfield conditions, material properties, etc.
+        """
+        for i, line in enumerate(self.to_code(False).split("\n")):
+            if parameter.lower() in line.lower():
+                print(f"line {i}: {line}")
 
 
 T = TypeVar("T")