Skip to content

Added image and updated intro. #204

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Apr 6, 2022
Merged

Added image and updated intro. #204

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2359e7a
Added image and updated intro.
JennaPaikowsky Mar 23, 2022
f3a65a7
Added back in DPF core description
JennaPaikowsky Mar 29, 2022
583d901
Changed line lengths
JennaPaikowsky Mar 30, 2022
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
Binary file added docs/source/images/drawings/dpf-flow.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
46 changes: 27 additions & 19 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,33 @@
PyAnsys DPF-Core
================

DPF (Data Processing Framework) provides numerical
simulation engineers with a toolbox for accessing and
transforming simulation data. DPF can access data from solver result
files as well as several neutral formats, such as CSV, HDF5, and VTK.
Various operators provide for the manipulation and transformation
of the data.

DPF is a workflow-based framework that allows simple and complex
evaluations by chaining operators. The data in DPF is defined based on
physics-agnostic mathematical quantities described in self-sufficient
entities called fields. This allows DPF to be a modular and easy-to-use
tool with a large range of capabilities. It is designed to handle
large amounts of data.

The module `ansys.dpf.core` provides a Python interface to
the powerful DPF framework, enabling rapid postprocessing of a variety
of Ansys file formats and physics solutions without ever leaving the
Python environment.

The Data Processing Framework (**DPF**) provides numerical simulation
users/engineers with a toolbox for accessing and transforming simulation
data. It is used to handle complex pre- or post-processing of simulation
data within a simulation workflow.

DPF is an independent, physics-agnostic tool that can be plugged into many
applications for both data input and data output
(result plots, visualization, and so on).

DPF can access data from solver result files and other neutral formats
(for example, CSV, HDF5, and VTK). Various operators are available,
allowing you to manipulate and transform this data.
You can chain operators together to create simple or complex data-processing
workflows that can be reused for repeated or future evaluations.

The data in DPF is defined based on physics-agnostic mathematical quantities
described in self-sufficient entities called fields. This allows DPF to be
a modular and easy-to-use tool with a large range of capabilities.
It is designed to handle large amounts of data.

.. image:: images/drawings/dpf-flow.png
:width: 670
:alt: DPF FLow

The module ``ansys.dpf.core`` provides a Python interface to the powerful
DPF framework, enabling rapid postprocessing of a variety of Ansys file
formats and physics solutions without ever leaving the Python environment.

Brief Demo
~~~~~~~~~~
Expand Down