Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Setting docs version to v241 #3024

Merged
merged 1 commit into from May 3, 2024
Merged

Setting docs version to v241 #3024

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 9 additions & 9 deletions doc/source/getting_started/launcher.rst
View file
Open in desktop
Expand Up @@ -64,14 +64,14 @@ To launch MAPDL, use this command:

.. code:: pwsh-session

(.venv) PS C:\Users\user\pymapdl> C:/Program Files/ANSYS Inc/v241/ansys/bin/winx64/ANSYS211.exe -grpc
(.venv) PS C:\Users\user\pymapdl> C:/Program Files/ANSYS Inc/v241/ansys/bin/winx64/ANSYS241.exe -grpc

.. tab-item:: Linux
:sync: key1

.. code:: console

(.venv) user@machine:~$ /usr/ansys_inc/v241/ansys/bin/ansys211 -grpc
(.venv) user@machine:~$ /usr/ansys_inc/v241/ansys/bin/ansys241 -grpc

When launching MAPDL on Windows, it is assumed that Ansys is installed in the
:file:`C:/Program Files/ANSYS Inc/v241` directory and, on Linux, it is assumed
Expand Down Expand Up @@ -101,14 +101,14 @@ port 50005 with this command:

.. code:: pwsh-session

(.venv) PS C:\Users\user\pymapdl> C:/Program Files/ANSYS Inc/v241/ansys/bin/winx64/ANSYS211.exe -port 50005 -grpc
(.venv) PS C:\Users\user\pymapdl> C:/Program Files/ANSYS Inc/v241/ansys/bin/winx64/ANSYS241.exe -port 50005 -grpc

.. tab-item:: Linux
:sync: key1

.. code:: console

(.venv) user@machine:~$ /usr/ansys_inc/v241/ansys/bin/ansys211 -port 50005 -grpc
(.venv) user@machine:~$ /usr/ansys_inc/v241/ansys/bin/ansys241 -port 50005 -grpc


From version v0.68, you can use a command line interface to launch, stop, and list
Expand Down Expand Up @@ -192,10 +192,10 @@ variables:

