Skip to content

Commit 96c2e95

Browse files
committed
Update the tutorial section and separate the tutorial for updating pydpf-core server-side
1 parent 2993f24 commit 96c2e95

File tree

2 files changed

+58
-0
lines changed

2 files changed

+58
-0
lines changed

doc/source/user_guide/tutorials/custom_operators_and_plugins/index.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,26 @@ You can enhance and customize your DPF installation by creating new operators an
66

77
DPF offers multiple development APIs depending on your environment.
88

9+
With support for custom operators, PyDPF-Core becomes a development tool offering:
10+
11+
- **Accessibility:** A simple script can define a basic operator plugin.
12+
13+
- **Componentization:** Operators with similar applications can be grouped in Python plug-in packages.
14+
15+
- **Easy distribution:** Standard Python tools can be used to package, upload, and download custom operators.
16+
17+
- **Dependency management:** Third-party Python modules can be added to the Python package.
18+
19+
- **Reusability:** A documented and packaged operator can be reused in an infinite number of workflows.
20+
21+
- **Remotable and parallel computing:** Native DPF capabilities are inherited by custom operators.
22+
23+
The only prerequisite for creating custom operators is to be familiar with native operators.
24+
For more information, see :ref:`ref_user_guide_operators`.
25+
26+
.. note:
27+
You can create custom operators in CPython using PyDPF-Core for use with DPF in Ansys 2023 R1 and later.
28+
929
The following tutorials demonstrate how to develop such plugins using PyDPF-Core (CPython based) and how to use them.
1030

1131
.. grid:: 1 1 3 3
@@ -34,11 +54,19 @@ The following tutorials demonstrate how to develop such plugins using PyDPF-Core
3454

3555
This tutorial shows how to create a Python plug-in package with third-party dependencies.
3656

57+
.. grid-item-card:: Update PyDPF-Core in the DPF installation
58+
:link: tutorials_custom_operators_update_pydpf_core
59+
:link-type: ref
60+
:text-align: center
61+
62+
This tutorial shows how to update PyDPF-Core in your DPF installation.
63+
3764
.. toctree::
3865
:maxdepth: 2
3966
:hidden:
4067

4168
custom_operators.rst
4269
custom_plug_in_package.rst
4370
custom_plug_in_package_third_deps.rst
71+
update_pydpf_core.rst
4472

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
2+
Install module
3+
--------------
4+
5+
Once an Ansys-unified installation is complete, you must install the ``ansys-dpf-core`` module in the Ansys
6+
installer's Python interpreter.
7+
8+
#. Download the script for you operating system:
9+
10+
- For Windows, download this :download:`PowerShell script </user_guide/tutorials/enriching_dpf_capabilities/install_ansys_dpf_core_in_ansys.ps1>`.
11+
- For Linux, download this :download:`Shell script </user_guide/tutorials/enriching_dpf_capabilities/install_ansys_dpf_core_in_ansys.sh>`
12+
13+
#. Run the downloaded script for installing with optional arguments:
14+
15+
- ``-awp_root``: Path to the Ansys root installation folder. For example, the 2023 R1 installation folder ends
16+
with ``Ansys Inc/v231``, and the default environment variable is ``AWP_ROOT231``.
17+
- ``-pip_args``: Optional arguments to add to the ``pip`` command. For example, ``--extra-index-url`` or
18+
``--trusted-host``.
19+
20+
If you ever want to uninstall the ``ansys-dpf-core`` module from the Ansys installation, you can do so.
21+
22+
#. Download the script for your operating system:
23+
24+
- For Windows, download this :download:`PowerShell script </user_guide/tutorials/enriching_dpf_capabilities/uninstall_ansys_dpf_core_in_ansys.ps1>`.
25+
- For Linux, download this :download:`Shell script </user_guide/tutorials/enriching_dpf_capabilities/uninstall_ansys_dpf_core_in_ansys.sh>`.
26+
27+
#. Run the downloaded script for uninstalling with the optional argument:
28+
29+
- ``-awp_root``: Path to the Ansys root installation folder. For example, the 2023 R1 installation folder ends
30+
with ``Ansys Inc/v231``, and the default environment variable is ``AWP_ROOT231``.

0 commit comments

Comments
 (0)