doc(tutorials): Add a tutorial on creating a DPF Python plugin for custom file formats

[PProfizi]

This pull request introduces a comprehensive example DPF Python plugin for reading a custom file format ("MyFormat"). It includes all necessary components and sample data to demonstrate how to implement a fully functional DPF plugin, covering streams, mesh, results, and time-frequency support. Documentation is updated to reference this new tutorial.

MyFormat DPF Plugin Implementation:

• Added the my_format_plugin example package, which includes:

  • The main plugin entry point (my_format_plugin.py) that registers all custom operators with DPF.
  • Operators for streams, mesh info, mesh, result info, time-frequency support, and result data (displacement, temperature). [1] [2] [3]
  • Helper modules and sample data file (cube_harmonic.myf) for demonstration and testing. [1] [2]

• Each operator is implemented with clear specifications, input/output pin definitions, and uses a shared file reader to parse the custom format. [1] [2]

Documentation Updates:

• The tutorials index now includes a new card linking to the "Write a DPF Python plugin for a custom file format" tutorial, highlighting the new example and its capabilities.

Sample Data:

• Added a realistic .myf result file (cube_harmonic.myf) containing mesh, frequency, and result data, used by the plugin and referenced in the documentation.

These changes provide a complete, distributable reference for users to create their own DPF plugins for custom file formats.

• Requires feat: streams container creation #3051 to have been merged and integrated in the server's dpf-site.zip.

[PProfizi]

Hey @oparreno, here is a proposal of a new tutorial which showcases what we discussed.
The idea is to make this one public and a reference even if it is a dummy one.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.94%. Comparing base (35aed89) to head (8caf2e0).
✅ All tests successful. No failed tests found.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3065      +/-   ##
==========================================
- Coverage   83.01%   82.94%   -0.07%     
==========================================
  Files          93       93              
  Lines       11528    11528              
==========================================
- Hits         9570     9562       -8     
- Misses       1958     1966       +8     

[oparreno]

@PProfizi, typically we create a MyFormatStream where we would use the reader to read and populate our DPF Objects. This stream will cache the data so that we don't have to read it every time. We would create this function there.

[github-actions]

Some tests with 'continue-on-error: true' have failed:

• PyDPF-Post API tests on ubuntu-latest

Created by continue-on-error-comment

[oparreno]

@ricardopeixotocoelho, would you please also verify that this example uses the best practices we use for MAPDLOperators?