Generate documentation for DPF

Pernelle Marone-Hitz

How can I generate the documentation for Data Processing Framework DPF?

Pernelle Marone-Hitz

In 2020R2, from Mechanical, the documentation can be generated with the following lines of code:

    import mech_dpf
    mech_dpf.setExtAPI(ExtAPI)
    import Ans.DataProcessing as dpf
    mech_dpf.help()

A string is returned in the console to show the folder in which the documentation is saved. It is saved in a .html file that can then be opened in any web browser.

klaus_2023

is there anywhere a real docu for DPF available ?

Pernelle Marone-Hitz

Hi @klaus_2023 , you can use the PyDPF doc: https://dpf.docs.pyansys.com/version/stable/

But please keep in mind that PyDPF is CPython and Mechanical DPF is Iron Python, so names of methods can change slightly and examples will have to be adapted.