Home

What is BQ_module_generator?

Standardizes and automates the process of creating modules that can be integrated into the Bisque web application. This command-line interface (CLI) supports multiple inputs and outputs of type image, table, or file. Output images will be displayed in the module results section in Bisque while tables and file outputs will have links to their respective resource service where they can be downloaded and visualized. Take a look at Official Bisque Documentation for a full guide on how module creation works from scratch. The XML section will provide you with some common features that users might want to include in their module and how to define them in the xml.

What Problem Does BQ_module_generator Solve?

The development of Bisque modules can be tedious and time-consuming because it involves writing the necessary code to communicate between the module source code and the Bisque web application. This involves getting well acquainted with the Bisque API which has a steep learning curve if you are not familiar with web application architectures. BQ_module_generator decouples the communication and source code so users that want to build a module don't need to learn the Bisque API. Writing a single function with standardized naming conventions and setting the proper configurations with the bqmod CLI will generate all the necessary files to deploy on Bisque.

A module on Bisque needs``

TODO

• Files necessary to build module
• What each file does /what is the workflow of how bisque runs a module
• What are we automating what are we not