Skip to content

Update doc for 2024 R1 pre0 and mark examples as requiring DPF 7.0 #1073

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.

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

Merged
merged 9 commits into from
Jul 27, 2023
Merged
5 changes: 5 additions & 0 deletions docs/source/getting_started/compatibility.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,11 @@ should also be synchronized with the server version.
- ``ansys.dpf.gate`` Python module version
- ``ansys.grpc.dpf`` Python module version
- ``ansys.dpf.core`` Python module version
* - 7.0 (Ansys 2024 R1 pre0)
- 0.4.0 and later
- 0.4.0 and later
- 0.8.0 and later
- 0.9.0 and later
* - 6.1 (Ansys 2023 R2 pre1)
- 0.3.1 and later
- 0.3.1 and later
Expand Down
4 changes: 2 additions & 2 deletions docs/source/operator_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,6 @@ Click below to access the operators documentation.

.. note::
For Ansys 2023 R1 and earlier, the context is equivalent to Premium, with all operators loaded.
For DPF Server 2023.2.pre0, the server context defines which operators are loaded and
accessible. Use the `PyDPF-Core 0.7 operator documentation<https://dpf.docs.pyansys.com/version/0.7/operator_reference.html#>`_ to learn more.
For DPF Server 2023.2.pre0 and later, the server context defines which operators are loaded and
accessible. Use the latest `PyDPF-Core operator documentation<https://dpf.docs.pyansys.com/version/stable/operator_reference.html#>`_ to learn more.
Some operators in the documentation might not be available for a particular server version.
16 changes: 8 additions & 8 deletions docs/source/user_guide/getting_started_with_dpf_server.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ Install DPF Server

.. _target_installing_server:

#. Download the ``ansys_dpf_server_win_v2023.2.pre1.zip`` or ``ansys_dpf_server_lin_v2023.2.pre1.zip`` file as appropriate.
#. Download the ``ansys_dpf_server_win_v2024.1.pre0.zip`` or ``ansys_dpf_server_lin_v2024.1.pre0.zip`` file as appropriate.
#. Unzip the package.
#. Optional: download any other plugin ZIP file as appropriate and unzip the package. For example, to access the ``composites`` plugin for Linux,
download ``ansys_dpf_composites_lin_v2023.2.pre1.zip`` and unzip the package in the same location as ``ansys_dpf_server_lin_v2023.2.pre1.zip``.
#. Change to the root folder (``ansys_dpf_server_win_v2023.2.pre1``) of the unzipped package.
download ``ansys_dpf_composites_lin_v2024.1.pre0.zip`` and unzip the package in the same location as ``ansys_dpf_server_lin_v2024.1.pre0.zip``.
#. Change to the root folder (``ansys_dpf_server_win_v2024.1.pre0``) of the unzipped package.
#. In a Python environment, run this command:

.. code::
Expand Down Expand Up @@ -79,16 +79,16 @@ Run DPF Server in a Docker container
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
DPF server can be run in a Docker container.

#. Along with the ``ansys_dpf_server_lin_v2023.2.pre1.zip`` file mentioned earlier
#. Along with the ``ansys_dpf_server_lin_v2024.1.pre0.zip`` file mentioned earlier
in :ref:`Install DPF Server <target_installing_server>`, download the ``Dockerfile`` file.
#. Optional: download any other plugin ZIP file as appropriate. For example, to access the ``composites`` plugin for Linux,
download ``ansys_dpf_composites_lin_v2023.2.pre1.zip``.
download ``ansys_dpf_composites_lin_v2024.1.pre0.zip``.
#. Copy all the ZIP files and ``Dockerfile`` file in a folder and navigate into that folder.
#. To build the DPF Docker container, run the following command:

.. code::

docker build . -t dpf-core:v2023_2_pre1 --build-arg DPF_VERSION=232
docker build . -t dpf-core:v2024.1.pre0 --build-arg DPF_VERSION=241

