From 4db73e89c800c34a66825a516dd2351b0e2a6539 Mon Sep 17 00:00:00 2001 From: lparadis Date: Wed, 8 Feb 2023 12:06:38 +0100 Subject: [PATCH 1/5] Update --- docs/source/user_guide/xmlfiles.rst | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/source/user_guide/xmlfiles.rst b/docs/source/user_guide/xmlfiles.rst index d9a3028d584..a33a9e43301 100644 --- a/docs/source/user_guide/xmlfiles.rst +++ b/docs/source/user_guide/xmlfiles.rst @@ -80,20 +80,23 @@ where ``###`` is the three-digit format for the installed version. For example, on Windows, the path for the root folder for Ansys 2022 R2 likely ends with ``\ANSYS Inc\v222``. -The ``ANSYS_ROOT_FOLDER`` element is like an environment variable. You can use -this element in other XML files. For example, you might use it to find required +The ``ANSYS_ROOT_FOLDER`` element defines a variable like an environment variable +that can be used in the other XML files. For example, you might use it to find required third-party software. If the ``ANSYS_ROOT_FOLDER`` element is not defined in the ``DataProcessing.xml`` -file, the root folder is determined by reading the ``AWP_ROOT###`` environment -variable specific to your installed Ansys version. For example, if you are -using Ansys 2022 R2, it looks for ``AWP_ROOT222`` to find the root folder. - -If the ``ANSYS_ROOT_FOLDER`` element is still not defined, an attempt is made to +file, an attempt is made to find the root folder relative to the ``DataProcessingCore`` DLL or SO file. This works only if the ``DataProcessingCore.xml`` file is located in its default location. +If the ``ANSYS_ROOT_FOLDER`` element is still not defined, the root folder is +determined by reading the ``AWP_ROOT###`` environment variable specific to your +installed Ansys version. For example, if you are using Ansys 2022 R2, it looks +for ``AWP_ROOT222`` to find the root folder. + +ANSYS_ROOT_FOLDER is not an environment variable and can not be set accordingly. + ```` element ~~~~~~~~~~~~~~~~~~~~~~~~~~~ The ```` element defines the plugins to load. The ```` or From 1c8b02c18ea238d820f23fde6e88ff1a6c355721 Mon Sep 17 00:00:00 2001 From: anslpa <74727146+anslpa@users.noreply.github.com> Date: Wed, 8 Feb 2023 14:46:11 +0100 Subject: [PATCH 2/5] Update docs/source/user_guide/xmlfiles.rst Co-authored-by: PProfizi <100710998+PProfizi@users.noreply.github.com> --- docs/source/user_guide/xmlfiles.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/user_guide/xmlfiles.rst b/docs/source/user_guide/xmlfiles.rst index a33a9e43301..ad958a05dcd 100644 --- a/docs/source/user_guide/xmlfiles.rst +++ b/docs/source/user_guide/xmlfiles.rst @@ -93,7 +93,7 @@ location. If the ``ANSYS_ROOT_FOLDER`` element is still not defined, the root folder is determined by reading the ``AWP_ROOT###`` environment variable specific to your installed Ansys version. For example, if you are using Ansys 2022 R2, it looks -for ``AWP_ROOT222`` to find the root folder. +for the ``AWP_ROOT222`` environment variable to find the root folder. ANSYS_ROOT_FOLDER is not an environment variable and can not be set accordingly. From 0cfeafcbdb14dc3aaa570e5fc1d9eea8a5222c7d Mon Sep 17 00:00:00 2001 From: lparadis Date: Wed, 8 Feb 2023 15:01:49 +0100 Subject: [PATCH 3/5] Update --- docs/source/user_guide/xmlfiles.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/user_guide/xmlfiles.rst b/docs/source/user_guide/xmlfiles.rst index a33a9e43301..bcabd48ffed 100644 --- a/docs/source/user_guide/xmlfiles.rst +++ b/docs/source/user_guide/xmlfiles.rst @@ -80,7 +80,7 @@ where ``###`` is the three-digit format for the installed version. For example, on Windows, the path for the root folder for Ansys 2022 R2 likely ends with ``\ANSYS Inc\v222``. -The ``ANSYS_ROOT_FOLDER`` element defines a variable like an environment variable +The ``ANSYS_ROOT_FOLDER`` element defines a variable that can be used in the other XML files. For example, you might use it to find required third-party software. From 3985af402bed87acfc0c31cad0be67dc0e038a2c Mon Sep 17 00:00:00 2001 From: anslpa <74727146+anslpa@users.noreply.github.com> Date: Thu, 9 Feb 2023 08:37:47 +0100 Subject: [PATCH 4/5] Update docs/source/user_guide/xmlfiles.rst Co-authored-by: JennaPaikowsky <98607744+JennaPaikowsky@users.noreply.github.com> --- docs/source/user_guide/xmlfiles.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/user_guide/xmlfiles.rst b/docs/source/user_guide/xmlfiles.rst index b7dea34f6eb..1df8b0e0c65 100644 --- a/docs/source/user_guide/xmlfiles.rst +++ b/docs/source/user_guide/xmlfiles.rst @@ -95,7 +95,7 @@ determined by reading the ``AWP_ROOT###`` environment variable specific to your installed Ansys version. For example, if you are using Ansys 2022 R2, it looks for the ``AWP_ROOT222`` environment variable to find the root folder. -ANSYS_ROOT_FOLDER is not an environment variable and can not be set accordingly. +ANSYS_ROOT_FOLDER is not an environment variable and cannot be set accordingly. ```` element ~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 665acd43f0f30869c0fe7b36a13294e0caec7d03 Mon Sep 17 00:00:00 2001 From: lparadis Date: Thu, 9 Feb 2023 08:39:03 +0100 Subject: [PATCH 5/5] Update --- docs/source/user_guide/xmlfiles.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/user_guide/xmlfiles.rst b/docs/source/user_guide/xmlfiles.rst index b7dea34f6eb..ee587de0fdd 100644 --- a/docs/source/user_guide/xmlfiles.rst +++ b/docs/source/user_guide/xmlfiles.rst @@ -106,7 +106,7 @@ in the child elements. The ```` element defines DPF native operators. The further subdividing of plugins into ```` or ```` elements is optional. The ```` element, for example, would only be used with a debug version of the -``DataProcessingCore DLL/SO`` file. +``DataProcessingCore`` DLL or SO file. The element names for plugins, such as ```` and ````, are used as **keys** when loading plugins. Each plugin must have a unique key.