Skip to content

Commit c6f3d36

Browse files
Add custom Python operator and plugin tutorials (#1890)
Co-authored-by: Paul Profizi <[email protected]> Co-authored-by: PProfizi <[email protected]>
1 parent 9c43855 commit c6f3d36

23 files changed

+777
-372
lines changed

doc/source/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,7 @@
135135

136136
autosummary_generate = False
137137

138+
autodoc_mock_imports = ["ansys.dpf.core.examples.python_plugins"]
138139

139140
# Add any paths that contain templates here, relative to this directory.
140141
# templates_path = ['_templates']

doc/source/user_guide/custom_operator_example.py

Lines changed: 0 additions & 36 deletions
This file was deleted.

doc/source/user_guide/custom_operators.rst

Lines changed: 0 additions & 253 deletions
This file was deleted.

doc/source/user_guide/how_to.rst

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,6 @@ How-tos
1515

1616
.. image:: ../images/plotting/pontoon.png
1717
.. image:: ../images/plotting/pontoon_strain.png
18-
19-
20-
.. grid-item-card:: Create custom operators
21-
:link: user_guide_custom_operators
22-
:link-type: ref
23-
:text-align: center
24-
25-
.. image:: ../images/drawings/plugin-logo.png
26-
:width: 50%
2718

2819

2920
.. grid-item-card:: Use DPF Server package

doc/source/user_guide/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Troubleshooting
6666
tutorials/export_data/index.rst
6767
tutorials/plot/index.rst
6868
tutorials/animate/index.rst
69-
tutorials/enriching_dpf_capabilities/index.rst
69+
tutorials/custom_operators_and_plugins/index.rst
7070
tutorials/distributed_files/index.rst
7171
tutorials/dpf_server/index.rst
7272
tutorials/licensing/index.rst

doc/source/user_guide/operators.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,16 +56,19 @@ The library of DPF operators is large and includes file readers and mathematical
5656
geometrical, and logical transformations. For more information on this library,
5757
which is progressively enhanced, see :ref:`ref_dpf_operators_reference`.
5858

59+
Despite the large number of operators proposed by the standard DPF installation, you may want to
60+
create your own operators and ship them as DPF plugins.
61+
See the tutorials section on custom operators and plugins to learn more.
5962

60-
Create operators
61-
~~~~~~~~~~~~~~~~
62-
Each operator is of type :py:mod:`Operator <ansys.dpf.core.dpf_operator>`. You can create an instance
63+
Instantiate operators
64+
~~~~~~~~~~~~~~~~~~~~~
65+
Each operator is of type :py:mod:`Operator <ansys.dpf.core.dpf_operator>`. You can instantiate an operator
6366
in Python with any of the derived classes available in the
6467
:py:mod:`ansys.dpf.core.operators` package or directly with the :py:mod:`Operator <ansys.dpf.core.dpf_operator>`
6568
class using the internal name string that indicates the operator type.
6669
For more information, see :ref:`ref_dpf_operators_reference`.
6770

68-
This example shows how to create the displacement operator:
71+
This example shows how to instantiate the displacement operator:
6972

7073
.. code-block:: python
7174

0 commit comments

Comments
 (0)