From f778dc91d230519f4c7034521bbea3d588d6a3ff Mon Sep 17 00:00:00 2001 From: Johannes Mueller Date: Tue, 17 Dec 2024 13:19:43 +0100 Subject: [PATCH] Fix docs link to load collective Signed-off-by: Johannes Mueller --- docs/reference.rst | 3 +-- docs/stress/collective.rst | 6 ++++++ docs/stress/load_collective.rst | 6 ------ docs/stress/load_histogram.rst | 6 ------ docs/tutorials.rst | 10 +++++----- src/pylife/stress/collective/__init__.py | 17 +++++++++++++++++ 6 files changed, 29 insertions(+), 19 deletions(-) create mode 100644 docs/stress/collective.rst delete mode 100644 docs/stress/load_collective.rst delete mode 100644 docs/stress/load_histogram.rst diff --git a/docs/reference.rst b/docs/reference.rst index f020832f..549ced5d 100644 --- 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 new file mode 100644 index 00000000..2de9a317 --- /dev/null +++ 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 deleted file mode 100644 index 2fc4f18a..00000000 --- a/docs/stress/load_collective.rst +++ /dev/null @@ -1,6 +0,0 @@ -The ``LoadCollective`` class -############################ - -.. autoclass:: pylife.stress.LoadCollective - :undoc-members: - :members: diff --git a/docs/stress/load_histogram.rst b/docs/stress/load_histogram.rst deleted file mode 100644 index 9a64275c..00000000 --- a/docs/stress/load_histogram.rst +++ /dev/null @@ -1,6 +0,0 @@ -The ``LoadHistogram`` class -########################### - -.. autoclass:: pylife.stress.LoadHistogram - :undoc-members: - :members: diff --git a/docs/tutorials.rst b/docs/tutorials.rst index b3a61fd4..44a49760 100644 --- 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 index 99c3ea7b..116bdaaa 100644 --- 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 ` shows the difference and how +to use the two. + +""" + __author__ = "Johannes Mueller" __maintainer__ = __author__