Module Config Schema

SIMBA Module Configuration

The schema describes the configuration file provided to the module.

https://raw.githubusercontent.com/NSSAC/SIMBA_driver/master/schema/module.json
type	object
properties
mode	Mode
	The mode of execution of the module.
	type	string
	enum	start, step, end
outputDirectory	Output Directory
	The base output directory
	type	string
statusFile	Status File
	The file in which the return status, updated common, and module data is expected.
	type	string
lastRunTick	Last Run Tick
	The last run tick (not provided for mode: start).
	type	number
	multipleOf	1
lastRunTime	Last Run Date Time
	The last run date time in ISO format (not provided for mode: start).
	type	string
	format	date-time
currentTick	Current Tick
	The current tick.
	type	number
	multipleOf	1
currentTime	Current Date Time
	The current date time in ISO format.
	type	string
	format	date-time
targetTick	Target Tick
	The target tick (not provided for modes: start, end).
	type	number
	multipleOf	1
targetTime	Target Date Time
	The target date time in ISO format (not provided for modes: start, end).
	type	string
	format	date-time
tickFormat	Format tick to string.
	A Python The target date time in ISO format (not provided for modes: start, end).
	type	string
	format	date-time
commonData	Common Data
	Common data provided to all modules upon execution.
	type	object
moduleData	Module specific Data
	Module specific data taken from the module schedule.
	type	object