Skip to content

Add custom Python operator and plugin tutorials #1890

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

Open
wants to merge 49 commits into
base: doc/new-tutorials-section
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
49 commits
Select commit Hold shift + click to select a range
b6a4928
new tutorials layout
luisaFelixSalles Oct 21, 2024
bc998a3
user guide index page with tutorials
luisaFelixSalles Oct 22, 2024
bd08a1e
add new basic tutorial and jupyter_ sphinx extension
luisaFelixSalles Oct 22, 2024
64b4a63
add new basic tutorial in the sidebar
luisaFelixSalles Oct 22, 2024
992c045
add new fundamentals tutorial page
luisaFelixSalles Oct 22, 2024
a0d288e
reorganizing
luisaFelixSalles Oct 22, 2024
f616dd1
add fundamentals and usage tutorials and their sections
luisaFelixSalles Oct 23, 2024
7c79417
add more required tutorials
luisaFelixSalles Nov 7, 2024
0046af2
folders and index files for each tut section
luisaFelixSalles Nov 7, 2024
456b54d
update distributed files section grid
luisaFelixSalles Nov 7, 2024
3421141
updates
luisaFelixSalles Nov 8, 2024
4a2e9d3
layout changes
luisaFelixSalles Nov 12, 2024
db55259
updates on the index cards
luisaFelixSalles Nov 12, 2024
51fc7b9
updates on the index pages
luisaFelixSalles Nov 12, 2024
4de2bf1
updates on the basic tuts
luisaFelixSalles Nov 12, 2024
be5197c
updates
luisaFelixSalles Nov 12, 2024
f5f8f88
updates
luisaFelixSalles Nov 12, 2024
823289f
update tutorials main page
luisaFelixSalles Nov 13, 2024
cdadc07
add maths section
luisaFelixSalles Nov 13, 2024
df79026
add physics data section
luisaFelixSalles Nov 13, 2024
8f268c3
move and adapt the creating custom plugins/plugins packages (how-to) …
luisaFelixSalles Nov 7, 2024
1a36431
plug in packages with dependencies tut changes
luisaFelixSalles Nov 7, 2024
6fd9e71
update enriching index
luisaFelixSalles Nov 12, 2024
d9b12eb
update enriching refs
luisaFelixSalles Nov 12, 2024
ac016a5
change refs
luisaFelixSalles Nov 13, 2024
f18727c
change refs
luisaFelixSalles Nov 13, 2024
2942d34
change section name
luisaFelixSalles Nov 15, 2024
bf20f55
update ref on cards
luisaFelixSalles Nov 15, 2024
97f32dc
Fix requirements/requirements_docs.txt
PProfizi Nov 19, 2024
65ac1ab
Merge branch 'doc/new-tutorials-section' into tutorials/Enriching-DPF…
PProfizi Nov 19, 2024
6455b8c
Update section card description.
PProfizi Nov 19, 2024
5d3c268
Merge master
PProfizi Jun 12, 2025
9e3b86d
Merge master
PProfizi Jun 12, 2025
ce841df
Merge master
PProfizi Jun 12, 2025
c760f4e
Add a changelog to the operator in custom_operator_example.py
PProfizi Jun 12, 2025
c7f3474
Update tutorial section
PProfizi Jun 12, 2025
2993f24
Update custom_operator_example.py
PProfizi Jun 12, 2025
96c2e95
Update the tutorial section and separate the tutorial for updating py…
PProfizi Jun 12, 2025
28844ff
Update the documentation on operators
PProfizi Jun 12, 2025
0f9d207
Remove the tutorial section "enriching"
PProfizi Jun 12, 2025
7eb104b
Restructure the tutorial for creating a custom operator
PProfizi Jun 12, 2025
4878dbc
Merge branch 'doc/new-tutorials-section' into tutorials/Enriching-DPF…
PProfizi Jun 13, 2025
604da0e
Fix example code for custom_operators.rst
PProfizi Jun 13, 2025
abcec1a
Fix list in custom_operators.rst
PProfizi Jun 13, 2025
62351fa
Fix server argument in script in custom_operators.rst
PProfizi Jun 16, 2025
e703d70
Fix QA
PProfizi Jun 18, 2025
1844227
Fix QA
PProfizi Jun 18, 2025
2f8789e
Move custom_operator_example.py to an accessible location
PProfizi Jun 18, 2025
9e7fafb
Finalize tutorial custom_operators.rst
PProfizi Jun 18, 2025
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
1 change: 1 addition & 0 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@

autosummary_generate = False

autodoc_mock_imports = ["ansys.dpf.core.examples.python_plugins"]

# Add any paths that contain templates here, relative to this directory.
# templates_path = ['_templates']
Expand Down
36 changes: 0 additions & 36 deletions doc/source/user_guide/custom_operator_example.py

This file was deleted.

253 changes: 0 additions & 253 deletions doc/source/user_guide/custom_operators.rst

This file was deleted.

9 changes: 0 additions & 9 deletions doc/source/user_guide/how_to.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,6 @@ How-tos

.. image:: ../images/plotting/pontoon.png
.. image:: ../images/plotting/pontoon_strain.png


.. grid-item-card:: Create custom operators
:link: user_guide_custom_operators
:link-type: ref
:text-align: center

.. image:: ../images/drawings/plugin-logo.png
:width: 50%


.. grid-item-card:: Use DPF Server package
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Troubleshooting
tutorials/export_data/index.rst
tutorials/plot/index.rst
tutorials/animate/index.rst
tutorials/enriching_dpf_capabilities/index.rst
tutorials/custom_operators_and_plugins/index.rst
tutorials/distributed_files/index.rst
tutorials/dpf_server/index.rst
tutorials/licensing/index.rst
Expand Down
11 changes: 7 additions & 4 deletions doc/source/user_guide/operators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,16 +56,19 @@ The library of DPF operators is large and includes file readers and mathematical
geometrical, and logical transformations. For more information on this library,
which is progressively enhanced, see :ref:`ref_dpf_operators_reference`.

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

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

This example shows how to create the displacement operator:
This example shows how to instantiate the displacement operator:

.. code-block:: python

Expand Down
Loading
Loading