Getting started with Plugin

ParaView Support
1

Hi guys,
I am asking a newbie question. I recently started trying to use ParaView to build software that I can input some numbers and after a bunch of calculations, the results are plotted in ParaView. I can do this in the python script editor. However, I would like to add a GUI for the input and hide the source code in the background. After some googling, it seems the DockWidget plugin is the right place to start. (Please let me know if it is not)

I downloaded the DockWidget Plugin from the ParaView GitLab website but could not figure out how to use it. I tried Tools / Manage Extensions / Load New, but there are no supported files in the folder that I downloaded. Am I missing something?

If I would like to write my own plugins, do I have to install Qt?

I am using ParaView 5.11.0 under Windows.

Thank you.

2

Hi @allendu1988

After some googling, it seems the DockWidget plugin is the right place to start. (Please let me know if it is not)

Correct

I downloaded the DockWidget Plugin from the ParaView GitLab website but could not figure out how to use it. I tried Tools / Manage Extensions / Load New, but there are no supported files in the folder that I downloaded. Am I missing something?

Are you a C++ developer ?

If yes, then you need to compile ParaView and then compile the plugin.
If not, well, you need to do the same thing but the barrier of entry will be quite high.
https://kitware.github.io/paraview-docs/latest/cxx/PluginHowto.html

If I would like to write my own plugins, do I have to install Qt?

Yes, and then some, see ParaView compilation guide here:
https://gitlab.kitware.com/paraview/paraview/-/blob/master/Documentation/dev/build.md#getting-started-guide

You may also be interested by a ParaView dev course. There is no course planned for this year in the US afaik but here is how it looked in 2022: https://www.kitware.com/upcoming-training-courses-for-paraview-and-cmake/

https://www.kitware.com/support/

3

Thank you very much for the reply Mathieu. The course looks very useful. I will keep an eye on the website for future registration when it is available.

I have two more follow-up questions. First, there is a way to pass the inputs in DockWidget panels to the python script, right?

Second, if I compile ParaView with my own written Plugin into a binary file, I can install it on other computers without the need for compiling or installing Qt, right? I am working on a project that will lead to some computing software with ParaView for its visualization end, and the software will be used by other engineers in the future. It will be OK for them to install ParaView, but installing Qt seems to be too much …

Thank you!

4

You should indeed be able to run arbitrary python code from your dock widgets without any issue.

I can install it on other computers without the need for compiling or installing Qt, right? I am working on a project that will lead to some computing software with ParaView for its visualization end, and the software will be used by other engineers in the future. It will be OK for them to install ParaView, but installing Qt seems to be too much …

I’m afraid not. You need a special techniques to be compatible with ParaView binary release.

Do not hesitate to reach out to Kitware for help as well: https://www.kitware.com/commercial/support/