1010[ ![ cov] ( https://codecov.io/gh/pyansys/pydpf-core/branch/master/graph/badge.svg )] ( https://codecov.io/gh/pyansys/pydpf-core )
1111[ ![ codacy] ( https://app.codacy.com/project/badge/Grade/61b6a519aea64715ad1726b3955fcf98 )] ( https://www.codacy.com/gh/pyansys/pydpf-core/dashboard?utm_source=github.com& ; utm_medium=referral& ; utm_content=pyansys/pydpf-core& ; utm_campaign=Badge_Grade )
1212
13- The Data Processing Framework (DPF) is designed to provide numerical
14- simulation users/engineers with a toolbox for accessing and
15- transforming simulation data. DPF can access data from solver result
16- files as well as several neutral formats (csv, hdf5, vtk,
17- etc.). Various operators are available allowing the manipulation and
18- the transformation of this data.
19-
20- DPF is a workflow-based framework which allows simple and/or complex
21- evaluations by chaining operators. The data in DPF is defined based on
22- physics agnostic mathematical quantities described in a
23- self-sufficient entity called field. This allows DPF to be a modular
24- and easy to use tool with a large range of capabilities. It's a
25- product designed to handle large amount of data.
26-
27- The Python `` ansys.dpf.core `` module provides a Python interface to
28- the powerful DPF framework enabling rapid post-processing of a variety
29- of Ansys file formats and physics solutions without ever leaving a
30- Python environment.
13+ The Data Processing Framework (DPF) provides numerical simulation
14+ users and engineers with a toolbox for accessing and transforming simulation
15+ data. With DPF, you can perform complex preprocessing or postprocessing of
16+ large amounts of simulation data within a simulation workflow.
17+
18+ DPF is an independent, physics-agnostic tool that you can plug into many
19+ apps for both data input and data output, including visualization and
20+ result plots. It can access data from solver result files and other neutral
21+ formats, such as CSV, HDF5, and VTK files.
22+
23+ Using the many DPF operators that are available, you can manipulate and
24+ transform this data. You can also chain operators together to create simple
25+ or complex data-processing workflows that you can reuse for repeated or
26+ future evaluations.
27+
28+ The data in DPF is defined based on physics-agnostic mathematical quantities
29+ described in self-sufficient entities called ** fields** . This allows DPF to be
30+ a modular and easy-to-use tool with a large range of capabilities.
31+
32+ .. image:: https://github.com/pyansys/pydpf-core/raw/main/docs/source/images/drawings/dpf-flow.png
33+ :width: 670
34+ :alt: DPF flow
35+
36+ The `` ansys.dpf.core `` package provides a Python interface to DPF, enabling
37+ rapid postprocessing of a variety of Ansys file formats and physics solutions
38+ without ever leaving the Python environment.
3139
3240## Documentation
3341
@@ -38,43 +46,44 @@ detailed examples.
3846
3947## Installation
4048
41- DPF requires an Ansys installation and must be compatible with it.
49+ PyDPF-Core requires DPF to be available, either thanks to a compatible Ansys installation or after installing the
50+ standalone server package `` ansys-dpf-server `` (see [ here] ( https://dpf.docs.pyansys.com/user_guide/getting_started_with_dpf_server.html ) ).
4251Compatibility between PyDPF-Core and Ansys is documented
4352[ here] ( https://dpfdocs.pyansys.com/getting_started/index.html#compatibility ) .
4453
45- Starting with Ansys 2021R2, install this package with:
54+ To use PyDPF-Core with `` ansys-dpf-server `` or Ansys 2021 R2 or later,
55+ install the latest version with this command:
4656
47- ```
48- pip install ansys-dpf-core
57+ ``` con
58+ pip install ansys-dpf-core
4959```
5060
51- For use with Ansys 2021R1, install this package with:
61+ PyDPF-Core plotting capabilities require to have ` PyVista <https://pyvista.org/> ` _ installed.
62+ To install PyDPF-Core with its optional plotting functionalities, use:
5263
53- ```
54- pip install ansys-dpf-core==0.2.1
64+ ``` con
65+ pip install ansys-dpf-core[plotting]
5566```
5667
57- You can also clone and install this repository with:
68+ For more information about PyDPF-Core plotting capabilities, see [ Plotting ] ( https://dpf.docs.pyansys.com/user_guide/plotting.html ) .
5869
59- ```
60- git clone https://github.com/pyansys/pydpf-core
61- cd pydpf-core
62- pip install -e .
63- ```
70+ To use PyDPF-Core with Ansys 2021 R1, install the latest version
71+ with this command:
6472
73+ ``` con
74+ pip install ansys-dpf-core<0.3.0
75+ ```
6576
66- ## Running DPF
67-
68- See the example scripts in the examples folder for some basic example. More will be added later.
6977
7078### Brief Demo
7179
72- Provided you have ANSYS 2021R1 or higher installed, a DPF server will start
73- automatically once you start using DPF.
80+ Provided you have DPF available, either thanks to an Ansys installation or after installing the
81+ standalone server package `` ansys-dpf-server `` (see [ here] ( https://dpf.docs.pyansys.com/user_guide/getting_started_with_dpf_server.html ) ),
82+ a DPF server will start automatically once you start using PyDPF-Core.
7483
7584To open a result file and explore what's inside, do:
7685
77- ``` py
86+ ``` pycon
7887>>> from ansys.dpf import core as dpf
7988>>> from ansys.dpf.core import examples
8089>>> model = dpf.Model(examples.find_simple_bar())
@@ -113,24 +122,24 @@ To open a result file and explore what's inside, do:
113122
114123Read a result with:
115124
116- ``` py
125+ ``` pycon
117126>>> result = model.results.displacement.eval()
118127```
119128
120129Then start connecting operators with:
121130
122- ``` py
131+ ``` pycon
123132>>> from ansys.dpf.core import operators as ops
124133>>> norm = ops.math.norm(model.results.displacement())
125134```
126135
127136### Starting the Service
128137
129- The ` ansys.dpf.core ` automatically starts a local instance of the DPF service in the
138+ The `` ansys.dpf.core `` library automatically starts a local instance of the DPF service in the
130139background and connects to it. If you need to connect to an existing
131140remote or local DPF instance, use the `` connect_to_server `` function:
132141
133- ``` py
142+ ``` pycon
134143>>> from ansys.dpf import core as dpf
135144>>> dpf.connect_to_server(ip = ' 10.0.0.22' , port = 50054 )
136145```
0 commit comments