Skip to content

Commit 3421141

Browse files
updates
1 parent 456b54d commit 3421141

File tree

3 files changed

+125
-108
lines changed

3 files changed

+125
-108
lines changed

doc/source/user_guide/index.rst

Lines changed: 26 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,24 @@
44
User guide
55
==========
66

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

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

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

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

1920
.. include::
2021
tutorials/index.rst
2122

2223
.. include::
23-
main_entities.rst
24-
25-
.. include::
26-
how_to.rst
27-
24+
concepts/index.rst
2825

2926
Troubleshooting
3027
---------------
@@ -55,45 +52,31 @@ Troubleshooting
5552
:text-align: center
5653

5754

58-
.. toctree::
59-
:maxdepth: 2
60-
:hidden:
61-
:caption: Concepts
62-
63-
concepts/concepts.rst
64-
concepts/waysofusing.rst
65-
concepts/stepbystep.rst
66-
6755
.. toctree::
6856
:maxdepth: 2
6957
:hidden:
7058
:caption: Tutorials
7159

7260
tutorials/basic_tutorial_index.rst
73-
tutorials/other_tutorials_index.rst
74-
75-
.. toctree::
76-
:maxdepth: 2
77-
:hidden:
78-
:caption: DPF most-used entities
79-
80-
model
81-
operators
82-
fields_container
83-
61+
tutorials/02-import_data/index.rst
62+
tutorials/03-mesh/index.rst
63+
tutorials/04-transform_data/index.rst
64+
tutorials/05-plot/index.rst
65+
tutorials/06-animate/index.rst
66+
tutorials/07-export_data/index.rst
67+
tutorials/08-enriching_dpf_capabilities/index.rst
68+
tutorials/09-distributed_files/index.rst
69+
tutorials/10-dpf_server/index.rst
70+
tutorials/11-licensing/index.rst
8471

8572
.. toctree::
86-
:maxdepth: 2
87-
:hidden:
88-
:caption: How-tos
89-
90-
plotting.rst
91-
custom_operators.rst
92-
dpf_server.rst
93-
server_types.rst
94-
server_context.rst
95-
xmlfiles.rst
73+
:maxdepth: 2
74+
:hidden:
75+
:caption: Concepts
9676

77+
concepts/concepts.rst
78+
concepts/waysofusing.rst
79+
concepts/stepbystep.rst
9780

9881
.. toctree::
9982
:maxdepth: 3

doc/source/user_guide/tutorials/index.rst

Lines changed: 99 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,117 @@
33
Tutorials
44
---------
55

6-
The tutorials go through the steps required to access, analyze,
7-
and transform simulation data using PyDPF-Core.
6+
The tutorials cover specifics features with detailed demonstrations to help
7+
understanding the fundamental PyDPF-Core functionalities and clarify some concepts.
8+
They are designed to teach how to perform a task, providing explanations at each stage.
89

9-
Tutorials are more substantive and complex than examples. They are designed to teach how to perform a task and understand
10-
the underlying concepts, providing detailed explanations at each stage, whereas examples showcase end-to-end specific processes.
10+
:fa:`person-running` Beginner's guide
11+
*************************************
1112

12-
.. grid:: 1 1 2 2
13+
New to PyDPF-Core? Check our beginner's tutorials. They offer an overview
14+
of our package background so you can understand how to work with it.
15+
16+
.. grid:: 1 1 3 3
1317
:gutter: 2
1418
:padding: 2
1519
:margin: 2
1620

17-
.. grid-item-card:: :fa:`person-running` Onboarding
21+
.. grid-item-card:: PyDPF-Core language fundamentals
22+
:link: ref_tutorials_basic
23+
:link-type: ref
24+
:text-align: center
25+
26+
These tutorials gives you an overview on how to use PyDPF-Core API
27+
28+
.. grid-item-card:: Processing data basics
29+
:link: ref_tutorials_others
30+
:link-type: ref
31+
:text-align: center
32+
33+
These tutorials shows the basics on how data can be manipulated with PyDPF-Core.
34+
35+
.. grid-item-card:: Post processing simulations basics
36+
:link: ref_tutorials_others
37+
:link-type: ref
38+
:text-align: center
39+
40+
This tutorial shows a basic post-processing procedure using PyDPf-Core
41+
42+
:fa:`book-open-reader` Features usage
43+
*************************************
44+
45+
.. grid:: 1 1 3 3
46+
:gutter: 2
47+
:padding: 2
48+
:margin: 2
49+
50+
.. grid-item-card:: Import Data on DPF
51+
:link: ref_tutorials_basic
52+
:link-type: ref
53+
:text-align: center
54+
55+
These tutorials demonstrate how to represent data in DPF: either from manual input either form result files.
56+
57+
.. grid-item-card:: Export data from DPF
58+
:link: ref_tutorials_others
59+
:link-type: ref
60+
:text-align: center
61+
62+
These tutorials provides demonstrations on how to export data from your manipulation.
63+
64+
.. grid-item-card:: Transform data with PyDPF-Core
65+
:link: ref_tutorials_basic
66+
:link-type: ref
67+
:text-align: center
68+
69+
These tutorials demonstrate how to transform and operate on the data to obtain the desired input.
70+
71+
.. grid-item-card:: Mesh analysis
72+
:link: ref_tutorials_others
73+
:link-type: ref
74+
:text-align: center
75+
76+
These tutorials provides detailed demonstrations on how to explore the simulation models mesh.
77+
78+
.. grid-item-card:: Plot
79+
:link: ref_tutorials_others
80+
:link-type: ref
81+
:text-align: center
82+
83+
These tutorials shows how to visualise the data in plots.
84+
85+
.. grid-item-card:: Animate
86+
:link: ref_tutorials_basic
87+
:link-type: ref
88+
:text-align: center
89+
90+
These tutorials shows how to visualise the data in an animation.
91+
92+
.. grid-item-card:: Enriching DPF capabilities
93+
:link: ref_tutorials_basic
94+
:link-type: ref
95+
:text-align: center
96+
97+
These tutorials demonstrate how to enhance DPF capabilities by creating new operator’s libraries.
98+
99+
.. grid-item-card:: Post-process distributed files
100+
:link: ref_tutorials_others
101+
:link-type: ref
102+
:text-align: center
103+
104+
These tutorials provides demonstrations on how to use PyDPF-Core with distributed files.
105+
106+
.. grid-item-card:: DPF server
18107
:link: ref_tutorials_basic
19108
:link-type: ref
20109
:text-align: center
21110

22-
New to PyDPF-Core? Check our beginner's tutorial. It offers an overview
23-
of our basic key features and links to additional tutorials.
111+
These tutorial explains how to manipulate DPF client-server architecture
24112

25-
.. grid-item-card:: :fa:`book-open-reader` Fundamentals and usage
113+
.. grid-item-card:: Licensing
26114
:link: ref_tutorials_others
27115
:link-type: ref
28116
:text-align: center
29117

30-
These tutorials provides detailed demonstrations on PyDPF-Core key features.
118+
These tutorials provide detailed demonstrations on how to access
119+
the Entry and Premium licensing capabilities

doc/source/user_guide/tutorials/other_tutorials_index.rst

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

0 commit comments

Comments
 (0)