From 743ad2147a2a946c381dfd3b2814865c42d5e938 Mon Sep 17 00:00:00 2001 From: Mohamed Koubaa Date: Wed, 13 Nov 2024 06:56:16 -0600 Subject: [PATCH] clean up readme files (#610) Co-authored-by: Mohamed Koubaa --- examples/Buckling_Beer_Can/README.rst | 14 +++++++++----- examples/John_Reid_Pendulum/README.rst | 4 ++-- examples/John_Reid_Pipe/README.rst | 4 ++-- examples/Taylor_Bar/README.rst | 4 ++-- 4 files changed, 15 insertions(+), 11 deletions(-) diff --git a/examples/Buckling_Beer_Can/README.rst b/examples/Buckling_Beer_Can/README.rst index a4b633c64..28ecd09a3 100644 --- a/examples/Buckling_Beer_Can/README.rst +++ b/examples/Buckling_Beer_Can/README.rst @@ -1,6 +1,10 @@ -Buckling of beer can example -============================ +Beer can buckling +================= -This example is adapted from `https://lsdyna.ansys.com/example-nonlinear-2/` to run from -Python. It is a highly nonlinear problem that whose solution will not fully converge, but -that is expected. +Note: due to `https://github.com/ansys/pydyna/issues/583`, this example is not available in +the documentation. But it can be found in the code at +`https://github.com/ansys/pydyna/tree/main/examples/Buckling_Beer_Can` + +.. This example is adapted from `https://lsdyna.ansys.com/example-nonlinear-2/` to run from +.. Python. It is a highly nonlinear problem that whose solution will not fully converge, but +.. that is expected. diff --git a/examples/John_Reid_Pendulum/README.rst b/examples/John_Reid_Pendulum/README.rst index ca4508ab4..8d73a85d6 100644 --- a/examples/John_Reid_Pendulum/README.rst +++ b/examples/John_Reid_Pendulum/README.rst @@ -1,5 +1,5 @@ -John Reid pendulum example -========================== +Pendulum +======== This example is adapted from `https://lsdyna.ansys.com/pendlum/` to run from Python. diff --git a/examples/John_Reid_Pipe/README.rst b/examples/John_Reid_Pipe/README.rst index e9f170817..fcd779036 100644 --- a/examples/John_Reid_Pipe/README.rst +++ b/examples/John_Reid_Pipe/README.rst @@ -1,4 +1,4 @@ -John Reid pipe example -====================== +Pipe +==== This example is adapted from `https://lsdyna.ansys.com/pipe-d51/` to run from Python. diff --git a/examples/Taylor_Bar/README.rst b/examples/Taylor_Bar/README.rst index 392983975..c1c9bac8f 100644 --- a/examples/Taylor_Bar/README.rst +++ b/examples/Taylor_Bar/README.rst @@ -1,5 +1,5 @@ -Taylor bar example -================== +Taylor bar impact +================= This example, inspired by the `https://lsdyna.ansys.com/bar-a/` example, shows how to use PyDyna to parameterize a LS-DYNA problem and compare results.