Merge branch 'master' into mnale/min_version_doc_meshinfo

Author: MichaelNale

docs/source/getting_started/index.rst

@@ -6,7 +6,8 @@ Getting started
 
 The Data Processing Framework (DPF) provides numerical simulation users and engineers with a toolbox
 for accessing and transforming simulation data. DPF can access data from Ansys solver
-result (RST) files as well as from several neutral file formats, including CSV, HDF5, and VTK.
+result files as well as from several neutral (see :ref:`ref_main_index`).
+
 This **workflow-based** framework allows you to perform complex preprocessing and
 postprocessing operations on large amounts of simulation data.
 

docs/source/index.rst

@@ -1,3 +1,5 @@
+.. _ref_main_index:
+
 ==========
 PyDPF-Core
 ==========
@@ -9,8 +11,39 @@ large amounts of simulation data within a simulation workflow.
 
 DPF is an independent, physics-agnostic tool that you can plug into many 
 apps for both data input and data output, including visualization and 
-result plots. It can access data from solver result files and other neutral
-formats, such as CSV, HDF5, and VTK files.
+result plots. The following table shows an exhaustive list of supported
+apps by DPF and their related format:
+
+.. table:: Truth table for "not"
+   :widths: auto
+   :align: center
+
++--------------------+------------------------+----------------------------------+----------------------------------+
+|     **Solver**     |    **File format**     |       **Server version**         |       **DPF examples**           |
++====================+========================+==================================+==================================+
+|                    || .rst, .mode           || **1.0** and later               | :ref:`ref_basic_example`         |
+|        MAPDL       || .rfrq, .rdsp          || (*Ansys 2021 R1*)               |                                  |
++--------------------+------------------------+----------------------------------+----------------------------------+
+|       LS DYNA      |   .d3plot, .binout     || **4.0** and later               | :ref:`lsdyna_operators`          |
+|                    |                        || (*Ansys 2022 R2*)               |                                  |
++--------------------+------------------------+----------------------------------+----------------------------------+
+|                    || *CFF restart files*   ||                                 | :ref:`ref_fluids_model`          |
+|                    || .cas/dat.h5           ||                                 +----------------------------------+
+|                    |                        || **7.0** and later               | :ref:`ref_fluids_mesh`           |
+|        Fluent      +------------------------+| (*Ansys 2024 R1 pre0*)          +----------------------------------+
+|                    || *Project files*       |                                  | :ref:`ref_fluids_results`        |
+|                    || .flprj                |                                  |                                  |
++--------------------+------------------------+----------------------------------+----------------------------------+
+|                    || *CFF files*           ||                                 | :ref:`ref_fluids_model`          |
+|                    || .cas/dat.cff          ||                                 +----------------------------------+
+|                    |                        || **7.0** and later               | :ref:`ref_fluids_mesh`           |
+|          CFX       +------------------------+| (*Ansys 2024 R1 pre0*)          +----------------------------------+
+|                    || *Project files*       |                                  | :ref:`ref_fluids_results`        |
+|                    || .flprj                |                                  |                                  |
++--------------------+------------------------+----------------------------------+----------------------------------+
+
+Visualisation is ensured by VTK and leverage of `PyVista tools
+<https://docs.pyvista.org>`_.
 
 Using the many DPF operators that are available, you can manipulate and
 transform this data. You can also chain operators together to create simple
@@ -29,7 +62,6 @@ The ``ansys.dpf.core`` package provides a Python interface to DPF, enabling
 rapid postprocessing of a variety of Ansys file formats and physics solutions
 without ever leaving the Python environment.
 
-
 Brief demo
 ~~~~~~~~~~
 Here is how you open a result file generated by MAPDL (or another ANSYS solver)

docs/source/user_guide/operators.rst

@@ -307,12 +307,8 @@ DPF provides three main types of operators:
 Operators for importing or reading data
 ***************************************
 
-These operators provide for reading data from solver files or from standard file types:
-
-- For MAPDL, supported solver file formats include RST, MODE, RFRQ, and RDSP.
-- For LS DYNA, D3PLOT files are supported.
-- For Fluent and CFX, CAS.H5, DAT.H5, RES, and FLPRJ files are supported.
-- For Abaqus, ODB files are supported.
+These operators provide for reading data from solver files or from standard file types
+such as .RST (MAPDL), .D3Plot (LS DYNA), .CAS.H5/.DAT.H5 (Fluent) or .CAS.CFF/.DAT.CFF (CFX).
 
 To read these files, different readers are implemented as plugins.
 Plugins can be loaded on demand in any DPF scripting language with "load library" methods.