Skip to content

Commit 4495625

Browse files
Added image and updated intro. (#204)
* Added image and updated intro. * Added back in DPF core description * Changed line lengths
1 parent a6e880e commit 4495625

File tree

2 files changed

+27
-19
lines changed

2 files changed

+27
-19
lines changed
28.8 KB
Loading

docs/source/index.rst

Lines changed: 27 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,33 @@
22
PyAnsys DPF-Core
33
================
44

5-
DPF (Data Processing Framework) provides numerical
6-
simulation engineers with a toolbox for accessing and
7-
transforming simulation data. DPF can access data from solver result
8-
files as well as several neutral formats, such as CSV, HDF5, and VTK.
9-
Various operators provide for the manipulation and transformation
10-
of the data.
11-
12-
DPF is a workflow-based framework that allows simple and complex
13-
evaluations by chaining operators. The data in DPF is defined based on
14-
physics-agnostic mathematical quantities described in self-sufficient
15-
entities called fields. This allows DPF to be a modular and easy-to-use
16-
tool with a large range of capabilities. It is designed to handle
17-
large amounts of data.
18-
19-
The module `ansys.dpf.core` provides a Python interface to
20-
the powerful DPF framework, enabling rapid postprocessing of a variety
21-
of Ansys file formats and physics solutions without ever leaving the
22-
Python environment.
23-
5+
The Data Processing Framework (**DPF**) provides numerical simulation
6+
users/engineers with a toolbox for accessing and transforming simulation
7+
data. It is used to handle complex pre- or post-processing of simulation
8+
data within a simulation workflow.
9+
10+
DPF is an independent, physics-agnostic tool that can be plugged into many
11+
applications for both data input and data output
12+
(result plots, visualization, and so on).
13+
14+
DPF can access data from solver result files and other neutral formats
15+
(for example, CSV, HDF5, and VTK). Various operators are available,
16+
allowing you to manipulate and transform this data.
17+
You can chain operators together to create simple or complex data-processing
18+
workflows that can be reused for repeated or future evaluations.
19+
20+
The data in DPF is defined based on physics-agnostic mathematical quantities
21+
described in self-sufficient entities called fields. This allows DPF to be
22+
a modular and easy-to-use tool with a large range of capabilities.
23+
It is designed to handle large amounts of data.
24+
25+
.. image:: images/drawings/dpf-flow.png
26+
:width: 670
27+
:alt: DPF FLow
28+
29+
The module ``ansys.dpf.core`` provides a Python interface to the powerful
30+
DPF framework, enabling rapid postprocessing of a variety of Ansys file
31+
formats and physics solutions without ever leaving the Python environment.
2432

2533
Brief Demo
2634
~~~~~~~~~~

0 commit comments

Comments
 (0)