* ``AWP_ROOTXXX``, where ``XXX``` is the three-digit version. This environment variable
contains the path of the Ansys installation with the version matching ``XXX``.
For example, ``AWP_ROOT222=/ansys_inc`` contains the path to an Ansys 2022 R2 installation.
For example, ``AWP_ROOT241=/ansys_inc`` contains the path to an Ansys 2024 R1 installation.

* ``PYMAPDL_MAPDL_EXEC`` contains the path to the Ansys MAPDL executable file.
For example, ``PYMAPDL_MAPDL_EXEC=/ansys_inc/v222/ansys/bin/ansys222``.
For example, ``PYMAPDL_MAPDL_EXEC=/ansys_inc/v241/ansys/bin/ansys241``.

If PyMAPDL is unable to find a copy of MAPDL, you
are prompted for the location of the MAPDL executable.
Expand All @@ -204,13 +204,13 @@ Here is the prompt with an example response for Windows:

.. code:: output

Enter location of MAPDL executable: C:\Program Files\ANSYS Inc\v222\ANSYS\bin\winx64\ansys222.exe
Enter location of MAPDL executable: C:\Program Files\ANSYS Inc\v241\ANSYS\bin\winx64\ansys241.exe

Here is the prompt with an example response for Linux:

.. code:: output

Enter location of MAPDL executable: /usr/ansys_inc/v222/ansys/bin/ansys222
Enter location of MAPDL executable: /usr/ansys_inc/v241/ansys/bin/ansys241

The settings file is stored locally, which means that you are not prompted
to enter the path again. If you must change the default Ansys path
Expand All @@ -220,7 +220,7 @@ to enter the path again. If you must change the default Ansys path

from ansys.mapdl import core as pymapdl

new_path = "C:\\Program Files\\ANSYS Inc\\v241\\ANSYS\\bin\\winx64\\ansys222.exe"
new_path = "C:\\Program Files\\ANSYS Inc\\v241\\ANSYS\\bin\\winx64\\ansys241.exe"
pymapdl.change_default_ansys_path(new_path)

For more information, see the :func:`change_default_ansys_path() <ansys.mapdl.core.change_default_ansys_path>` method and the :func:`find_ansys() <ansys.mapdl.core.find_ansys>` method.
Expand Down
14 changes: 7 additions & 7 deletions doc/source/getting_started/wsl.rst
View file
Open in desktop
Expand Up @@ -105,9 +105,9 @@ To install Ansys products in WSL Linux, perform these steps:
If you omit this argument, all products are installed. The *Ansys, Inc.
Installation Guides* in the Ansys Help provides a list of valid
values for the ``product_flags`` argument in `Chapter 6
<https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/v231/en/installation/unix_silent.html>`_
<https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/v241/en/installation/unix_silent.html>`_
of the *Linux Installation Guide* and `Chapter 7
<https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/v231/en/installation/win_silent.html>`_
<https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/v241/en/installation/win_silent.html>`_
of the *Windows Installation Guide*.

In the preceding example for MAPDL, you only need to specify the ``-mechapdl`` flag.
Expand Down Expand Up @@ -214,14 +214,14 @@ An example follows.

.. code:: console

/ansys_inc/v222/ansys/bin/ansys222 -grpc
/ansys_inc/v241/ansys/bin/ansys241 -grpc

This launches an MAPDL instance whose working directory is the current directory.
If you want to change the working directory, you can use the ``-dir`` flag.

.. code:: console

/ansys_inc/v222/ansys/bin/ansys222 -grpc -dir /tmp/ansys_jobs/myjob
/ansys_inc/v241/ansys/bin/ansys241 -grpc -dir /tmp/ansys_jobs/myjob


Launch MAPDL in the Windows host OS
Expand All @@ -236,7 +236,7 @@ To do that, run this code:
from ansys.mapdl.core import launch_mapdl

mapdl = launch_mapdl(
exec_file="/mnt/c/Program Files/ANSYS Inc/v231/ANSYS/bin/winx64/ANSYS231.exe",
exec_file="/mnt/c/Program Files/ANSYS Inc/v241/ANSYS/bin/winx64/ANSYS241.exe",
)

As mentioned in `Open ports for license server communication`_, the Windows host OS
Expand All @@ -250,7 +250,7 @@ address is not correct, you can specify the IP address to connect to like this:
from ansys.mapdl.core import launch_mapdl

mapdl = launch_mapdl(
exec_file="/mnt/c/Program Files/ANSYS Inc/v231/ANSYS/bin/winx64/ANSYS231.exe",
exec_file="/mnt/c/Program Files/ANSYS Inc/v241/ANSYS/bin/winx64/ANSYS241.exe",
ip="172.23.112.1",
)

Expand Down Expand Up @@ -468,7 +468,7 @@ You can stop all processes with a given name with this command.

.. code:: pwsh-session

Get-Process "ANSYS212" | Stop-Process
Get-Process "ANSYS241" | Stop-Process


Install ``xvfb`` in CentOS 7
Expand Down
4 changes: 2 additions & 2 deletions doc/source/links.rst
View file
Open in desktop
Expand Up @@ -64,7 +64,7 @@
.. _ansys_installation_and_licensing: https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/prod_page.html?pn=Installation%20and%20Licensing&pid=InstallationAndLicensing&lang=en
.. _ansys_parallel_computing_guide: https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/%%VERSION%%/en/ans_dan/dantoc.html
.. _ansys_verification_manual: https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/%%VERSION%%/en/ans_vm/Hlp_V_VMTOC.html
.. _ansys_tutorials_guide: https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/v231/en/ans_tut/Hlp_UI_Tutorials.html
.. _ansys_tutorials_guide: https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/%%VERSION%%/en/ans_tut/Hlp_UI_Tutorials.html

.. # Ansys introductory tutorials
.. _ansys_introtut: https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/%%VERSION%%/en/ans_tut/Hlp_UI_Tutorials.html
Expand Down Expand Up @@ -218,4 +218,4 @@

.. # Elements references

.. _elem_plane183: https://ansyshelp.ansys.com/account/Secured?returnurl=/Views/Secured/corp/v231/en/ans_elem/Hlp_E_PLANE183.html
.. _elem_plane183: https://ansyshelp.ansys.com/account/Secured?returnurl=/Views/Secured/corp/%%VERSION%%/en/ans_elem/Hlp_E_PLANE183.html
20 changes: 10 additions & 10 deletions doc/source/user_guide/cli.rst
View file
Open in desktop
Expand Up @@ -194,7 +194,7 @@ If you want to list MAPDL process, just use the following command:
------------ ------------- -------- ----------- -----
ANSYS.exe False running 50052 35360
ANSYS.exe False running 50052 37116
ANSYS222.exe True running 50052 41644
ANSYS241.exe True running 50052 41644

.. tab-item:: Linux
:sync: key1
Expand All @@ -206,7 +206,7 @@ If you want to list MAPDL process, just use the following command:
------------ ------------- -------- ----------- -----
ANSYS.exe False running 50052 35360
ANSYS.exe False running 50052 37116
ANSYS222.exe True running 50052 41644
ANSYS241.exe True running 50052 41644


If you want, to just list the instances (avoiding listing children MAPDL
Expand All @@ -223,7 +223,7 @@ processes), just type:
(.venv) PS C:\Users\user\pymapdl> pymapdl list -i
Name Status gRPC port PID
------------ -------- ----------- -----
ANSYS222.exe running 50052 41644
ANSYS241.exe running 50052 41644

.. tab-item:: Linux
:sync: key1
Expand All @@ -233,7 +233,7 @@ processes), just type:
(.venv) user@machine:~$ pymapdl list -i
Name Status gRPC port PID
------------ -------- ----------- -----
ANSYS222.exe running 50052 41644
ANSYS241.exe running 50052 41644


You can also print other fields like the working directory (using `--cwd`)
Expand All @@ -252,9 +252,9 @@ argument `--long` or `-l`:
(.venv) PS C:\Users\user\pymapdl> pymapdl list -l
Name Is Instance Status gRPC port PID Command line Working directory
------------ ------------- -------- ----------- ----- -------------------------------------------------------------------------------------------------------------------------------- ---------------------------------------------------
ANSYS.exe False running 50052 35360 C:\Program Files\ANSYS Inc\v222\ANSYS\bin\winx64\ANSYS.EXE -j file -b -i .__tmp__.inp -o .__tmp__.out -port 50052 -grpc C:\Users\User\AppData\Local\Temp\ansys_ahmfaliakp
ANSYS.exe False running 50052 37116 C:\Program Files\ANSYS Inc\v222\ANSYS\bin\winx64\ANSYS.EXE -j file -b -i .__tmp__.inp -o .__tmp__.out -port 50052 -grpc C:\Users\User\AppData\Local\Temp\ansys_ahmfaliakp
ANSYS222.exe True running 50052 41644 C:\Program Files\ANSYS Inc\v222\ansys\bin\winx64\ansys222.exe -j file -np 2 -b -i .__tmp__.inp -o .__tmp__.out -port 50052 -grpc C:\Users\User\AppData\Local\Temp\ansys_ahmfaliakp
ANSYS.exe False running 50052 35360 C:\Program Files\ANSYS Inc\v241\ANSYS\bin\winx64\ANSYS.EXE -j file -b -i .__tmp__.inp -o .__tmp__.out -port 50052 -grpc C:\Users\User\AppData\Local\Temp\ansys_ahmfaliakp
ANSYS.exe False running 50052 37116 C:\Program Files\ANSYS Inc\v241\ANSYS\bin\winx64\ANSYS.EXE -j file -b -i .__tmp__.inp -o .__tmp__.out -port 50052 -grpc C:\Users\User\AppData\Local\Temp\ansys_ahmfaliakp
ANSYS241.exe True running 50052 41644 C:\Program Files\ANSYS Inc\v241\ansys\bin\winx64\ansys241.exe -j file -np 2 -b -i .__tmp__.inp -o .__tmp__.out -port 50052 -grpc C:\Users\User\AppData\Local\Temp\ansys_ahmfaliakp

.. tab-item:: Linux
:sync: key1
Expand All @@ -264,9 +264,9 @@ argument `--long` or `-l`:
(.venv) user@machine:~$ pymapdl list -l
Name Is Instance Status gRPC port PID Command line Working directory
------------ ------------- -------- ----------- ----- ------------------------------------------------------------------------- --------------------------------
ANSYS False running 50052 35360 /ansys_inc/v222/ansys/bin/linx64/ansys -j file -port 50052 -grpc /home/user/temp/ansys_ahmfaliakp
ANSYS False running 50052 37116 /ansys_inc/v222/ansys/bin/linx64/ansys -j file -port 50052 -grpc /home/user/temp/ansys_ahmfaliakp
ANSYS222 True running 50052 41644 /ansys_inc/v222/ansys/bin/linx64/ansys222 -j file -np 2 -port 50052 -grpc /home/user/temp/ansys_ahmfaliakp
ANSYS False running 50052 35360 /ansys_inc/v241/ansys/bin/linx64/ansys -j file -port 50052 -grpc /home/user/temp/ansys_ahmfaliakp
ANSYS False running 50052 37116 /ansys_inc/v241/ansys/bin/linx64/ansys -j file -port 50052 -grpc /home/user/temp/ansys_ahmfaliakp
ANSYS241 True running 50052 41644 /ansys_inc/v241/ansys/bin/linx64/ansys241 -j file -np 2 -port 50052 -grpc /home/user/temp/ansys_ahmfaliakp


The converter module has its own command line interface to convert
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/mapdl.rst
View file
Open in desktop
Expand Up @@ -1152,7 +1152,7 @@ These are described in the following table:
| | |
| | .. code:: console |
| | |
| | export PYMAPDL_MAPDL_EXEC=/ansys_inc/v222/ansys/bin/mapdl |
| | export PYMAPDL_MAPDL_EXEC=/ansys_inc/v241/ansys/bin/mapdl |
| | |
+---------------------------------------+---------------------------------------------------------------------+
| :envvar:`PYMAPDL_MAPDL_VERSION` | Default MAPDL version to launch in case there |
Expand Down
4 changes: 2 additions & 2 deletions doc/source/user_guide/troubleshoot.rst
View file
Open in desktop
Expand Up @@ -602,9 +602,9 @@ If you want to see which Ansys installations PyMAPDL has detected, use:

>>> from ansys.mapdl.core import get_available_ansys_installations
>>> get_available_ansys_installations()
{222: 'C:\\Program Files\\ANSYS Inc\\v241',
{222: 'C:\\Program Files\\ANSYS Inc\\v222',
212: 'C:\\Program Files\\ANSYS Inc\\v212',
-222: 'C:\\Program Files\\ANSYS Inc\\ANSYS Student\\v241'}
-222: 'C:\\Program Files\\ANSYS Inc\\ANSYS Student\\v222'}

Student versions are provided as **negative** versions because the Python dictionary
does not accept two equal keys. The result of the
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/upf.rst
View file
Open in desktop
Expand Up @@ -186,7 +186,7 @@ During the Mechanical APDL process, you see this Python printout:

.. code:: output

RUN SETUP PROCEDURE FROM FILE= /ansys_inc/v212/ansys/apdl/start.ans
RUN SETUP PROCEDURE FROM FILE= /ansys_inc/v241/ansys/apdl/start.ans
=======================================
>> Inside the PYTHON UAnBeg routine <<
=======================================
Expand Down