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

Documentation: update to prepare DPF Server 2023_2_pre1 release #883

Merged
merged 9 commits into from
Apr 12, 2023
Merged

Documentation: update to prepare DPF Server 2023_2_pre1 release #883

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
7422088
Update doc for 2023.2.pre1
anslpa Apr 4, 2023
a221c6b
Update
anslpa Apr 4, 2023
c064629
Replace pre0 by pre1
anslpa Apr 4, 2023
cab5de6
Update pre0 into pre1 in index of getting started
anslpa Apr 4, 2023
776da1f
Update docs/source/user_guide/getting_started_with_dpf_server.rst
anslpa Apr 5, 2023
89b1af4
Update docs/source/user_guide/getting_started_with_dpf_server.rst
anslpa Apr 5, 2023
24c38ae
test
anslpa Apr 5, 2023
3447f1f
Revert "test"
anslpa Apr 5, 2023
b109942
Merge branch 'doc/dpf_server_23_2_pre1' of https://github.com/pyansys…
anslpa Apr 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/source/getting_started/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,10 @@ Install DPF Server

.. card::

* Download the ``ansys_dpf_server_win_v2023.2.pre0.zip`` or ``ansys_dpf_server_lin_v2023.2.pre0.zip``
* Download the ``ansys_dpf_server_win_v2023.2.pre1.zip`` or ``ansys_dpf_server_lin_v2023.2.pre1.zip``
file as appropriate.
* Unzip the package and go to its root folder (``ansys_dpf_server_win_v2023.2.pre0`` or
``ansys_dpf_server_lin_v2023.2.pre0``).
* Unzip the package and go to its root folder (``ansys_dpf_server_win_v2023.2.pre1`` or
``ansys_dpf_server_lin_v2023.2.pre1``).
* In a Python environment, run this command:

.. code::
Expand Down
16 changes: 10 additions & 6 deletions docs/source/user_guide/getting_started_with_dpf_server.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,11 @@ Install DPF Server

.. _target_installing_server:

#. Download the ``ansys_dpf_server_win_v2023.2.pre0.zip`` or ``ansys_dpf_server_lin_v2023.2.pre0.zip`` file as appropriate.
#. Download the ``ansys_dpf_server_win_v2023.2.pre1.zip`` or ``ansys_dpf_server_lin_v2023.2.pre1.zip`` file as appropriate.
#. Unzip the package.
#. Change to the root folder (``ansys_dpf_server_win_v2023.2.pre0``) of the unzipped 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.
#. In a Python environment, run this command:

.. code::
Expand Down Expand Up @@ -77,14 +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.pre0.zip`` file mentioned earlier
#. Along with the ``ansys_dpf_server_lin_v2023.2.pre1.zip`` file mentioned earlier
in :ref:`Install DPF Server <target_installing_server>`, download the ``Dockerfile`` file.
#. Copy both the ZIP file and ``Dockerfile`` file in a folder and navigate into that folder.
#. 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``.
#. 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_pre0 --build-arg DPF_VERSION=232 --build-arg DPF_SERVER_FILE=ansys_dpf_server_lin_v2023.2.pre0.zip
docker build . -t dpf-core:v2023_2_pre1 --build-arg DPF_VERSION=232

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 @@ -118,7 +122,7 @@ ensure that you replace ``<license_server_to_use>`` to point to the Ansys licens

.. 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_pre0
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

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