Skip to content

Commit 4500bd7

Browse files
anslpaPProfiziJennaPaikowsky
authored
Documentation (dpf.docs): ANSYS_ROOT_FOLDER is not an environment variable (#791)
* Update * Update docs/source/user_guide/xmlfiles.rst Co-authored-by: PProfizi <[email protected]> * Update * Update docs/source/user_guide/xmlfiles.rst Co-authored-by: JennaPaikowsky <[email protected]> * Update --------- Co-authored-by: PProfizi <[email protected]> Co-authored-by: JennaPaikowsky <[email protected]>
1 parent 911dc9a commit 4500bd7

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

docs/source/user_guide/xmlfiles.rst

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -80,20 +80,23 @@ where ``###`` is the three-digit format for the installed version. For example,
8080
on Windows, the path for the root folder for Ansys 2022 R2 likely ends with
8181
``\ANSYS Inc\v222``.
8282

83-
The ``ANSYS_ROOT_FOLDER`` element is like an environment variable. You can use
84-
this element in other XML files. For example, you might use it to find required
83+
The ``ANSYS_ROOT_FOLDER`` element defines a variable
84+
that can be used in the other XML files. For example, you might use it to find required
8585
third-party software.
8686

8787
If the ``ANSYS_ROOT_FOLDER`` element is not defined in the ``DataProcessing.xml``
88-
file, the root folder is determined by reading the ``AWP_ROOT###`` environment
89-
variable specific to your installed Ansys version. For example, if you are
90-
using Ansys 2022 R2, it looks for ``AWP_ROOT222`` to find the root folder.
91-
92-
If the ``ANSYS_ROOT_FOLDER`` element is still not defined, an attempt is made to
88+
file, an attempt is made to
9389
find the root folder relative to the ``DataProcessingCore`` DLL or SO file. This
9490
works only if the ``DataProcessingCore.xml`` file is located in its default
9591
location.
9692

93+
If the ``ANSYS_ROOT_FOLDER`` element is still not defined, the root folder is
94+
determined by reading the ``AWP_ROOT###`` environment variable specific to your
95+
installed Ansys version. For example, if you are using Ansys 2022 R2, it looks
96+
for the ``AWP_ROOT222`` environment variable to find the root folder.
97+
98+
ANSYS_ROOT_FOLDER is not an environment variable and cannot be set accordingly.
99+
97100
``<DefaultPlugin>`` element
98101
~~~~~~~~~~~~~~~~~~~~~~~~~~~
99102
The ``<DefaultPlugin>`` element defines the plugins to load. The ``<Linux>`` or
@@ -103,7 +106,7 @@ in the child elements.
103106
The ``<native>`` element defines DPF native operators. The further subdividing of
104107
plugins into ``<Debug>`` or ``<Release>`` elements is optional. The ``<Debug>``
105108
element, for example, would only be used with a debug version of the
106-
``DataProcessingCore DLL/SO`` file.
109+
``DataProcessingCore`` DLL or SO file.
107110

108111
The element names for plugins, such as ``<native>`` and ``<fem_utils>``, are used as
109112
**keys** when loading plugins. Each plugin must have a unique key.

0 commit comments

Comments
 (0)