Various improvements to streamline example code

README.rst

@@ -218,7 +218,7 @@ On Windows:
 
 The generated HTML files can be viewed with the browser of your choice.
 
-Alternatively you can build the documentation by starting an mapdl and pydpf-composites docker
+Alternatively you can build the documentation by starting a mapdl and pydpf-composites docker
 container. First ensure that you have accepted the DPF Preview License Agreement by setting the
 ANSYS_DPF_ACCEPT_LA environment variable to Y
 (see `DPF Preview License Agreement <https://dpf.docs.pyansys.com/version/stable/user_guide/getting_started_with_dpf_server.html#dpf-preview-license-agreement>`_

doc/source/api/workflow.rst

@@ -9,6 +9,8 @@ Workflow
     ACPWorkflow
     get_composite_post_processing_files
     get_model_tree
+    get_dpf_unit_system
     print_model
 
 
+

examples/001_basic_flat_plate.py

@@ -26,6 +26,7 @@
     ACPWorkflow,
     Client,
     get_composite_post_processing_files,
+    get_dpf_unit_system,
     launch_acp,
     print_model,
 )
@@ -57,7 +58,7 @@
 
 # %%
 # Define the input file and instantiate an ACPWorkflow
-# The ACPWorkflow class provides convenience methods which simplifies the file handling.
+# The ACPWorkflow class provides convenience methods which simplify the file handling.
 # It automatically creates a model based on the input file.
 
 workflow = ACPWorkflow(
@@ -96,9 +97,6 @@
     eSxz=strain_limit,
 )
 
-# Deletes the StructuralSteel Todo should we remove it from the input cdb
-# model.materials["1"]
-
 ud_material = model.create_material(
     name="UD",
     ply_type=PlyType.REGULAR,
@@ -133,7 +131,7 @@
 
 
 # %%
-# Create various plies a different angles and add them to a modeling group
+# Create various plies with different angles and add them to a modeling group
 modeling_group = model.create_modeling_group(name="modeling_group")
 angles = [0, 45, -45, 45, -45, 0]
 for idx, angle in enumerate(angles):
@@ -200,7 +198,6 @@
 from ansys.dpf.composites.constants import FailureOutput
 from ansys.dpf.composites.failure_criteria import CombinedFailureCriterion, MaxStrainCriterion
 from ansys.dpf.composites.server_helpers import connect_to_or_start_server
-from ansys.dpf.core.unit_system import unit_systems
 
 # %%
 # Connect to the server. The ``connect_to_or_start_server`` function
@@ -220,7 +217,7 @@
 # Create the CompositeModel and configure its input
 composite_model = CompositeModel(
     get_composite_post_processing_files(workflow, rst_file_local_path),
-    default_unit_system=unit_systems.solver_nmm,
+    default_unit_system=get_dpf_unit_system(model.unit_system),
     server=dpf_server,
 )
 

src/ansys/acp/core/__init__.py

@@ -45,7 +45,7 @@
     VirtualGeometry,
 )
 from ._utils.example_helpers import ExampleKeys, get_example_file
-from ._workflow import ACPWorkflow, get_composite_post_processing_files
+from ._workflow import ACPWorkflow, get_composite_post_processing_files, get_dpf_unit_system
 
 __version__ = importlib.metadata.version(__name__.replace(".", "-"))
 
@@ -103,4 +103,5 @@
     "print_model",
     "ScalarData",
     "VectorData",
+    "get_dpf_unit_system",
 ]

src/ansys/acp/core/_client.py

@@ -67,7 +67,7 @@ def download_file(self, remote_filename: _PATH, local_path: _PATH) -> None:
         Download a file from the server.
 
         If the server is remote, download the file to the local path.
-        If the server is local do nothing.
+        If the server is local, do nothing.
 
         Parameters
         ----------

src/ansys/acp/core/_tree_objects/_mesh_data.py

@@ -241,6 +241,7 @@ def get_pyvista_glyphs(
 
 
 def _check_field_type(klass: Any, field_name: str, actual_field_type: str) -> None:
+    """Checks that the type declared in the dataclass (klass) matches the actual type."""
     declared_field_types: typing.Sequence[str] = cast(
         typing.Sequence[str],
         [field.type for field in dataclasses.fields(klass) if field.name == field_name],

src/ansys/acp/core/_utils/example_helpers.py

@@ -34,7 +34,7 @@ class ExampleKeys(Enum):
 
 
 def get_example_file(example_key: ExampleKeys, working_directory: pathlib.Path) -> pathlib.Path:
-    """Download an example file from the example-data repo to the working directory.
+    """Downloads an example file from the example-data repo to the working directory.
 
     Parameters
     ----------

src/ansys/acp/core/_workflow.py

@@ -3,11 +3,14 @@
 import tempfile
 from typing import Any, Callable, Optional, Protocol
 
+from ansys.dpf.core import UnitSystem, unit_systems
+
+from . import UnitSystemType
 from ._client import Client
 from ._tree_objects import Model
 from ._typing_helper import PATH
 
-__all__ = ["ACPWorkflow", "get_composite_post_processing_files"]
+__all__ = ["ACPWorkflow", "get_composite_post_processing_files", "get_dpf_unit_system"]
 
 
 class _LocalWorkingDir:
@@ -210,3 +213,34 @@ def get_composite_post_processing_files(
         engineering_data=acp_workflow.get_local_materials_file(),
     )
     return composite_files
+
+
+def get_dpf_unit_system(unit_system: UnitSystemType) -> UnitSystem:
+    """Converts pyACP unit system to DPF unit system.
+
+    Parameters
+    ----------
+    unit_system
+        The pyACP unit system.
+    """
+    unit_systems_map = {
+        UnitSystemType.UNDEFINED: unit_systems.undefined,
+        # looks like the only difference from MKS to SI is
+        # that temperature is defined as Kelvin in SI and °C in MKS.
+        # We should still force the user to use MKS in this case.
+        UnitSystemType.SI: None,
+        UnitSystemType.MKS: unit_systems.solver_mks,
+        UnitSystemType.uMKS: unit_systems.solver_umks,
+        UnitSystemType.CGS: unit_systems.solver_cgs,
+        # MPA is equivalent to nmm
+        UnitSystemType.MPA: unit_systems.solver_nmm,
+        UnitSystemType.BFT: unit_systems.solver_bft,
+        UnitSystemType.BIN: unit_systems.solver_bin,
+    }
+
+    if unit_systems_map[unit_system] is None:
+        raise ValueError(f"Unit system {unit_system} not supported. Use MKS instead of SI.")
+    if unit_system not in unit_systems_map:
+        raise ValueError(f"Unit system {unit_system} not supported.")
+
+    return unit_systems_map[unit_system]