Custom Script Module

PLACE module for running a user specified script

class place.plugins.custom_script_1.custom_script_1.CustomScript1(config, plotter)

The custom script class

config(metadata, total_updates)

Validate that the requested scripts exists.

There is one script each for config, update, and cleanup phases. This can be used to test if your code is ready to be put into an official PLACE module.

Parameters:

• metadata (dict) – metadata for the experiment
• total_updates (int) – number of update that will be performed

Raises:

RuntimeError – if a requested script cannot be found

update(update_number, progress)

Run the script.

Parameters:

• update_number (int) – the count of the current update (0-indexed)
• progress (dict) – A blank dictionary for sending data back to the frontend

Returns:

the exit code of the script

Return type:

dtype=[(‘count’, ‘int16’), (‘trace’, ‘float64’, self._samples)])

cleanup(abort=False)

No action needed at this time.

Parameters:abort (bool) – True if the experiement is being aborted