emod_api.schema_to_class module#

class emod_api.schema_to_class.ReadOnlyDict[source]#

Bases: OrderedDict

set_schema(schema)[source]#

Add schema node.

to_file(config_name='config.json')[source]#

Write ‘clean’ config file out to disk as json. Param: config_name (defaults to ‘config.json’)

finalize(show_warnings: bool = False)[source]#

Remove all params that are disabled by depends-on param being off and schema node.

emod_api.schema_to_class.clear_schema_cache()[source]#

Clear cached version of the schema.

emod_api.schema_to_class.get_class_with_defaults(classname, schema_path=None, schema_json=None, show_warnings: bool = False)[source]#

Return the default parameter values for a datatype defined in schema.

Parameters:

  • classname (str) – Name of target datatype

  • schema_path (str) – Filename of schema: DEPRECATED, use schema_json instead

  • schema_json (dict) – Contents of schema file

  • show_warnings (bool) – Show warning associated with NodeSet

Returns:

Default parameter values for requested datatype

Return type:

(dict)