diff --git a/doc/source/examples/extended_examples/Krylov/Harmonic_Analysis_using_krylov_pymapdl_files/Harmonic_Analysis_using_krylov_pymapdl_15_1.png b/doc/source/examples/extended_examples/Krylov/files/file_15_1.png similarity index 100% rename from doc/source/examples/extended_examples/Krylov/Harmonic_Analysis_using_krylov_pymapdl_files/Harmonic_Analysis_using_krylov_pymapdl_15_1.png rename to doc/source/examples/extended_examples/Krylov/files/file_15_1.png diff --git a/doc/source/examples/extended_examples/Krylov/Harmonic_Analysis_using_krylov_pymapdl_files/Harmonic_Analysis_using_krylov_pymapdl_36_1.png b/doc/source/examples/extended_examples/Krylov/files/file_36_1.png similarity index 100% rename from doc/source/examples/extended_examples/Krylov/Harmonic_Analysis_using_krylov_pymapdl_files/Harmonic_Analysis_using_krylov_pymapdl_36_1.png rename to doc/source/examples/extended_examples/Krylov/files/file_36_1.png diff --git a/doc/source/examples/extended_examples/Krylov/Harmonic_Analysis_using_krylov_pymapdl_files/Harmonic_Analysis_using_krylov_pymapdl_38_0.png b/doc/source/examples/extended_examples/Krylov/files/file_38_0.png similarity index 100% rename from doc/source/examples/extended_examples/Krylov/Harmonic_Analysis_using_krylov_pymapdl_files/Harmonic_Analysis_using_krylov_pymapdl_38_0.png rename to doc/source/examples/extended_examples/Krylov/files/file_38_0.png diff --git a/doc/source/examples/extended_examples/Krylov/krylov_example.rst b/doc/source/examples/extended_examples/Krylov/krylov_example.rst index 234daba3e3..f94011534d 100644 --- a/doc/source/examples/extended_examples/Krylov/krylov_example.rst +++ b/doc/source/examples/extended_examples/Krylov/krylov_example.rst @@ -170,7 +170,7 @@ a length element size constraint to the longitudinal lines. mapdl.eplot() -.. image:: ../../../examples/extended_examples/Krylov/Harmonic_Analysis_using_krylov_pymapdl_files/Harmonic_Analysis_using_krylov_pymapdl_15_1.png +.. image:: files/file_15_1.png Define boundary conditions @@ -370,7 +370,7 @@ Plot the calculated data. plt.show() -.. image:: ../../../examples/extended_examples/Krylov/Harmonic_Analysis_using_krylov_pymapdl_files/Harmonic_Analysis_using_krylov_pymapdl_36_1.png +.. image:: files/file_36_1.png Plot the frequency response function @@ -432,4 +432,4 @@ Plot the frequency response function for the selected node. plt.show() -.. image:: ../../../examples/extended_examples/Krylov/Harmonic_Analysis_using_krylov_pymapdl_files/Harmonic_Analysis_using_krylov_pymapdl_38_0.png \ No newline at end of file +.. image:: files/file_38_0.png \ No newline at end of file diff --git a/doc/source/examples/extended_examples/index.rst b/doc/source/examples/extended_examples/index.rst index b220584973..cf577af773 100644 --- a/doc/source/examples/extended_examples/index.rst +++ b/doc/source/examples/extended_examples/index.rst @@ -3,12 +3,11 @@ Extended examples ================= - These extended examples explain other concepts such as interoperability with other programs, libraries, and features in development. +----------------------------+---------------------------------------------------------------------------------------------------------+ -| Name | Description | +| **Name** | **Description** | +----------------------------+---------------------------------------------------------------------------------------------------------+ | `Cart-Pole Simulation`_ | Demonstrates a reinforcement machine learning example using MAPDL through PyMAPDL. | +----------------------------+---------------------------------------------------------------------------------------------------------+ @@ -24,4 +23,15 @@ with other programs, libraries, and features in development. +----------------------------+---------------------------------------------------------------------------------------------------------+ -.. _Cart-Pole Simulation: https://pyansys.github.io/ml-rl-cartpole/ml-rl-notebook.html +.. _Cart-Pole Simulation: cartpole_example_notebook_ + +.. toctree:: + :hidden: + :maxdepth: 2 + + Cart-Pole Simulation + ex_01-gmsh_example/ex_01-gmsh_example.rst + Python_UPF/python_upf_examples.rst + Krylov/krylov_example.rst + dash/dash_example.rst + executable/executable.rst diff --git a/doc/source/examples/index.rst b/doc/source/examples/index.rst index a3ba3f13c4..eb2a1659c5 100644 --- a/doc/source/examples/index.rst +++ b/doc/source/examples/index.rst @@ -25,6 +25,7 @@ Here are a series of examples using MAPDL with the ``ansys-mapdl-core`` library. Verification Manual Technology Showcases + extended_examples/index.rst .. include:: pymapdl_examples_repo/index.rst @@ -32,19 +33,10 @@ Here are a series of examples using MAPDL with the ``ansys-mapdl-core`` library. .. === EXTENDED EXAMPLES === -.. toctree:: - :hidden: - :maxdepth: 3 - - Cart-Pole Simulation - extended_examples/ex_01-gmsh_example/ex_01-gmsh_example - extended_examples/Python_UPF/python_upf_examples - extended_examples/Krylov/krylov_example - extended_examples/dash/dash_example - extended_examples/executable/executable .. include:: extended_examples/index.rst :start-line: 2 + :end-line: 27 .. === DOWNLOAD EXAMPLES === diff --git a/doc/source/links.rst b/doc/source/links.rst index 96b2e0ef8e..eb32f9b1b7 100644 --- a/doc/source/links.rst +++ b/doc/source/links.rst @@ -130,6 +130,7 @@ .. _pymapdl_docker_compose_local: https://github.com/pyansys/pymapdl/blob/main/docker/docker-compose.local.yml .. _pymapdl_docker_compose_license_server: https://github.com/pyansys/pymapdl/blob/main/docker/docker-compose.license_server.yml .. _pymapdl_discussion_differences_mapdl_pymapdl: https://github.com/pyansys/pymapdl-reader/issues/185 +.. _cartpole_example_notebook: https://cartpole.mapdl.docs.pyansys.com/ml-rl-notebook.html .. #Python .. _using_venv: https://docs.python.org/3/library/venv.html diff --git a/examples/04-general-fea/00-how_finite_element_works.py b/examples/04-general-fea/00-how_finite_element_works.py index 99281c2426..5391e94323 100644 --- a/examples/04-general-fea/00-how_finite_element_works.py +++ b/examples/04-general-fea/00-how_finite_element_works.py @@ -1,8 +1,8 @@ """ .. _build_element_example: -Build a Finite Element ----------------------- +Build a Finite Element Model +---------------------------- A finite element machinery built for a quadrilateral element using an isoparametric formulation and validated with PyMAPDL.