Merge branch 'docs/overall_doc_review' of https://github.com/ansys/pyansys-heart into docs/overall_doc_review

Author: mhoeijm

src/ansys/health/heart/models.py

@@ -720,9 +720,7 @@ def plot_surfaces(self, show_edges: bool = True):
         try:
             import matplotlib as matplotlib
         except ImportError:
-            LOGGER.warning(
-                "Matplotlib is not found. Install with the 'pip install matplotlib' command."
-            )
+            LOGGER.warning("Matplotlib is not found. Install with 'pip install matplotlib'.")
             return
 
         surfaces_to_plot = [s for p in self.parts for s in p.surfaces]
@@ -1429,7 +1427,7 @@ def get_apex_node_set(
         option: Literal["endocardium", "epicardium", "myocardium"] = "epicardium",
         radius: float = 3,
     ) -> np.ndarray:
-        """Get a node set around the apex point.
+        """Get a nodeset around the apex point.
 
         Parameters
         ----------
@@ -1443,7 +1441,7 @@ def get_apex_node_set(
         Returns
         -------
         np.ndarray
-            Apex node set
+            Apex nodeset
         """
         import scipy.spatial as spatial
 

src/ansys/health/heart/objects.py

@@ -135,7 +135,7 @@ def __init__(self, name: str = None) -> None:
         self.type = None
         """Type of feature."""
         self._node_set_id: int = None
-        """Node set ID associated with feature."""
+        """Nodeset ID associated with feature."""
         self._seg_set_id: int = None
         """Segment set ID associated with feature."""
         self.pid: int = None
@@ -257,7 +257,7 @@ def __init__(
         self._seg_set_id: int = None
         """Segment set ID."""
         self._node_set_id: int = None
-        """Node set ID."""
+        """Nodeset ID."""
 
     @property
     def node_ids_triangles(self) -> np.ndarray:

src/ansys/health/heart/post/auto_process.py

@@ -40,21 +40,21 @@
 
 
 def zerop_post(directory: str, model: HeartModel) -> tuple[dict, np.ndarray, np.ndarray]:
-    """Post-process zeropressure folder.
+    """Postprocess the zero-pressure folder.
 
     Parameters
     ----------
     directory : str
-        Path to simulation folder
+        Path to the simulation folder.
     model : HeartModel
-        model to post-process
+        Model to postprocess.
 
     Returns
     -------
     tuple[dict, np.ndarray, np.ndarray]
-        dictionary with convergence information
-        stress free configuration
-        computed end-of-diastolic configuration
+        Dictionary with convergence information,
+        stress free configuration, and
+        computed end-of-diastolic configuration.
     """
     folder = "post"
     os.makedirs(os.path.join(directory, folder), exist_ok=True)
@@ -124,7 +124,7 @@ def zerop_post(directory: str, model: HeartModel) -> tuple[dict, np.ndarray, np.
     # save left ventricle in json
     dct["Left ventricle EOD pressure (mmHg)"] = lv_pr_mmhg
     dct["True left ventricle volume (mm3)"] = true_lv_ed_volume
-    dct["Simulation Left ventricle volume (mm3)"] = lv_volumes
+    dct["Simulation left ventricle volume (mm3)"] = lv_volumes
 
     # Klotz curve information
     klotz = EDPVR(true_lv_ed_volume / 1000, lv_pr_mmhg)
@@ -144,14 +144,14 @@ def zerop_post(directory: str, model: HeartModel) -> tuple[dict, np.ndarray, np.
 
 
 def mech_post(directory: str, model: HeartModel) -> None:
-    """Post-process mechanical simulation folder.
+    """Postprocess the mechanical simulation folder.
 
     Parameters
     ----------
     directory : str
-        d3plot folder
+        Path to the d3plot folder.
     model : HeartModel
-        heart model
+        Heart model.
     """
     last_cycle_duration = 800
     folder = "post"