Usage

This software can be used in a few different ways. To run processing workflows, called ‘procedures’, there is a command line cli, that resides in main.py and runs workflow files on given cnv data files. The workflow files configure everything needed to run a porcessing procedure and are easy to understand and write. There is a small gui available, to help writing and editing workflow files, which can be found in processing.gui.procedure_config_view.py .

_images/procedure_gui.png

Another way is to run processing procedures directly from your python code, using either workflow files or the fact that these workflows correspond to a basic python dictionary internally. This allows for quick scripts that can use flexible input variables.

_images/procedure_dict_example.png

In the near future, there will be a general entry function to the tool set, maybe even with a GUI.

Also, one development goal remains to rewrite all Sea-Bird processing modules as more modern, flexible python modules, which would lead to an end of all the file reading and writing processes, as all the data processing steps could run on one internal python object, representing a Sea-Bird data file. We will stick to this file architecture to ensure future compatibility with other processing workflows, relying on the original Sea-Bird processing modules.