adjusted report related docstrings and added report init (#1159)

* adjusted report related docstrings and added report init

* lint fixes

* moved field descriptions from docstrings to pydantic Fields

* black

Author: wiktor-flex

flow360/__init__.py

@@ -151,6 +151,7 @@
 from flow360.component.surface_mesh_v2 import SurfaceMeshV2 as SurfaceMesh
 from flow360.component.volume_mesh import VolumeMeshV2 as VolumeMesh
 from flow360.environment import Env
+from flow360.plugins import report
 from flow360.version import __solver_version__, __version__
 
 __all__ = [
@@ -273,4 +274,5 @@
     "StreamlineOutput",
     "Transformation",
     "WallRotation",
+    "report",
 ]

flow360/plugins/report/__init__.py

@@ -0,0 +1,67 @@
+"""Utilities for creating reports"""
+
+from flow360.plugins.report.report import ReportTemplate
+from flow360.plugins.report.report_items import (
+    Chart2D,
+    Chart3D,
+    FixedRangeLimit,
+    ManualLimit,
+    NonlinearResiduals,
+    PatternCaption,
+    Settings,
+    SubsetLimit,
+    Summary,
+    Table,
+)
+from flow360.plugins.report.utils import (
+    Average,
+    DataItem,
+    Delta,
+    Expression,
+    GetAttribute,
+    Grouper,
+    Variable,
+)
+from flow360.plugins.report.uvf_shutter import (
+    BottomCamera,
+    Camera,
+    FrontCamera,
+    FrontLeftBottomCamera,
+    FrontLeftTopCamera,
+    LeftCamera,
+    RearCamera,
+    RearLeftTopCamera,
+    RearRightBottomCamera,
+    TopCamera,
+)
+
+__all__ = [
+    "Average",
+    "BottomCamera",
+    "Camera",
+    "Chart2D",
+    "Chart3D",
+    "DataItem",
+    "Delta",
+    "Expression",
+    "FixedRangeLimit",
+    "FrontCamera",
+    "FrontLeftBottomCamera",
+    "FrontLeftTopCamera",
+    "GetAttribute",
+    "Grouper",
+    "LeftCamera",
+    "ManualLimit",
+    "NonlinearResiduals",
+    "PatternCaption",
+    "RearCamera",
+    "RearLeftTopCamera",
+    "RearRightBottomCamera",
+    "ReportTemplate",
+    "Settings",
+    "SubsetLimit",
+    "Summary",
+    "Table",
+    "TopCamera",
+    "Variable",
+]

flow360/plugins/report/report.py

@@ -144,21 +144,16 @@ class ReportTemplate(Flow360BaseModel):
     """
     A model representing a report containing various components such as summaries, inputs, tables,
     and charts in both 2D and 3D.
-
-    Parameters
-    ----------
-    title: str, optional
-        Title of report, shown on the first page
-    items : List[Union[Summary, Inputs, Table, Chart2D, Chart3D]]
-        A list of report items, each of which can be a summary, input data, table, 2D chart, or 3D chart.
-        The `type` field acts as a discriminator for differentiating item types.
-    include_case_by_case : bool, default=True
-        Flag indicating whether to include a case-by-case analysis in the report.
     """
 
-    title: Optional[str] = None
-    items: List[ReportItemTypes] = pd.Field()
-    include_case_by_case: bool = False
+    title: Optional[str] = pd.Field(None, description="Title of report, shown on the first page.")
+    items: List[ReportItemTypes] = pd.Field(
+        description="A list of report items, each of which can be a summary, input data, table, 2D chart, or 3D chart."
+    )
+    include_case_by_case: bool = pd.Field(
+        False,
+        description="Flag indicating whether to include a case-by-case analysis in the report.",
+    )
     settings: Optional[Settings] = Settings()
 
     @pd.model_validator(mode="after")