easyvvuq.decoders package

Submodules

easyvvuq.decoders.base module

Provides baseclass for all decoders and dictionary to register all imported decoders.

Decoders are objects which provide functions to check simulation runs have completed and parse the output when they have.

ivar AVAILABLE_DECODERS:
 Registers all imported decoders.
vartype AVAILABLE_DECODERS:
 dict
class easyvvuq.decoders.base.BaseDecoder

Bases: easyvvuq.base_element.BaseElement

Baseclass for all EasyVVUQ decoders.

Skeleton decoder which establishes the format and provides the basis of our contract - <need to define contract>.

static deserialize(decoderstr)
element_category()
element_name()
is_restartable()
parse_sim_output(run_info=None)
Parameters:
  • run_info (dict or None) – Information defining the run for which we want to parse the output.
  • *args – Variable length argument list.
  • **kwargs – Arbitrary keyword arguments.
sim_complete(run_info=None)

Check whether the simulation specified by run_info has completed and produced results.

Parameters:run_info (dict or None) – Information defining the run to check.

easyvvuq.decoders.json module

class easyvvuq.decoders.json.JSONDecoder(target_filename=None, output_columns=None)

Bases: easyvvuq.decoders.base.BaseDecoder

decoder_name = 'json'
element_version()
get_restart_dict()
parse_sim_output(run_info={})
Parameters:
  • run_info (dict or None) – Information defining the run for which we want to parse the output.
  • *args – Variable length argument list.
  • **kwargs – Arbitrary keyword arguments.
sim_complete(run_info=None)

Check whether the simulation specified by run_info has completed and produced results.

Parameters:run_info (dict or None) – Information defining the run to check.

easyvvuq.decoders.simple_csv module

class easyvvuq.decoders.simple_csv.SimpleCSV(target_filename, output_columns)

Bases: easyvvuq.decoders.base.BaseDecoder

decoder_name = 'csv'
element_version()
get_restart_dict()
parse_sim_output(run_info={})
Parameters:
  • run_info (dict or None) – Information defining the run for which we want to parse the output.
  • *args – Variable length argument list.
  • **kwargs – Arbitrary keyword arguments.
sim_complete(run_info=None)

Check whether the simulation specified by run_info has completed and produced results.

Parameters:run_info (dict or None) – Information defining the run to check.

easyvvuq.decoders.yaml module

class easyvvuq.decoders.yaml.YAMLDecoder(target_filename=None, output_columns=None)

Bases: easyvvuq.decoders.json.JSONDecoder

decoder_name = 'yaml'

Module contents