Plugins

Overview

AutoBench also supports a feature that can be used to specialize a function tailored to your needs. The idea is to enable experimentation and merge changes into the codebase as they mature or for common use.

Grabber

Currently, we have the grabber plugin which captures the system context and hooks into the generate_job_submission_list function to add commands to the job script at the start.

To test this plugin, enable hooks in the .env file by setting ENABLE_HOOKS=1. Also, add some repository URLs for GRABBER_APP_REPO and CONTEXT_STORAGE_REPO. Then, run the following command for job script generation: autobench jobscript generate --archive.

Customisation

To create a custom plugin, simply clone the file autobench/plugins/plugin_grabber.py and add @hookable at the top of the function you wish to hook. Then define the overriding function with @register_hook, which runs after the normal function.