4. To run the DPF Docker container, license it. For more information, see'
:ref:`DPF Preview License Agreement<target_to_license_terms>`.
Expand Down Expand Up @@ -116,13 +116,13 @@ The ``ANSYS_DPF_ACCEPT_LA`` environment variable confirms your acceptance of the
By passing the value ``Y`` to this environment variable, you are indicating that you have a valid and
existing license for the edition and version of DPF Server that you intend to use.

For DPF Docker container usage only, you can use the following code to set both the `ANSYS_DPF_ACCEPT_LA``
For DPF Docker container usage only, you can use the following code to set both the ``ANSYS_DPF_ACCEPT_LA``
and ``ANSYSLMD_LICENSE_FILE`` environment variables. For the ``ANSYSLMD_LICENSE_FILE`` environment variable,
ensure that you replace ``<license_server_to_use>`` to point to the Ansys license server.

.. code::

docker run -e "ANSYS_DPF_ACCEPT_LA=Y" -e ANSYSLMD_LICENSE_FILE=1055@<license_server_to_use> -p 50052:50052 -e DOCKER_SERVER_PORT=50052 --expose=50052 dpf-core:v2023_2_pre1
docker run -e "ANSYS_DPF_ACCEPT_LA=Y" -e ANSYSLMD_LICENSE_FILE=1055@<license_server_to_use> -p 50052:50052 -e DOCKER_SERVER_PORT=50052 --expose=50052 dpf-core:v2024_1_pre0

The next section, :ref:`Ansys licensing<target_to_ansys_license_mechanism>`, provides information on
the Ansys license mechanism that is used with DPF Server.
Expand Down
5 changes: 5 additions & 0 deletions examples/12-fluids/00-fluids_model.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@

This example demonstrates how to explore Ansys Fluent and Ansys CFX models employing
the ``MeshInfo`` and ``ResultInfo``.

.. note::
This example requires DPF 7.0 (ansys-dpf-server-2024-1-pre0) or above.
For more information, see :ref:`ref_compatibility`.

"""

###############################################################################
Expand Down
4 changes: 4 additions & 0 deletions examples/12-fluids/01-fluids_mesh.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@
Explore Fluids mesh
-------------------

.. note::
This example requires DPF 7.0 (ansys-dpf-server-2024-1-pre0) or above.
For more information, see :ref:`ref_compatibility`.

"""

###############################################################################
Expand Down
4 changes: 4 additions & 0 deletions examples/12-fluids/02-fluids_results.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@
Explore Fluids results
----------------------

.. note::
This example requires DPF 7.0 (ansys-dpf-server-2024-1-pre0) or above.
For more information, see :ref:`ref_compatibility`.

"""

###############################################################################
Expand Down
5 changes: 5 additions & 0 deletions examples/12-fluids/03-fluids_isosurface.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@
------------------------------------------

This example demonstrates how to compute iso-surfaces on fluid models.

.. note::
This example requires DPF 7.0 (ansys-dpf-server-2024-1-pre0) or above.
For more information, see :ref:`ref_compatibility`.

"""

###############################################################################
Expand Down
4 changes: 4 additions & 0 deletions examples/13-streamlines/00_plot_3d_streamlines.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@
plot streamlines of fluid simulation results,
for 3D models.

.. note::
This example requires DPF 7.0 (ansys-dpf-server-2024-1-pre0) or above.
For more information, see :ref:`ref_compatibility`.

"""

###############################################################################
Expand Down
4 changes: 4 additions & 0 deletions examples/13-streamlines/01_plot_surface_streamlines.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
This example shows you how to compute and plot
streamlines of fluid simulation results, for 2D models.

.. note::
This example requires DPF 7.0 (ansys-dpf-server-2024-1-pre0) or above.
For more information, see :ref:`ref_compatibility`.

"""

###############################################################################
Expand Down