Fix docs link to load collective

Signed-off-by: Johannes Mueller <[email protected]>
boschresearch · Dec 17, 2024 · f778dc9 · f778dc9
1 parent 2b1bbfe
commit f778dc9
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 19 deletions.
diff --git a/docs/reference.rst b/docs/reference.rst
@@ -16,8 +16,7 @@ Stress
    stress/index
    stress/equistress
    stress/rainflow
-   stress/load_collective
-   stress/load_histogram
+   stress/collective
    stress/stresssignal
    stress/timesignal
    stress/frequencysignal

diff --git a/docs/stress/collective.rst b/docs/stress/collective.rst
@@ -0,0 +1,6 @@
+The module for load collectives
+###############################
+
+.. automodule:: pylife.stress.collective
+        :undoc-members:
+        :members:
diff --git a/docs/stress/load_collective.rst b/docs/stress/load_collective.rst
diff --git a/docs/stress/load_histogram.rst b/docs/stress/load_histogram.rst
diff --git a/docs/tutorials.rst b/docs/tutorials.rst
@@ -14,8 +14,8 @@ computer, you can use `MyBinder
 .. toctree::
    :maxdepth: 1
 
-   tutorials/woehler_curve.nblink
-   tutorials/load_collective.nblink
-   tutorials/stress-strength.rst
-   demos/fkm_nonlinear.nblink
-   demos/fkm_nonlinear_full.nblink
+   tutorials/woehler_curve
+   tutorials/load_collective
+   tutorials/stress-strength
+   demos/fkm_nonlinear
+   demos/fkm_nonlinear_full
diff --git a/src/pylife/stress/collective/__init__.py b/src/pylife/stress/collective/__init__.py
@@ -14,6 +14,23 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""
+There are two ways to deal with a load collective.
+
+* :class:`~pylife.stress.LoadCollective` lets you keep every load hysteresis in
+  and then calculate the amplitude, meanstress and damage for each and every
+  hyteresis indivudually.
+
+* :class:`~pylife.stress.LoadHistogram` keeps the load information in a binned
+  histogram.  That means that not each and every hystresis is stored
+  individually but there are bin classes for the load levels the hysteresis is
+  originating from and one for the levels the hysteresis is open.
+
+This :doc:`tutorial </tutorials/load_collective>` shows the difference and how
+to use the two.
+
+"""
+
 __author__ = "Johannes Mueller"
 __maintainer__ = __author__