Skip to content

Commit 3cb7b0f

Browse files
authored
Fix some bad formatting and links (#1124)
* Fix some bad formatting and links * Resolve Vale issues * Remove repeated paragraph * Minor edits made as I compared with Py-DPF Post doc
1 parent 19ae597 commit 3cb7b0f

File tree

2 files changed

+47
-40
lines changed

2 files changed

+47
-40
lines changed

README.md

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@ apps for both data input and data output, including visualization and
2020
result plots. It can access data from solver result files and other neutral
2121
formats, such as CSV, HDF5, and VTK files.
2222

23-
The latest version of DPF supports Ansys solver result files for:
23+
The latest version of DPF supports Ansys solver results files for:
2424

25-
- MAPDL (`.rst`, `.mode`, `.rfrq`, `.rdsp`)
25+
- Mechanical APDL (`.rst`, `.mode`, `.rfrq`, `.rdsp`)
2626
- LS-DYNA (`.d3plot`, `.binout`)
2727
- Fluent (`.cas/dat.h5`, `.flprj`)
2828
- CFX (`.cad/dat.cff`, `.flprj`)
2929

30-
For more information on compatibility, see the `main page <https://dpf.docs.pyansys.com/version/stable/index.html>`_
31-
of the PDF-Core documentation.
30+
For more information on file support, see the [main page](https://dpf.docs.pyansys.com/version/stable/index.html)
31+
in the PDF-Core documentation.
3232

3333
Using the many DPF operators that are available, you can manipulate and
3434
transform this data. You can also chain operators together to create simple
@@ -37,11 +37,9 @@ future evaluations.
3737

3838
The data in DPF is defined based on physics-agnostic mathematical quantities
3939
described in self-sufficient entities called **fields**. This allows DPF to be
40-
a modular and easy-to-use tool with a large range of capabilities.
40+
a modular and easy-to-use tool with a large range of capabilities.
4141

42-
.. image:: https://github.com/ansys/pydpf-core/raw/main/docs/source/images/drawings/dpf-flow.png
43-
:width: 670
44-
:alt: DPF flow
42+
![DPF flow](https://github.com/ansys/pydpf-core/raw/main/docs/source/images/drawings/dpf-flow.png "DPF flow")
4543

4644
The ``ansys.dpf.core`` package provides a Python interface to DPF, enabling
4745
rapid postprocessing of a variety of Ansys file formats and physics solutions
@@ -50,11 +48,7 @@ without ever leaving the Python environment.
5048
## Documentation and issues
5149

5250
Documentation for the latest stable release of PyPDF-Core is hosted at
53-
[DPF-Core documentation](https://dpf.docs.pyansys.com/version/stable/).
54-
55-
In the upper right corner of the documentation's title bar, there is an option for switching from
56-
viewing the documentation for the latest stable release to viewing the documentation for the
57-
development version or previously released versions.
51+
[PyDPF-Core documentation](https://dpf.docs.pyansys.com/version/stable/).
5852

5953
In the upper right corner of the documentation's title bar, there is an option for switching from
6054
viewing the documentation for the latest stable release to viewing the documentation for the
@@ -67,7 +61,7 @@ for using PyDPF-Core.
6761

6862
On the [PyDPF-Core Issues](https://github.com/ansys/pydpf-core/issues) page,
6963
you can create issues to report bugs and request new features. On the
70-
[PyDPF-Core Discussions](https://github.com/ansys/pydpf-core/discussions) page or the {Discussions](https://discuss.ansys.com/)
64+
[PyDPF-Core Discussions](https://github.com/ansys/pydpf-core/discussions) page or the [Discussions](https://discuss.ansys.com/)
7165
page on the Ansys Developer portal, you can post questions, share ideas, and get community feedback.
7266

7367
To reach the project support team, email [[email protected]](mailto:[email protected]).
@@ -76,7 +70,8 @@ To reach the project support team, email [[email protected]](mailto:pyansys
7670

7771
PyDPF-Core requires DPF to be available. You can either have a compatible Ansys version installed
7872
or install the standalone ``ansys-dpf-server`` server package. For more information, see
79-
[Getting Started with DPF Server](https://dpf.docs.pyansys.com/version/stable/user_guide/getting_started_with_dpf_server.html) in the PyDPF-Core documentation.
73+
[Getting Started with DPF Server](https://dpf.docs.pyansys.com/version/stable/user_guide/getting_started_with_dpf_server.html)
74+
in the PyDPF-Core documentation.
8075

8176
For the compatibility between PyDPF-Core and Ansys, see
8277
[Compatibility](https://dpf.docs.pyansys.com/version/stable/getting_started/compatibility.html) in
@@ -174,3 +169,13 @@ remote or local DPF instance, use the ``connect_to_server`` method:
174169

175170
Once connected, this connection remains for the duration of the
176171
module. It closes when you exit Python or connect to a different server.
172+
173+
## License and acknowledgments
174+
175+
PyDPF-Core is licensed under the MIT license. For more information, see the
176+
[LICENSE](https://github.com/ansys/pydpf-post/raw/master/LICENSE) file.
177+
178+
PyDPF-Core makes no commercial claim over Ansys whatsoever. This library
179+
extends the functionality of Ansys DPF by adding a Python interface
180+
to DPF without changing the core behavior or license of the original
181+
software.

docs/source/index.rst

Lines changed: 27 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
PyDPF-Core
55
==========
66

7-
The Data Processing Framework (DPF) provides numerical simulation
7+
Ansys Data Processing Framework (DPF) provides numerical simulation
88
users and engineers with a toolbox for accessing and transforming simulation
99
data. With DPF, you can perform complex preprocessing or postprocessing of
1010
large amounts of simulation data within a simulation workflow.
1111

1212
DPF is an independent, physics-agnostic tool that you can plug into many
1313
apps for both data input and data output, including visualization and
1414
result plots. The following table shows an exhaustive list of supported
15-
apps by DPF and their related format:
15+
apps by DPF and their related formats:
1616

1717
.. table:: Truth table for "not"
1818
:widths: auto
@@ -42,7 +42,7 @@ apps by DPF and their related format:
4242
| || .flprj | | |
4343
+--------------------+------------------------+----------------------------------+----------------------------------+
4444

45-
Visualisation is ensured by VTK and leverage of `PyVista tools
45+
Visualisation is ensured by VTK and leverages `PyVista tools
4646
<https://docs.pyvista.org>`_.
4747

4848
Using the many DPF operators that are available, you can manipulate and
@@ -112,46 +112,51 @@ Accessing and enriching DPF capabilities
112112
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
113113

114114
Most of the DPF capabilities can be accessed using the operators.
115-
For more information about the existing operators, see the **Operators** tab.
115+
For more information, see :ref:`_ref_dpf_operators_reference`.
116116

117-
The following sections are summaries. For more detailed content, see :ref:`user_guide_waysofusing`.
117+
The following sections are summaries. For more information, see :ref:`user_guide_waysofusing`.
118118

119119
**Accessing DPF Server files**
120120

121-
DPF capabilities are accessible when DPF Server files are available. These files can be accessed using:
121+
DPF capabilities are accessible when DPF Server files are available. These files can be accessed using
122+
the **Ansys installer** and **DPF Server**.
122123

123-
- The **Ansys installer**. To use it, download the standard installation using your preferred distribution channel,
124-
and install Ansys following the installer instructions. For information on getting a licensed copy of Ansys,
125-
visit the `Ansys website <https://www.ansys.com/>`_.
124+
- To use the Ansys installer, download the standard Ansys installation using your preferred
125+
distribution channel, and install Ansys following the installer instructions. For information
126+
on getting a licensed copy of Ansys, visit the `Ansys website <https://www.ansys.com/>`_.
126127

127-
- The DPF Server package (see :ref:`ref_getting_started_with_dpf_server`).
128-
It is independent of the Ansys installer.
128+
- The DPF Server package is independent of the Ansys installer. For more information, see
129+
:ref:`ref_getting_started_with_dpf_server`.
129130

130131
**Accessing capabilities with scripting**
131132

132133
- C++ documentation:
133134

134-
1. The Data Processing Framework section in `Platform panel <https://ansysapi.ansys.com/account/secured?returnurl=/Views/Secured/main_page.html?lang=en>`_.
135+
- On the `Developer Documentation <https://developer.ansys.com/docs>`_page of the Ansys Developer portal,
136+
see **Data Processing Framework (DPF)**.
135137

136-
2. The Data Processing Framework section in `Developer Portal <https://developer.ansys.com/docs>`_
138+
- PyDPF documentation:
137139

138-
- CPython modules documentation:
140+
- `PyDPF-Core documentation <https://dpf.docs.pyansys.com/version/stable/>`_
139141

140-
1. `ansys-dpf-core <https://dpf.docs.pyansys.com/version/stable/>`_
141-
142-
2. `ansys-dpf-post <https://post.docs.pyansys.com/version/stable/>`_
142+
- `PyDPF-Post documentation <https://post.docs.pyansys.com/version/stable/>`_
143143

144144
- Mechanical scripting (IronPython):
145145

146-
1. `DPF through Automation Scripting <https://ansysproducthelpdev.win.ansys.com/account/secured?returnurl=/Views/Secured/corp/v231/en/act_script/mech_apis_data_process_frame.html>`_
147-
148-
2. `Python Result object <https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/v231/en/wb_sim/ds_python_result.html>`_
146+
- `Data Processing Framework <https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/v232/en/act_script/mech_apis_data_process_frame.html>`_
147+
in the *Scripting in Mechanical Guide*.
148+
149+
- `Python Result <https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/v231/en/wb_sim/ds_python_result.html>`_
150+
in the *Mechanical User's Guide*.
149151

150152
**Enriching DPF capabilities**
151153

152-
- C++ operator's library (see "DPF/USER GUIDE" section of `C++ documentation <https://developer.ansys.com/docs>`_)
154+
- `User guide <https://developer.ansys.com/product/DPF-C-Client-Library-2023-R2/modules.xhtml>`_ in the *DPF C++ Client Library*
155+
156+
- :ref:`user_guide_custom_operators` in the PyDPF-Core documentation
157+
158+
- `How to write a new solver reader as a PDF plugin <https://astonishing-hyacinth-e64.notion.site/How-to-write-a-new-solver-reader-as-a-DPF-s-plugin-bd2d2a3cf51f47ef9e70df45d64f89cb>`_
153159

154-
- `C++ solver reader plugin <https://astonishing-hyacinth-e64.notion.site/How-to-write-a-new-solver-reader-as-a-DPF-s-plugin-bd2d2a3cf51f47ef9e70df45d64f89cb>`_
155160

156161
Documentation and issues
157162
------------------------
@@ -175,9 +180,6 @@ page on the Ansys Developer portal, you can post questions, share ideas, and get
175180
To reach the project support team, email `[email protected] <[email protected]>`_.
176181

177182

178-
- :ref:`user_guide_custom_operators`
179-
180-
181183
.. toctree::
182184
:maxdepth: 2
183185
:caption: Getting Started

0 commit comments

Comments
 (0)