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.

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

Add custom Python operator and plugin tutorials #1890

Open
wants to merge 30 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
30 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
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 @@ -87,6 +87,7 @@
"sphinx_design",
"sphinx_gallery.gen_gallery",
'sphinx_reredirects',
"jupyter_sphinx",
]

redirects = {
Expand Down
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
65 changes: 30 additions & 35 deletions doc/source/user_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,24 @@
User guide
==========

PyDPF-Core is a Python client API for accessing DPF postprocessing
capabilities. The ``ansys.dpf.core`` package makes highly efficient
computation, customization, and remote postprocessing accessible in Python.
**DPF** provides numerical simulation users and engineers with a toolbox for accessing and
transforming data.

The goals of this section are to:
**PyDPF-Core** is a Python client API for accessing DPF
capabilities. The ``ansys.dpf.core`` package makes highly efficient
computation, customization, and remote data processing accessible in Python.

- Describe the most-used DPF entities and how they can help you to access and modify solver data.
- Provide simple how-tos for tackling the most common use cases.
The goals of this section are to:

.. include::
concepts/index.rst
- Describe some DPF entities and how they can help you to access and modify solver data.
- Provide detailed tutorials to demonstrate PyDPF-Core functionalities.
- Explain how to resolve the most common issues encountered when using PyDPF-Core

.. include::
main_entities.rst
tutorials/index.rst

.. include::
how_to.rst

concepts/index.rst

Troubleshooting
---------------
Expand Down Expand Up @@ -52,6 +52,25 @@ Troubleshooting
:text-align: center


.. toctree::
:maxdepth: 2
:hidden:
:caption: Tutorials

tutorials/data_structures/index.rst
tutorials/language_and_usage/index.rst
tutorials/post_processing_basics/index.rst
tutorials/import_data/index.rst
tutorials/mesh/index.rst
tutorials/transform_data/index.rst
tutorials/export_data/index.rst
tutorials/plot/index.rst
tutorials/animate/index.rst
tutorials/custom_operators_and_plugins/index.rst
tutorials/distributed_files/index.rst
tutorials/dpf_server/index.rst
tutorials/licensing/index.rst

.. toctree::
:maxdepth: 2
:hidden:
Expand All @@ -61,30 +80,6 @@ Troubleshooting
concepts/waysofusing.rst
concepts/stepbystep.rst


.. toctree::
:maxdepth: 2
:hidden:
:caption: DPF most-used entities

model
operators
fields_container


.. toctree::
:maxdepth: 2
:hidden:
:caption: How-tos

plotting.rst
custom_operators.rst
dpf_server.rst
server_types.rst
server_context.rst
xmlfiles.rst


.. toctree::
:maxdepth: 3
:hidden:
Expand Down
24 changes: 24 additions & 0 deletions doc/source/user_guide/tutorials/animate/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
.. _ref_tutorials_animate:

=======
Animate
=======

These tutorials demonstrate how to visualise the data in an animation.

.. grid:: 1 1 3 3
:gutter: 2
:padding: 2
:margin: 2

.. grid-item-card:: Animate data
:link: ref_tutorials
:link-type: ref
:text-align: center

This tutorial

.. toctree::
:maxdepth: 2
:hidden:

Loading
Loading