The plugins.py module#

Summary#

load_plugin_on_server

Load a DPF Python plugin on the global or given DPF server.

Description#

Python DPF plugins utilities.

Contains the utilities specific to installing and using Python DPF plugins.

Module detail#

plugins.load_plugin_on_server(plugin: str | pathlib.Path, server: ansys.dpf.core.AnyServerType = None, symbol: str = 'load_operators', generate_operators: bool = False)#

Load a DPF Python plugin on the global or given DPF server.

Parameters:

  • plugin – Path to the DPF Python plugin to load.

  • server – DPF server to load the plugin onto.

  • symbol – Name of the function recording the operators in the plugin.

  • generate_operators – Whether to generate the Python code for the operators in the plugin.