Added modules docstrings based on ComponentList.xlsx (#48)

* Added modules docstrings based on ComponentList.xlsx

* Modified material laws docstrings

Author: Vybornak2

src/fatpy/core/damage_cumulation/__init__.py

@@ -1,4 +1,8 @@
 """Damage cumulation module.
 
-This module contains the classes and functions for damage cumulation methods.
+The module implements various fatigue damage accumulation rules used to estimate the
+total damage under variable amplitude loading. They include both classical linear
+models, such as Palmgren–Miner’s rule, and more advanced non-linear approaches that
+account for load sequence effects, mean stress influence, and material-specific
+behavior for improved fatigue life prediction.
 """

src/fatpy/core/decompositions/__init__.py

@@ -1,4 +1,5 @@
 """Decompositions module.
 
-This module contains the classes and functions for decomposition methods.
+Methods for breaking down complex load signals to cycles.
+Contains both the uniaxial and the multiaxial procedures.
 """

src/fatpy/core/decompositions/multiaxial/__init__.py

@@ -0,0 +1,7 @@
+"""Multiaxial decompositions methods.
+
+These routines provide tools for decomposing multiaxial stress and strain states into
+their individual components, such as normal and shear parts, principal values, and
+others. They are essential for analyzing complex loading conditions, enabling accurate
+evaluation of material behavior under multiaxial fatigue.
+"""

src/fatpy/core/decompositions/multiaxial/load_path_analysis_5d.py

@@ -0,0 +1,8 @@
+"""Load Path Analysis 5D methods of multiaxial decompositions.
+
+These methods compute the amplitude (J_2,a) and mean (J_2,m) values of the second
+invariant of the deviatoric stress tensor in five-dimensional deviatoric space. This
+evaluation is particularly useful in advanced multiaxial fatigue models, where accurate
+representation of cyclic loading paths and stress states in the deviatoric space is
+critical for predicting material response.
+"""

src/fatpy/core/decompositions/multiaxial/shear_path_analysis_2d.py

@@ -0,0 +1,7 @@
+"""Shear Path Analysis 2D methods of multiaxial decompositions.
+
+These methods are designed to evaluate the mean shear stress and shear stress amplitude
+acting on a specified material plane, typically used in multiaxial fatigue analysis. By
+projecting the stress tensor onto the plane of interest, they provide key parameters
+for assessing crack initiation risks and fatigue life under complex loading paths.
+"""

src/fatpy/core/decompositions/uniaxial.py

@@ -0,0 +1,8 @@
+"""Uniaxial decompositions methods.
+
+Implements algorithms designed to decompose one-dimensional signals into individual load
+cycles, enabling detailed analysis of variable amplitude loading. By identifying turning
+points and extracting cycles based on established criteria (e.g., rainflow counting),
+they facilitate fatigue analysis, damage assessment, and other time-domain signal
+evaluations.
+"""

src/fatpy/core/energy_life/__init__.py

@@ -1,5 +1,5 @@
 """Energy-based fatigue life analysis methods.
 
-This package provides implementations of energy-based approaches for
-fatigue life prediction and analysis.
+Fatigue analysis methods based on the relationship between the strain energy
+(usually strain energy density) and number of cycles to failure.
 """

src/fatpy/core/energy_life/correction_methods.py

@@ -1 +1 @@
-"""Correction methods for the energy-life."""
+"""Correction methods for the energy-life approach."""

src/fatpy/core/plane_based_methods/__init__.py

@@ -1,4 +1,5 @@
 """Plane-based methods module.
 
-This module contains the classes and functions for plane-based methods.
+Methods for processing stress tensor path on a material plane. Provides basic
+infrastructure for prediction methods based on critical-plane and integral approaches.
 """

src/fatpy/core/plane_based_methods/plane_search.py

@@ -0,0 +1,5 @@
+"""Plane Search methods.
+
+Algorithms to identify a subset of potentially critical planes for further detailed
+analysis and processing by critical-plane and integral methods.
+"""