From 2567240921e063709fb2226575b009b2909d19b9 Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Thu, 19 Sep 2024 11:33:13 +0200 Subject: [PATCH 01/16] add concepts intro in the user guide index page --- doc/source/user_guide/concepts/index.rst | 16 +--------------- doc/source/user_guide/index.rst | 11 +++++++++++ 2 files changed, 12 insertions(+), 15 deletions(-) diff --git a/doc/source/user_guide/concepts/index.rst b/doc/source/user_guide/concepts/index.rst index ebaaf9257ac..79a2f5606de 100644 --- a/doc/source/user_guide/concepts/index.rst +++ b/doc/source/user_guide/concepts/index.rst @@ -1,21 +1,7 @@ .. _ref_concepts: -======== Concepts -======== - -This section provides in-depth descriptions and explanations of DPF concepts, including terminology. - -DPF concepts -~~~~~~~~~~~~ - -.. toctree:: - :hidden: - - concepts.rst - waysofusing.rst - stepbystep.rst - +-------- .. card-carousel:: 2 diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst index 65b8cf0a287..0652135509e 100644 --- a/doc/source/user_guide/index.rst +++ b/doc/source/user_guide/index.rst @@ -13,6 +13,8 @@ The goals of this section are to: - Describe the most-used DPF entities and how they can help you to access and modify solver data. - Provide simple how-tos for tackling the most common use cases. +.. include:: + concepts/index.rst .. include:: main_entities.rst @@ -21,6 +23,15 @@ The goals of this section are to: how_to.rst +.. toctree:: + :hidden: + + concepts.rst + waysofusing.rst + stepbystep.rst + + + Troubleshooting ~~~~~~~~~~~~~~~ From 0fbbf46836e8b30504fcd4e5f361a74016a30939 Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Thu, 19 Sep 2024 11:43:15 +0200 Subject: [PATCH 02/16] add tutorials concept (from the main entities documents) --- doc/source/user_guide/concepts/index.rst | 2 +- doc/source/user_guide/index.rst | 2 +- doc/source/user_guide/main_entities.rst | 43 --------- .../{ => tutorials}/fields_container.rst | 0 doc/source/user_guide/tutorials/index.rst | 96 +++++++++++++++++++ .../user_guide/{ => tutorials}/model.rst | 2 +- .../user_guide/{ => tutorials}/operators.rst | 0 7 files changed, 99 insertions(+), 46 deletions(-) delete mode 100644 doc/source/user_guide/main_entities.rst rename doc/source/user_guide/{ => tutorials}/fields_container.rst (100%) create mode 100644 doc/source/user_guide/tutorials/index.rst rename doc/source/user_guide/{ => tutorials}/model.rst (99%) rename doc/source/user_guide/{ => tutorials}/operators.rst (100%) diff --git a/doc/source/user_guide/concepts/index.rst b/doc/source/user_guide/concepts/index.rst index 79a2f5606de..a2ef15163c9 100644 --- a/doc/source/user_guide/concepts/index.rst +++ b/doc/source/user_guide/concepts/index.rst @@ -1,4 +1,4 @@ -.. _ref_concepts: +.. _ref_concepts_index: Concepts -------- diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst index 0652135509e..52a24ee0996 100644 --- a/doc/source/user_guide/index.rst +++ b/doc/source/user_guide/index.rst @@ -17,7 +17,7 @@ The goals of this section are to: concepts/index.rst .. include:: - main_entities.rst + tutorials/index.rst .. include:: how_to.rst diff --git a/doc/source/user_guide/main_entities.rst b/doc/source/user_guide/main_entities.rst deleted file mode 100644 index b98991d0f05..00000000000 --- a/doc/source/user_guide/main_entities.rst +++ /dev/null @@ -1,43 +0,0 @@ -.. _ref_main_entities: - -DPF most-used entities -~~~~~~~~~~~~~~~~~~~~~~ - -.. toctree:: - :hidden: - - model - operators - fields_container - -.. card-carousel:: 2 - - .. card:: DPF model - :link: user_guide_model - :link-type: ref - :width: 25% - :text-align: center - - .. image:: ../images/drawings/model.png - - .. card:: Fields container and fields - :link: ref_user_guide_fields_container - :link-type: ref - :width: 25% - :text-align: center - - .. image:: ../images/drawings/field.png - - .. card:: Operators - :link: ref_user_guide_operators - :link-type: ref - :width: 25% - :text-align: center - - .. image:: ../images/drawings/small_operator.svg - - - - - - diff --git a/doc/source/user_guide/fields_container.rst b/doc/source/user_guide/tutorials/fields_container.rst similarity index 100% rename from doc/source/user_guide/fields_container.rst rename to doc/source/user_guide/tutorials/fields_container.rst diff --git a/doc/source/user_guide/tutorials/index.rst b/doc/source/user_guide/tutorials/index.rst new file mode 100644 index 00000000000..905f5831385 --- /dev/null +++ b/doc/source/user_guide/tutorials/index.rst @@ -0,0 +1,96 @@ +.. _ref_tutorials_index: + +Tutorials +--------- + + +The following tutorials shows in details how to use basic features of PyDPF-Core +for each usage main step. + +:bdg-dark-line:`Define simulation data` :octicon:`arrow-right;1em` :bdg-dark-line:`Store input data in DPF` :octicon:`arrow-right;1em` :bdg-dark-line:`Transform available data` :octicon:`arrow-right;1em` :bdg-dark-line:`Extract data` + +**Define simulation data** + + +.. grid:: 3 + + .. grid-item-card:: Data Sources + :link: ref_tutorials_model + :link-type: ref + :text-align: center + + .. grid-item-card:: DPF model + :link: ref_tutorials_model + :link-type: ref + :text-align: center + +**Store input data in DPF** + + +.. grid:: 3 + + .. grid-item-card:: Data arrays + :link: ref_tutorials_model + :link-type: ref + :text-align: center + + Fields + + PropertyField + + StringField + + CustomTypeField + + .. grid-item-card:: Data maps + :link: ref_tutorials_model + :link-type: ref + :text-align: center + + GenericDataContainer + + DataTree + + .. grid-item-card:: Collections + :link: ref_tutorials_model + :link-type: ref + :text-align: center + + LabelSpace + + FieldsContainer + + MeshContainer + +**Transform available data** + + +.. grid:: 3 + + .. grid-item-card:: Process creation + :link: ref_tutorials_model + :link-type: ref + :text-align: center + + Operators + + Workflow + + .. grid-item-card:: Results visualisation + :link: ref_tutorials_model + :link-type: ref + :text-align: center + + Plotter + + Animator + +**Export data** + + +.. grid:: 3 + + .. grid-item-card:: Serialisation + :link: ref_tutorials_model + :link-type: ref + :text-align: center \ No newline at end of file diff --git a/doc/source/user_guide/model.rst b/doc/source/user_guide/tutorials/model.rst similarity index 99% rename from doc/source/user_guide/model.rst rename to doc/source/user_guide/tutorials/model.rst index bd3f773a048..f7f5b539fb3 100644 --- a/doc/source/user_guide/model.rst +++ b/doc/source/user_guide/tutorials/model.rst @@ -1,4 +1,4 @@ -.. _user_guide_model: +.. _ref_tutorials_model: ========= DPF model diff --git a/doc/source/user_guide/operators.rst b/doc/source/user_guide/tutorials/operators.rst similarity index 100% rename from doc/source/user_guide/operators.rst rename to doc/source/user_guide/tutorials/operators.rst From d02de1df049eddf948a72b6ba38178e8c6fdadd0 Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Thu, 19 Sep 2024 11:58:46 +0200 Subject: [PATCH 03/16] organise and adapt the how-to section --- .../create_sites_for_python_operators.ps1 | 0 .../create_sites_for_python_operators.sh | 0 .../{ => how-to}/custom_operator_example.py | 0 .../user_guide/{ => how-to}/custom_operators.rst | 8 ++++---- .../{ => how-to}/custom_operators_deps.rst | 4 ++-- .../user_guide/{ => how-to}/custom_plugin.xml | 0 .../user_guide/{how_to.rst => how-to/index.rst} | 15 ++------------- .../install_ansys_dpf_core_in_ansys.ps1 | 0 .../install_ansys_dpf_core_in_ansys.sh | 0 doc/source/user_guide/{ => how-to}/plotting.rst | 0 .../user_guide/{ => how-to}/server_context.rst | 0 .../user_guide/{ => how-to}/server_types.rst | 0 .../uninstall_ansys_dpf_core_in_ansys.ps1 | 0 .../uninstall_ansys_dpf_core_in_ansys.sh | 0 doc/source/user_guide/{ => how-to}/xmlfiles.rst | 0 doc/source/user_guide/index.rst | 2 +- 16 files changed, 9 insertions(+), 20 deletions(-) rename doc/source/user_guide/{ => how-to}/create_sites_for_python_operators.ps1 (100%) rename doc/source/user_guide/{ => how-to}/create_sites_for_python_operators.sh (100%) rename doc/source/user_guide/{ => how-to}/custom_operator_example.py (100%) rename doc/source/user_guide/{ => how-to}/custom_operators.rst (97%) rename doc/source/user_guide/{ => how-to}/custom_operators_deps.rst (94%) rename doc/source/user_guide/{ => how-to}/custom_plugin.xml (100%) rename doc/source/user_guide/{how_to.rst => how-to/index.rst} (88%) rename doc/source/user_guide/{ => how-to}/install_ansys_dpf_core_in_ansys.ps1 (100%) rename doc/source/user_guide/{ => how-to}/install_ansys_dpf_core_in_ansys.sh (100%) rename doc/source/user_guide/{ => how-to}/plotting.rst (100%) rename doc/source/user_guide/{ => how-to}/server_context.rst (100%) rename doc/source/user_guide/{ => how-to}/server_types.rst (100%) rename doc/source/user_guide/{ => how-to}/uninstall_ansys_dpf_core_in_ansys.ps1 (100%) rename doc/source/user_guide/{ => how-to}/uninstall_ansys_dpf_core_in_ansys.sh (100%) rename doc/source/user_guide/{ => how-to}/xmlfiles.rst (100%) diff --git a/doc/source/user_guide/create_sites_for_python_operators.ps1 b/doc/source/user_guide/how-to/create_sites_for_python_operators.ps1 similarity index 100% rename from doc/source/user_guide/create_sites_for_python_operators.ps1 rename to doc/source/user_guide/how-to/create_sites_for_python_operators.ps1 diff --git a/doc/source/user_guide/create_sites_for_python_operators.sh b/doc/source/user_guide/how-to/create_sites_for_python_operators.sh similarity index 100% rename from doc/source/user_guide/create_sites_for_python_operators.sh rename to doc/source/user_guide/how-to/create_sites_for_python_operators.sh diff --git a/doc/source/user_guide/custom_operator_example.py b/doc/source/user_guide/how-to/custom_operator_example.py similarity index 100% rename from doc/source/user_guide/custom_operator_example.py rename to doc/source/user_guide/how-to/custom_operator_example.py diff --git a/doc/source/user_guide/custom_operators.rst b/doc/source/user_guide/how-to/custom_operators.rst similarity index 97% rename from doc/source/user_guide/custom_operators.rst rename to doc/source/user_guide/how-to/custom_operators.rst index 1e211bd5b04..3f521303b12 100644 --- a/doc/source/user_guide/custom_operators.rst +++ b/doc/source/user_guide/how-to/custom_operators.rst @@ -34,8 +34,8 @@ installer's Python interpreter. #. Download the script for you operating system: - - For Windows, download this :download:`PowerShell script `. - - For Linux, download this :download:`Shell script ` + - For Windows, download this :download:`PowerShell script `. + - For Linux, download this :download:`Shell script ` #. Run the downloaded script for installing with optional arguments: @@ -48,8 +48,8 @@ If you ever want to uninstall the ``ansys-dpf-core`` module from the Ansys insta #. Download the script for your operating system: - - For Windows, download this :download:`PowerShell script `. - - For Linux, download this :download:`Shell script `. + - For Windows, download this :download:`PowerShell script `. + - For Linux, download this :download:`Shell script `. 3. Run the downloaded script for uninstalling with the optional argument: diff --git a/doc/source/user_guide/custom_operators_deps.rst b/doc/source/user_guide/how-to/custom_operators_deps.rst similarity index 94% rename from doc/source/user_guide/custom_operators_deps.rst rename to doc/source/user_guide/how-to/custom_operators_deps.rst index 754b587947a..9ee680ba8f6 100644 --- a/doc/source/user_guide/custom_operators_deps.rst +++ b/doc/source/user_guide/how-to/custom_operators_deps.rst @@ -23,8 +23,8 @@ For this approach, do the following: #. Download the script for your operating system: - - For Windows, download this :download:`PowerShell script `. - - For Linux, download this :download:`Shell script `. + - For Windows, download this :download:`PowerShell script `. + - For Linux, download this :download:`Shell script `. 3. Run the downloaded script with the mandatory arguments: diff --git a/doc/source/user_guide/custom_plugin.xml b/doc/source/user_guide/how-to/custom_plugin.xml similarity index 100% rename from doc/source/user_guide/custom_plugin.xml rename to doc/source/user_guide/how-to/custom_plugin.xml diff --git a/doc/source/user_guide/how_to.rst b/doc/source/user_guide/how-to/index.rst similarity index 88% rename from doc/source/user_guide/how_to.rst rename to doc/source/user_guide/how-to/index.rst index 8d4247b9328..a4d66bb9775 100644 --- a/doc/source/user_guide/how_to.rst +++ b/doc/source/user_guide/how-to/index.rst @@ -1,18 +1,7 @@ .. _ref_how_to: -How-tos -~~~~~~~ - -.. toctree:: - :hidden: - - plotting.rst - custom_operators.rst - dpf_server.rst - server_types.rst - server_context.rst - xmlfiles.rst - +Accessing and enriching DPF capabilities +---------------------------------------- .. card-carousel:: 2 diff --git a/doc/source/user_guide/install_ansys_dpf_core_in_ansys.ps1 b/doc/source/user_guide/how-to/install_ansys_dpf_core_in_ansys.ps1 similarity index 100% rename from doc/source/user_guide/install_ansys_dpf_core_in_ansys.ps1 rename to doc/source/user_guide/how-to/install_ansys_dpf_core_in_ansys.ps1 diff --git a/doc/source/user_guide/install_ansys_dpf_core_in_ansys.sh b/doc/source/user_guide/how-to/install_ansys_dpf_core_in_ansys.sh similarity index 100% rename from doc/source/user_guide/install_ansys_dpf_core_in_ansys.sh rename to doc/source/user_guide/how-to/install_ansys_dpf_core_in_ansys.sh diff --git a/doc/source/user_guide/plotting.rst b/doc/source/user_guide/how-to/plotting.rst similarity index 100% rename from doc/source/user_guide/plotting.rst rename to doc/source/user_guide/how-to/plotting.rst diff --git a/doc/source/user_guide/server_context.rst b/doc/source/user_guide/how-to/server_context.rst similarity index 100% rename from doc/source/user_guide/server_context.rst rename to doc/source/user_guide/how-to/server_context.rst diff --git a/doc/source/user_guide/server_types.rst b/doc/source/user_guide/how-to/server_types.rst similarity index 100% rename from doc/source/user_guide/server_types.rst rename to doc/source/user_guide/how-to/server_types.rst diff --git a/doc/source/user_guide/uninstall_ansys_dpf_core_in_ansys.ps1 b/doc/source/user_guide/how-to/uninstall_ansys_dpf_core_in_ansys.ps1 similarity index 100% rename from doc/source/user_guide/uninstall_ansys_dpf_core_in_ansys.ps1 rename to doc/source/user_guide/how-to/uninstall_ansys_dpf_core_in_ansys.ps1 diff --git a/doc/source/user_guide/uninstall_ansys_dpf_core_in_ansys.sh b/doc/source/user_guide/how-to/uninstall_ansys_dpf_core_in_ansys.sh similarity index 100% rename from doc/source/user_guide/uninstall_ansys_dpf_core_in_ansys.sh rename to doc/source/user_guide/how-to/uninstall_ansys_dpf_core_in_ansys.sh diff --git a/doc/source/user_guide/xmlfiles.rst b/doc/source/user_guide/how-to/xmlfiles.rst similarity index 100% rename from doc/source/user_guide/xmlfiles.rst rename to doc/source/user_guide/how-to/xmlfiles.rst diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst index 52a24ee0996..8bbb3b39315 100644 --- a/doc/source/user_guide/index.rst +++ b/doc/source/user_guide/index.rst @@ -20,7 +20,7 @@ The goals of this section are to: tutorials/index.rst .. include:: - how_to.rst + how-to/index.rst .. toctree:: From 775f214fac340f10683025aab055222da35347e7 Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Thu, 19 Sep 2024 12:20:07 +0200 Subject: [PATCH 04/16] organise and adapt the troubleshooting section --- doc/source/user_guide/index.rst | 38 +++++++++++++++---- .../user_guide/troubleshooting/index.rst | 36 ++++++++++++++++++ .../{ => troubleshooting}/troubleshooting.rst | 13 ++++++- 3 files changed, 78 insertions(+), 9 deletions(-) create mode 100644 doc/source/user_guide/troubleshooting/index.rst rename doc/source/user_guide/{ => troubleshooting}/troubleshooting.rst (97%) diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst index 8bbb3b39315..640a0eddf2c 100644 --- a/doc/source/user_guide/index.rst +++ b/doc/source/user_guide/index.rst @@ -22,18 +22,42 @@ The goals of this section are to: .. include:: how-to/index.rst +.. include:: + troubleshooting/index.rst + .. toctree:: - :hidden: + :maxdepth: 2 + :hidden: + :caption: Concepts + + concepts/concepts.rst + concepts/waysofusing.rst + concepts/stepbystep.rst - concepts.rst - waysofusing.rst - stepbystep.rst +.. toctree:: + :maxdepth: 2 + :hidden: + :caption: Tutorials + tutorials/model.rst + tutorials/operators.rst + tutorials/fields_container.rst +.. toctree:: + :maxdepth: 2 + :hidden: + :caption: Accessing and enriching DPF capabilities -Troubleshooting -~~~~~~~~~~~~~~~ + how-to/plotting.rst + how-to/custom_operators.rst + how-to/server_context.rst + how-to/server_types.rst + how-to/xmlfiles.rst .. toctree:: - troubleshooting + :maxdepth: 3 + :hidden: + :caption: Troubleshooting + + troubleshooting/troubleshooting.rst diff --git a/doc/source/user_guide/troubleshooting/index.rst b/doc/source/user_guide/troubleshooting/index.rst new file mode 100644 index 00000000000..9629f40ad1f --- /dev/null +++ b/doc/source/user_guide/troubleshooting/index.rst @@ -0,0 +1,36 @@ +.. _ref_troubleshooting_index: + +.. grid:: 2 + + .. grid-item-card:: Server issues + :link: ref_server_issues + :link-type: ref + :text-align: center + + Start the DPF server + + Connect to the DPF server + + Import the ``pydpf-core`` package + + + .. grid-item-card:: Model issues + :link: ref_model_issues + :link-type: ref + :text-align: center + + Invalid UTF-8 error + + .. grid-item-card:: Plotting issues + :link: ref_plotting_issues + :link-type: ref + :text-align: center + + .. grid-item-card:: Performance issues + :link: ref_performance_issues + :link-type: ref + :text-align: center + + Get and set a field's data + + Autocompletion in notebooks diff --git a/doc/source/user_guide/troubleshooting.rst b/doc/source/user_guide/troubleshooting/troubleshooting.rst similarity index 97% rename from doc/source/user_guide/troubleshooting.rst rename to doc/source/user_guide/troubleshooting/troubleshooting.rst index 86fc50f5c2b..b1a6db85276 100644 --- a/doc/source/user_guide/troubleshooting.rst +++ b/doc/source/user_guide/troubleshooting/troubleshooting.rst @@ -1,11 +1,14 @@ .. _user_guide_troubleshooting: -=============== + Troubleshooting -=============== +--------------- + This page explains how to resolve the most common issues encountered when using PyDPF-Core. It also includes suggestions for improving scripts. +.. _ref_server_issues: + Server issues ------------- @@ -38,6 +41,8 @@ If an error lists missing modules, see :ref:`ref_compatibility`. For ``PyDPF-Core``<0.10.0, the `ansys.grpc.dpf `_ module should always be synchronized with its server version. +.. _ref_model_issues: + Model issues ------------ @@ -66,6 +71,8 @@ Then, with result files reproducing this issue, you can prevent the warning from However, the preceding code disables the reading and generation of the available results for the model. Any static results that are available for the model are used instead. +.. _ref_plotting_issues: + Plotting issues --------------- @@ -84,6 +91,8 @@ In that case, simply install `PyVista `_` with this comman Another option is to install PyVista along with PyDPF-Core. For more information, see :ref:`Install with plotting capabilities` +.. _ref_performance_issues: + Performance issues ------------------ From 5fd0d8e7d07b5168bde9138bbae662251d8ae3aa Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Thu, 19 Sep 2024 12:20:07 +0200 Subject: [PATCH 05/16] organise and adapt the troubleshooting section and final sidebar --- doc/source/user_guide/index.rst | 38 +++++++++++++++---- .../user_guide/troubleshooting/index.rst | 36 ++++++++++++++++++ .../{ => troubleshooting}/troubleshooting.rst | 13 ++++++- 3 files changed, 78 insertions(+), 9 deletions(-) create mode 100644 doc/source/user_guide/troubleshooting/index.rst rename doc/source/user_guide/{ => troubleshooting}/troubleshooting.rst (97%) diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst index 8bbb3b39315..640a0eddf2c 100644 --- a/doc/source/user_guide/index.rst +++ b/doc/source/user_guide/index.rst @@ -22,18 +22,42 @@ The goals of this section are to: .. include:: how-to/index.rst +.. include:: + troubleshooting/index.rst + .. toctree:: - :hidden: + :maxdepth: 2 + :hidden: + :caption: Concepts + + concepts/concepts.rst + concepts/waysofusing.rst + concepts/stepbystep.rst - concepts.rst - waysofusing.rst - stepbystep.rst +.. toctree:: + :maxdepth: 2 + :hidden: + :caption: Tutorials + tutorials/model.rst + tutorials/operators.rst + tutorials/fields_container.rst +.. toctree:: + :maxdepth: 2 + :hidden: + :caption: Accessing and enriching DPF capabilities -Troubleshooting -~~~~~~~~~~~~~~~ + how-to/plotting.rst + how-to/custom_operators.rst + how-to/server_context.rst + how-to/server_types.rst + how-to/xmlfiles.rst .. toctree:: - troubleshooting + :maxdepth: 3 + :hidden: + :caption: Troubleshooting + + troubleshooting/troubleshooting.rst diff --git a/doc/source/user_guide/troubleshooting/index.rst b/doc/source/user_guide/troubleshooting/index.rst new file mode 100644 index 00000000000..9629f40ad1f --- /dev/null +++ b/doc/source/user_guide/troubleshooting/index.rst @@ -0,0 +1,36 @@ +.. _ref_troubleshooting_index: + +.. grid:: 2 + + .. grid-item-card:: Server issues + :link: ref_server_issues + :link-type: ref + :text-align: center + + Start the DPF server + + Connect to the DPF server + + Import the ``pydpf-core`` package + + + .. grid-item-card:: Model issues + :link: ref_model_issues + :link-type: ref + :text-align: center + + Invalid UTF-8 error + + .. grid-item-card:: Plotting issues + :link: ref_plotting_issues + :link-type: ref + :text-align: center + + .. grid-item-card:: Performance issues + :link: ref_performance_issues + :link-type: ref + :text-align: center + + Get and set a field's data + + Autocompletion in notebooks diff --git a/doc/source/user_guide/troubleshooting.rst b/doc/source/user_guide/troubleshooting/troubleshooting.rst similarity index 97% rename from doc/source/user_guide/troubleshooting.rst rename to doc/source/user_guide/troubleshooting/troubleshooting.rst index 86fc50f5c2b..b1a6db85276 100644 --- a/doc/source/user_guide/troubleshooting.rst +++ b/doc/source/user_guide/troubleshooting/troubleshooting.rst @@ -1,11 +1,14 @@ .. _user_guide_troubleshooting: -=============== + Troubleshooting -=============== +--------------- + This page explains how to resolve the most common issues encountered when using PyDPF-Core. It also includes suggestions for improving scripts. +.. _ref_server_issues: + Server issues ------------- @@ -38,6 +41,8 @@ If an error lists missing modules, see :ref:`ref_compatibility`. For ``PyDPF-Core``<0.10.0, the `ansys.grpc.dpf `_ module should always be synchronized with its server version. +.. _ref_model_issues: + Model issues ------------ @@ -66,6 +71,8 @@ Then, with result files reproducing this issue, you can prevent the warning from However, the preceding code disables the reading and generation of the available results for the model. Any static results that are available for the model are used instead. +.. _ref_plotting_issues: + Plotting issues --------------- @@ -84,6 +91,8 @@ In that case, simply install `PyVista `_` with this comman Another option is to install PyVista along with PyDPF-Core. For more information, see :ref:`Install with plotting capabilities` +.. _ref_performance_issues: + Performance issues ------------------ From d263baf01bdff88ea964126168386f4b32d9885a Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Thu, 19 Sep 2024 14:55:39 +0200 Subject: [PATCH 06/16] changes in the troubleshooting index page --- doc/source/user_guide/index.rst | 7 +++++-- doc/source/user_guide/troubleshooting/index.rst | 16 +++++++++++----- 2 files changed, 16 insertions(+), 7 deletions(-) diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst index 640a0eddf2c..08e4862b451 100644 --- a/doc/source/user_guide/index.rst +++ b/doc/source/user_guide/index.rst @@ -56,8 +56,11 @@ The goals of this section are to: how-to/xmlfiles.rst .. toctree:: - :maxdepth: 3 + :maxdepth: 2 :hidden: :caption: Troubleshooting - troubleshooting/troubleshooting.rst + Server issues + Model issues + `Plotting issues ` + `Performance issues ` diff --git a/doc/source/user_guide/troubleshooting/index.rst b/doc/source/user_guide/troubleshooting/index.rst index 9629f40ad1f..6556d0d7ab3 100644 --- a/doc/source/user_guide/troubleshooting/index.rst +++ b/doc/source/user_guide/troubleshooting/index.rst @@ -1,34 +1,40 @@ .. _ref_troubleshooting_index: -.. grid:: 2 +Troubleshooting +--------------- + +.. grid:: 3 .. grid-item-card:: Server issues :link: ref_server_issues :link-type: ref + :width: 25% :text-align: center Start the DPF server Connect to the DPF server - Import the ``pydpf-core`` package - + Import the pydpf-core package .. grid-item-card:: Model issues :link: ref_model_issues :link-type: ref + :width: 25% :text-align: center Invalid UTF-8 error - .. grid-item-card:: Plotting issues + .. grid-item-card:: Plotting issues :link: ref_plotting_issues :link-type: ref + :width: 25% :text-align: center - .. grid-item-card:: Performance issues + .. grid-item-card:: Performance issues :link: ref_performance_issues :link-type: ref + :width: 25% :text-align: center Get and set a field's data From 2ea779fb045d34bfb953de97614b561104eed330 Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Thu, 19 Sep 2024 15:01:31 +0200 Subject: [PATCH 07/16] changes in the how to index page --- doc/source/user_guide/how-to/index.rst | 25 +++++++------------------ 1 file changed, 7 insertions(+), 18 deletions(-) diff --git a/doc/source/user_guide/how-to/index.rst b/doc/source/user_guide/how-to/index.rst index a4d66bb9775..e5ae80be7c8 100644 --- a/doc/source/user_guide/how-to/index.rst +++ b/doc/source/user_guide/how-to/index.rst @@ -3,19 +3,9 @@ Accessing and enriching DPF capabilities ---------------------------------------- -.. card-carousel:: 2 +.. grid:: 3 - .. card:: Plot - :link: user_guide_plotting - :link-type: ref - :width: 25% - :text-align: center - - .. image:: ../images/plotting/pontoon.png - .. image:: ../images/plotting/pontoon_strain.png - - - .. card:: Create custom operators + .. grid-item-card:: Create custom operators :link: user_guide_custom_operators :link-type: ref :width: 25% @@ -25,7 +15,7 @@ Accessing and enriching DPF capabilities :width: 50% - .. card:: Use DPF Server package + .. grid-item-card:: Use DPF Server package :link: ref_dpf_server :link-type: ref :width: 25% @@ -34,9 +24,7 @@ Accessing and enriching DPF capabilities .. image:: ../images/drawings/dpf_server_client.png -.. card-carousel:: 2 - - .. card:: Switch between local and remote server + .. grid-item-card:: Switch between local and remote server :link: user_guide_server_types :link-type: ref :width: 25% @@ -44,7 +32,8 @@ Accessing and enriching DPF capabilities .. image:: ../images/drawings/remote_machines.png - .. card:: Access Entry and Premium capabilities + + .. grid-item-card:: Access Entry and Premium capabilities :link: user_guide_server_context :link-type: ref :width: 25% @@ -53,7 +42,7 @@ Accessing and enriching DPF capabilities .. image:: ../images/drawings/entry_premium.png - .. card:: Use DPF XML Files + .. grid-item-card:: Use DPF XML Files :link: user_guide_xmlfiles :link-type: ref :width: 25% From 1d0e5947b133a01f4781c8061a304c5e1bcd3041 Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Thu, 19 Sep 2024 15:02:42 +0200 Subject: [PATCH 08/16] changes in the concepts index page --- doc/source/user_guide/concepts/index.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/source/user_guide/concepts/index.rst b/doc/source/user_guide/concepts/index.rst index a2ef15163c9..0e625c64b57 100644 --- a/doc/source/user_guide/concepts/index.rst +++ b/doc/source/user_guide/concepts/index.rst @@ -3,9 +3,9 @@ Concepts -------- -.. card-carousel:: 2 +.. grid:: 3 - .. card:: Concepts and terminology + .. grid-item-card:: Concepts and terminology :link: user_guide_concepts :link-type: ref :width: 25% @@ -13,7 +13,7 @@ Concepts .. image:: ../images/drawings/book-logo.png - .. card:: Ways of using DPF + .. grid-item-card:: Ways of using DPF :link: user_guide_waysofusing :link-type: ref :width: 25% @@ -21,10 +21,10 @@ Concepts .. image:: ../images/drawings/using-dpf.png - .. card:: Using DPF: Step by step + .. grid-item-card:: Using DPF: Step by step :link: user_guide_stepbystep :link-type: ref :width: 25% :text-align: center - .. image:: ../images/drawings/checklist.png + .. image:: ../images/drawings/checklist.png \ No newline at end of file From 199eb1c1e81de50196b6cefe3a26bd97e7043886 Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Thu, 19 Sep 2024 16:18:37 +0200 Subject: [PATCH 09/16] changes in the layout of the index pages --- doc/source/user_guide/concepts/index.rst | 4 +--- doc/source/user_guide/how-to/index.rst | 6 +----- doc/source/user_guide/index.rst | 7 ++----- doc/source/user_guide/troubleshooting/index.rst | 5 +---- .../troubleshooting/troubleshooting.rst | 16 ++++++++++------ 5 files changed, 15 insertions(+), 23 deletions(-) diff --git a/doc/source/user_guide/concepts/index.rst b/doc/source/user_guide/concepts/index.rst index 0e625c64b57..92bd2d63ad8 100644 --- a/doc/source/user_guide/concepts/index.rst +++ b/doc/source/user_guide/concepts/index.rst @@ -4,11 +4,11 @@ Concepts -------- .. grid:: 3 + :gutter: 2 .. grid-item-card:: Concepts and terminology :link: user_guide_concepts :link-type: ref - :width: 25% :text-align: center .. image:: ../images/drawings/book-logo.png @@ -16,7 +16,6 @@ Concepts .. grid-item-card:: Ways of using DPF :link: user_guide_waysofusing :link-type: ref - :width: 25% :text-align: center .. image:: ../images/drawings/using-dpf.png @@ -24,7 +23,6 @@ Concepts .. grid-item-card:: Using DPF: Step by step :link: user_guide_stepbystep :link-type: ref - :width: 25% :text-align: center .. image:: ../images/drawings/checklist.png \ No newline at end of file diff --git a/doc/source/user_guide/how-to/index.rst b/doc/source/user_guide/how-to/index.rst index e5ae80be7c8..7b2906af745 100644 --- a/doc/source/user_guide/how-to/index.rst +++ b/doc/source/user_guide/how-to/index.rst @@ -4,11 +4,11 @@ Accessing and enriching DPF capabilities ---------------------------------------- .. grid:: 3 + :gutter: 2 .. grid-item-card:: Create custom operators :link: user_guide_custom_operators :link-type: ref - :width: 25% :text-align: center .. image:: ../images/drawings/plugin-logo.png @@ -18,7 +18,6 @@ Accessing and enriching DPF capabilities .. grid-item-card:: Use DPF Server package :link: ref_dpf_server :link-type: ref - :width: 25% :text-align: center .. image:: ../images/drawings/dpf_server_client.png @@ -27,7 +26,6 @@ Accessing and enriching DPF capabilities .. grid-item-card:: Switch between local and remote server :link: user_guide_server_types :link-type: ref - :width: 25% :text-align: center .. image:: ../images/drawings/remote_machines.png @@ -36,7 +34,6 @@ Accessing and enriching DPF capabilities .. grid-item-card:: Access Entry and Premium capabilities :link: user_guide_server_context :link-type: ref - :width: 25% :text-align: center .. image:: ../images/drawings/entry_premium.png @@ -45,7 +42,6 @@ Accessing and enriching DPF capabilities .. grid-item-card:: Use DPF XML Files :link: user_guide_xmlfiles :link-type: ref - :width: 25% :text-align: center .. image:: ../images/drawings/xml.png \ No newline at end of file diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst index 08e4862b451..ff029ab7f54 100644 --- a/doc/source/user_guide/index.rst +++ b/doc/source/user_guide/index.rst @@ -56,11 +56,8 @@ The goals of this section are to: how-to/xmlfiles.rst .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :hidden: :caption: Troubleshooting - Server issues - Model issues - `Plotting issues ` - `Performance issues ` + troubleshooting/troubleshooting.rst diff --git a/doc/source/user_guide/troubleshooting/index.rst b/doc/source/user_guide/troubleshooting/index.rst index d657cbc7a9e..ee6250df72c 100644 --- a/doc/source/user_guide/troubleshooting/index.rst +++ b/doc/source/user_guide/troubleshooting/index.rst @@ -4,11 +4,11 @@ Troubleshooting --------------- .. grid:: 3 + :gutter: 2 .. grid-item-card:: Server issues :link: ref_server_issues :link-type: ref - :width: 25% :text-align: center Start the DPF server @@ -20,7 +20,6 @@ Troubleshooting .. grid-item-card:: Model issues :link: ref_model_issues :link-type: ref - :width: 25% :text-align: center Invalid UTF-8 error @@ -28,13 +27,11 @@ Troubleshooting .. grid-item-card:: Plotting issues :link: ref_plotting_issues :link-type: ref - :width: 25% :text-align: center .. grid-item-card:: Performance issues :link: ref_performance_issues :link-type: ref - :width: 25% :text-align: center Get and set a field's data diff --git a/doc/source/user_guide/troubleshooting/troubleshooting.rst b/doc/source/user_guide/troubleshooting/troubleshooting.rst index b1a6db85276..8b2edc150d8 100644 --- a/doc/source/user_guide/troubleshooting/troubleshooting.rst +++ b/doc/source/user_guide/troubleshooting/troubleshooting.rst @@ -1,16 +1,17 @@ .. _user_guide_troubleshooting: - +=============== Troubleshooting ---------------- +=============== This page explains how to resolve the most common issues encountered when using PyDPF-Core. It also includes suggestions for improving scripts. .. _ref_server_issues: +============== Server issues -------------- +============== Start the DPF server ~~~~~~~~~~~~~~~~~~~~~ @@ -43,8 +44,9 @@ should always be synchronized with its server version. .. _ref_model_issues: +============ Model issues ------------- +============ Invalid UTF-8 error ~~~~~~~~~~~~~~~~~~~ @@ -73,8 +75,9 @@ Any static results that are available for the model are used instead. .. _ref_plotting_issues: +=============== Plotting issues ---------------- +=============== When trying to plot a result with DPF, the following error might be raised: @@ -93,8 +96,9 @@ Another option is to install PyVista along with PyDPF-Core. For more information .. _ref_performance_issues: +================== Performance issues ------------------- +================== Get and set a field's data ~~~~~~~~~~~~~~~~~~~~~~~~~~ From 7427c547f23adeb5051e8a1673fc913063b3babf Mon Sep 17 00:00:00 2001 From: Luisa Felix Salles Date: Fri, 20 Sep 2024 11:48:57 +0200 Subject: [PATCH 10/16] Apply suggestions from code review Co-authored-by: Paul Profizi <100710998+PProfizi@users.noreply.github.com> --- doc/source/user_guide/how-to/index.rst | 4 ++-- doc/source/user_guide/tutorials/index.rst | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/source/user_guide/how-to/index.rst b/doc/source/user_guide/how-to/index.rst index 7b2906af745..c06f10ca745 100644 --- a/doc/source/user_guide/how-to/index.rst +++ b/doc/source/user_guide/how-to/index.rst @@ -1,6 +1,6 @@ .. _ref_how_to: -Accessing and enriching DPF capabilities +Enriching DPF capabilities ---------------------------------------- .. grid:: 3 @@ -39,7 +39,7 @@ Accessing and enriching DPF capabilities .. image:: ../images/drawings/entry_premium.png - .. grid-item-card:: Use DPF XML Files + .. grid-item-card:: Configure DPF plugins load :link: user_guide_xmlfiles :link-type: ref :text-align: center diff --git a/doc/source/user_guide/tutorials/index.rst b/doc/source/user_guide/tutorials/index.rst index 905f5831385..3f37b45466c 100644 --- a/doc/source/user_guide/tutorials/index.rst +++ b/doc/source/user_guide/tutorials/index.rst @@ -4,12 +4,12 @@ Tutorials --------- -The following tutorials shows in details how to use basic features of PyDPF-Core +The following tutorials show in details how to use basic features of PyDPF-Core for each usage main step. :bdg-dark-line:`Define simulation data` :octicon:`arrow-right;1em` :bdg-dark-line:`Store input data in DPF` :octicon:`arrow-right;1em` :bdg-dark-line:`Transform available data` :octicon:`arrow-right;1em` :bdg-dark-line:`Extract data` -**Define simulation data** +**Define input data** .. grid:: 3 @@ -62,7 +62,7 @@ for each usage main step. MeshContainer -**Transform available data** +**Transform data** .. grid:: 3 From 880cebad8ad6c0927c25846efe9f5d533afd3ca4 Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Fri, 20 Sep 2024 14:26:54 +0200 Subject: [PATCH 11/16] corrections after first revision --- doc/source/user_guide/how-to/index.rst | 8 -------- doc/source/user_guide/index.rst | 4 +++- doc/source/user_guide/{how-to => tutorials}/plotting.rst | 0 3 files changed, 3 insertions(+), 9 deletions(-) rename doc/source/user_guide/{how-to => tutorials}/plotting.rst (100%) diff --git a/doc/source/user_guide/how-to/index.rst b/doc/source/user_guide/how-to/index.rst index c06f10ca745..517377b5b05 100644 --- a/doc/source/user_guide/how-to/index.rst +++ b/doc/source/user_guide/how-to/index.rst @@ -13,14 +13,6 @@ Enriching DPF capabilities .. image:: ../images/drawings/plugin-logo.png :width: 50% - - - .. grid-item-card:: Use DPF Server package - :link: ref_dpf_server - :link-type: ref - :text-align: center - - .. image:: ../images/drawings/dpf_server_client.png .. grid-item-card:: Switch between local and remote server diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst index ff029ab7f54..62aded18f0a 100644 --- a/doc/source/user_guide/index.rst +++ b/doc/source/user_guide/index.rst @@ -11,7 +11,9 @@ computation, customization, and remote postprocessing accessible in Python. The goals of this section are to: - Describe the most-used DPF entities and how they can help you to access and modify solver data. - - Provide simple how-tos for tackling the most common use cases. + - Provide simple tutorials for tackling the most common use cases. + - Explain how to customize DPF behavior + - Present some systematic approaches to determine the cause of a malfunction or failure when using DPF .. include:: concepts/index.rst diff --git a/doc/source/user_guide/how-to/plotting.rst b/doc/source/user_guide/tutorials/plotting.rst similarity index 100% rename from doc/source/user_guide/how-to/plotting.rst rename to doc/source/user_guide/tutorials/plotting.rst From c94293b216ca91f619b1efe62cdddd0b4c3c6860 Mon Sep 17 00:00:00 2001 From: Luisa Felix Salles Date: Fri, 20 Sep 2024 14:38:16 +0200 Subject: [PATCH 12/16] Apply suggestions from code review Co-authored-by: Paul Profizi <100710998+PProfizi@users.noreply.github.com> --- doc/source/user_guide/how-to/index.rst | 2 +- doc/source/user_guide/tutorials/index.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/user_guide/how-to/index.rst b/doc/source/user_guide/how-to/index.rst index 517377b5b05..821a728ae17 100644 --- a/doc/source/user_guide/how-to/index.rst +++ b/doc/source/user_guide/how-to/index.rst @@ -6,7 +6,7 @@ Enriching DPF capabilities .. grid:: 3 :gutter: 2 - .. grid-item-card:: Create custom operators + .. grid-item-card:: Create custom operators and plugins :link: user_guide_custom_operators :link-type: ref :text-align: center diff --git a/doc/source/user_guide/tutorials/index.rst b/doc/source/user_guide/tutorials/index.rst index 3f37b45466c..6a9e3500431 100644 --- a/doc/source/user_guide/tutorials/index.rst +++ b/doc/source/user_guide/tutorials/index.rst @@ -24,7 +24,7 @@ for each usage main step. :link-type: ref :text-align: center -**Store input data in DPF** +**Load data** .. grid:: 3 From 2f265933d66f59b84ad1aee079941adabc62c576 Mon Sep 17 00:00:00 2001 From: Paul Profizi <100710998+PProfizi@users.noreply.github.com> Date: Fri, 20 Sep 2024 19:20:28 +0200 Subject: [PATCH 13/16] Add sphinx-exec-code to doc requirements --- requirements/requirements_docs.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/requirements/requirements_docs.txt b/requirements/requirements_docs.txt index df5b2a087a5..3b8158ba8ad 100644 --- a/requirements/requirements_docs.txt +++ b/requirements/requirements_docs.txt @@ -10,6 +10,7 @@ pyvista==0.44.1 sphinx==7.1.0 sphinx-autobuild==2024.2.4 sphinx-copybutton==0.5.2 +sphinx-exec-code==0.12 sphinx-gallery==0.17.0 sphinx-notfound-page==1.0.4 sphinx-reredirects==0.1.3 From 869c6f3f5824b37057d5d831f7576988188b3a69 Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Mon, 23 Sep 2024 14:54:29 +0200 Subject: [PATCH 14/16] corrections files path --- doc/source/user_guide/concepts/concepts.rst | 8 ++++---- doc/source/user_guide/concepts/stepbystep.rst | 18 +++++++++--------- doc/source/user_guide/concepts/waysofusing.rst | 6 +++--- .../02-python_operators_with_dependencies.py | 6 ++++-- 4 files changed, 20 insertions(+), 18 deletions(-) diff --git a/doc/source/user_guide/concepts/concepts.rst b/doc/source/user_guide/concepts/concepts.rst index f7bba20fc9c..c2b9bb3ac27 100644 --- a/doc/source/user_guide/concepts/concepts.rst +++ b/doc/source/user_guide/concepts/concepts.rst @@ -67,7 +67,7 @@ Concept summary --------------- This image summarizes the preceding concepts: -.. image:: ../images/drawings/field-breakdown.png +.. image:: ../../images/drawings/field-breakdown.png Operators @@ -79,7 +79,7 @@ You use :ref:`ref_dpf_operators_reference` to create, transform, and stream the - The input and output pins, like those in an integrated circuit in electronics, submit data to the operator and output the computed result from the operator. -.. image:: ../images/drawings/OperatorPins.png +.. image:: ../../images/drawings/OperatorPins.png Workflows --------- @@ -90,10 +90,10 @@ to operators, which computes requested outputs. Think of a workflow as a black box in which some operators are chained, computing the information for which the workflow is made: -.. image:: ../images/drawings/Workflow1.png +.. image:: ../../images/drawings/Workflow1.png The following image shows operators that have been chained together to create a total deformation workflow. You can use this workflow in any simulation workflow with any data sources as inputs. -.. image:: ../images/drawings/Workflow2.png +.. image:: ../../images/drawings/Workflow2.png diff --git a/doc/source/user_guide/concepts/stepbystep.rst b/doc/source/user_guide/concepts/stepbystep.rst index 1c72c53db84..55b9caad74c 100644 --- a/doc/source/user_guide/concepts/stepbystep.rst +++ b/doc/source/user_guide/concepts/stepbystep.rst @@ -53,11 +53,11 @@ Define fields A **field** is a container of simulation data. In numerical simulations, result data is defined by values associated with entities: -.. image:: ../images/drawings/values-entities.png +.. image:: ../../images/drawings/values-entities.png Therefore, a field of data might look something like this: -.. image:: ../images/drawings/field.png +.. image:: ../../images/drawings/field.png This code shows how to define a field from scratch: @@ -83,7 +83,7 @@ be a set of mesh IDs, geometric entity IDs, time domain, or frequency domain. You specify the set of entities by defining a range of IDs: -.. image:: ../images/drawings/scoping-eg.png +.. image:: ../../images/drawings/scoping-eg.png You must define a scoping prior to its use in the transformation data workflow. @@ -109,13 +109,13 @@ A **field container** holds a set of fields. It is used mainly for transient, harmonic, modal, or multi-step analyses. This image explains its structure: -.. image:: ../images/drawings/field-con-overview.png +.. image:: ../../images/drawings/field-con-overview.png A field container is a vector of fields. Fields are ordered with labels and IDs. Most commonly, a field container is scoped on the time label, and the IDs are the time or frequency sets: -.. image:: ../images/drawings/field-con.png +.. image:: ../../images/drawings/field-con.png You can define a field container in multiple ways: @@ -162,14 +162,14 @@ An operator takes input from a field, field container, or scoping using an input pin. Based on what it is designed to do, the operator computes an output that it passes to a field or field container using an output pin. -.. image:: ../images/drawings/circuit.png +.. image:: ../../images/drawings/circuit.png Comprehensive information on operators is available in :ref:`ref_dpf_operators_reference`. In the **Available Operators** area for either the **Entry** or **Premium** operators, you can either type a keyword in the **Search** option or browse by operator categories: -.. image:: ../images/drawings/help-operators.png +.. image:: ../../images/drawings/help-operators.png The page for each operator describes how the operator transforms data, indicates input and output data, and provides usage examples. @@ -185,7 +185,7 @@ Defining an operator consists of three steps: This image shows how the page for an operator provides a usage example for each available language (IronPython, CPython, and C++). -.. image:: ../images/drawings/operator-def.png +.. image:: ../../images/drawings/operator-def.png This code shows how to define an operator from a model: @@ -210,7 +210,7 @@ the input to another operator. This image shows how you would get the norm of a resulting vector from the dot product of two vectors: -.. image:: ../images/drawings/connect-operators.png +.. image:: ../../images/drawings/connect-operators.png This code shows how to define a generic workflow that computes the minimum of displacement by chaining the ``U`` and ``min_max_fc`` operators: diff --git a/doc/source/user_guide/concepts/waysofusing.rst b/doc/source/user_guide/concepts/waysofusing.rst index 25077c38daf..4887669f38c 100644 --- a/doc/source/user_guide/concepts/waysofusing.rst +++ b/doc/source/user_guide/concepts/waysofusing.rst @@ -29,7 +29,7 @@ enabled using the DPF Server application. These capabilities can be accessed through client APIs, as shown here: -.. image:: ../images/drawings/apis_2.png +.. image:: ../../images/drawings/apis_2.png 1. DPF server application can be accessed using Ansys Inc product, or DPF Server package (see :ref:`ref_dpf_server`) available on the Customer portal. @@ -71,7 +71,7 @@ files. You can use it to generate TH-plots, screenshots, and animations or to create custom result plots using the `numpy `_ and `matplotlib `_ packages. -.. image:: ../images/drawings/dpf-reports.png +.. image:: ../../images/drawings/dpf-reports.png Mechanical ~~~~~~~~~~ @@ -79,4 +79,4 @@ Mechanical Use it to perform custom postprocessing and visualization of results directly within the Mechanical application. -.. image:: ../images/drawings/dpf-mech.png \ No newline at end of file +.. image:: ../../images/drawings/dpf-mech.png \ No newline at end of file diff --git a/examples/08-python-operators/02-python_operators_with_dependencies.py b/examples/08-python-operators/02-python_operators_with_dependencies.py index f88d9e4a80b..da55847e4d7 100644 --- a/examples/08-python-operators/02-python_operators_with_dependencies.py +++ b/examples/08-python-operators/02-python_operators_with_dependencies.py @@ -123,9 +123,9 @@ # Download the script for your operating system. # # - For Windows, download this -# :download:`PowerShell script `. +# :download:`PowerShell script `. # - For Linux, download this -# :download:`Shell script `. +# :download:`Shell script `. # # Run the downloaded script with the mandatory arguments: # @@ -157,6 +157,7 @@ "doc", "source", "user_guide", + "how-to", "create_sites_for_python_operators.ps1", ) args = [ @@ -189,6 +190,7 @@ "doc", "source", "user_guide", + "how-to", "create_sites_for_python_operators.sh", ) run_cmd = f"{cmd_file}" From 5d1e881193b9cec5a644a687a87e34ff6be523ca Mon Sep 17 00:00:00 2001 From: Luisa Felix Salles Date: Tue, 24 Sep 2024 14:51:35 +0200 Subject: [PATCH 15/16] Apply suggestions from code review Co-authored-by: Paul Profizi <100710998+PProfizi@users.noreply.github.com> --- doc/source/user_guide/tutorials/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/user_guide/tutorials/index.rst b/doc/source/user_guide/tutorials/index.rst index 6a9e3500431..5e3d5f9fc52 100644 --- a/doc/source/user_guide/tutorials/index.rst +++ b/doc/source/user_guide/tutorials/index.rst @@ -76,7 +76,7 @@ for each usage main step. Workflow - .. grid-item-card:: Results visualisation + .. grid-item-card:: Results visualization :link: ref_tutorials_model :link-type: ref :text-align: center @@ -90,7 +90,7 @@ for each usage main step. .. grid:: 3 - .. grid-item-card:: Serialisation + .. grid-item-card:: Serialization :link: ref_tutorials_model :link-type: ref :text-align: center \ No newline at end of file From 783c9c9586034049221f926d7561bcf439cf9ba9 Mon Sep 17 00:00:00 2001 From: Luisa Felix Salles Date: Tue, 24 Sep 2024 14:52:59 +0200 Subject: [PATCH 16/16] Apply suggestions from code review Co-authored-by: Paul Profizi <100710998+PProfizi@users.noreply.github.com> --- doc/source/user_guide/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst index 62aded18f0a..2095c6699c5 100644 --- a/doc/source/user_guide/index.rst +++ b/doc/source/user_guide/index.rst @@ -12,8 +12,8 @@ The goals of this section are to: - Describe the most-used DPF entities and how they can help you to access and modify solver data. - Provide simple tutorials for tackling the most common use cases. - - Explain how to customize DPF behavior - - Present some systematic approaches to determine the cause of a malfunction or failure when using DPF + - Explain how to customize DPF behavior. + - Present some systematic approaches to determine the cause of a malfunction or failure when using DPF. .. include:: concepts/index.rst