Skip to content
GitLab

Add plugins

Merged payno requested to merge fix_4 into master

TODO

  • Add a plugin system to let the user define some output in the final hdf5 file
  • Add documentation

HOW TO

The user define a folder containing the python plugin. Environment variable to set: NXTOMOMILL_PLUGINS_DIR Then nxtomomill parse all the classes contained and check if they are instance of '_PluginBase'

Then for conveniance (we parse the file only one time) the user should specify the key he will use. for now we only manage keys from positioners. Can be extended if necessary later. And then he can access those from 'get_positioner_info' and do basically what he likes during write. Limited but enough for a first version I guess.

You can see here an example of a plugin file:

limitation

  • this let the user pretty 'free'. Maybe we could add an extra layer and force them to define unit ?
  • for now consider all the information the user can need are store in the positioners info.
  • will generate warnings if missing keys even if the user create itself the requested output (can be managed by requesting user the path they intent to create).

EXTRA

close #4 (closed)

Edited by payno