diff --git a/docs/source/getting_started/compatibility.rst b/docs/source/getting_started/compatibility.rst index d041efbe19..f0d1cc9d9b 100644 --- a/docs/source/getting_started/compatibility.rst +++ b/docs/source/getting_started/compatibility.rst @@ -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 diff --git a/docs/source/operator_reference.rst b/docs/source/operator_reference.rst index 78230de8d0..c3a06fccae 100644 --- a/docs/source/operator_reference.rst +++ b/docs/source/operator_reference.rst @@ -33,7 +33,8 @@ 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`_ to learn more. - Some operators in the documentation might not be available for a particular server version. \ No newline at end of file + For DPF Server 2023.2.pre0 specifically, the server context defines which operators are loaded and + accessible. Use the `PyDPF-Core 0.7 operator documentation `_ to learn more. + Some operators in the documentation might not be available for a particular server version. diff --git a/docs/source/user_guide/getting_started_with_dpf_server.rst b/docs/source/user_guide/getting_started_with_dpf_server.rst index 8a7f58c716..7c6772bafb 100644 --- a/docs/source/user_guide/getting_started_with_dpf_server.rst +++ b/docs/source/user_guide/getting_started_with_dpf_server.rst @@ -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:: @@ -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 `, 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`. @@ -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 ```` to point to the Ansys license server. .. code:: - docker run -e "ANSYS_DPF_ACCEPT_LA=Y" -e ANSYSLMD_LICENSE_FILE=1055@ -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@ -p 50052:50052 -e DOCKER_SERVER_PORT=50052 --expose=50052 dpf-core:v2024_1_pre0 The next section, :ref:`Ansys licensing`, provides information on the Ansys license mechanism that is used with DPF Server. diff --git a/examples/12-fluids/00-fluids_model.py b/examples/12-fluids/00-fluids_model.py index 79ce371174..79a550f6d6 100644 --- a/examples/12-fluids/00-fluids_model.py +++ b/examples/12-fluids/00-fluids_model.py @@ -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`. + """ ############################################################################### diff --git a/examples/12-fluids/01-fluids_mesh.py b/examples/12-fluids/01-fluids_mesh.py index e0a8540844..c1b33cd8fe 100644 --- a/examples/12-fluids/01-fluids_mesh.py +++ b/examples/12-fluids/01-fluids_mesh.py @@ -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`. + """ ############################################################################### diff --git a/examples/12-fluids/02-fluids_results.py b/examples/12-fluids/02-fluids_results.py index 8bcb42f40b..d684b83b93 100644 --- a/examples/12-fluids/02-fluids_results.py +++ b/examples/12-fluids/02-fluids_results.py @@ -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`. + """ ############################################################################### diff --git a/examples/12-fluids/03-fluids_isosurface.py b/examples/12-fluids/03-fluids_isosurface.py index 34e3f2a961..fda16d7f64 100644 --- a/examples/12-fluids/03-fluids_isosurface.py +++ b/examples/12-fluids/03-fluids_isosurface.py @@ -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`. + """ ############################################################################### diff --git a/examples/13-streamlines/00_plot_3d_streamlines.py b/examples/13-streamlines/00_plot_3d_streamlines.py index cff993eb86..4c61772f45 100644 --- a/examples/13-streamlines/00_plot_3d_streamlines.py +++ b/examples/13-streamlines/00_plot_3d_streamlines.py @@ -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`. + """ ############################################################################### diff --git a/examples/13-streamlines/01_plot_surface_streamlines.py b/examples/13-streamlines/01_plot_surface_streamlines.py index 71d9f9b4d6..b2e400304a 100644 --- a/examples/13-streamlines/01_plot_surface_streamlines.py +++ b/examples/13-streamlines/01_plot_surface_streamlines.py @@ -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`. + """ ###############################################################################