sim_config_format - 24leesten/SimU-Wiki GitHub Wiki

Simulation Config Format

{
  "preprocessing": boolean,
  "postprocessing": boolean,
  "save_data" : boolean,
  "cmd" : boolean,
  "params" : {
    param_name : {
      "type" : string,
      "flag" : string,
      "order": int
    },
    ...	
  },
  "pre_params" : {
    param_name : {
	   "type" : string,
	   "flag" : string,
	   "order": int
    },
    ...	
  },
  "post_params" : {
    param_name : {
	  "type" : string,
	  "flag" : string,
	  "order": int
    },
    ...	
  }
}

preprocessing and postprocessing

These are simply to specify if your package will be using preprocessing and/or postprocessing

save_data

If false, the working directory for simulations run will be deleted upon completion, other wise it is saved in the executions directory, see Simulation Access Manager

cmd

If true, this will execution your application using command line arguements to pass in the parameters, otherwise it will dump the parameters into a json dictionary which will be passed as the first and only arguement to the application.

params, pre_params, post_params

Each of these specify the parameters for the application, preprocessing, and postprocessing respectively. "pre_params", and "post_params" are only necessary if the package utilized preprocessing or postprocessing. The value is a dictionary which contains a list of parameter names. These will match the names that are put into the website database. Each "param_name" is a key for a dictionary that describes the parameter. "type" is the parameter type of the parameter (i.e. "str", "int", "float"). "flag" specifies the flag for an aruemnt, use an empty string if there is none. The value of "flag" will be appended to the beginning of parameter value if "cmd" is true. "order" is the priorty of the parameter to appear in the argument list if "cmd" is true. This is used for passing postional arguments.