optimus.postprocess.io

Module Contents

Functions

export_to_file(model, post_process, global_parameters)

Export the simulation results into a file.

import_from_file(file_name)

Import the saved data from a file.

optimus.postprocess.io.export_to_file(model, post_process, global_parameters, file_name='optimus_exported_data', file_format='db')

Export the simulation results into a file.

Parameters
modeloptimus.model.Model

An instance of the optimus model object.

post_processoptimus.postprocess.PostProcess

An instance of the optimus postprocess object.

global_parametersAny

The global parameters of the simulation.

file_namestr

The export path and the file name in one string.

file_formatstr

‘mat’: to save ONLY the post_process results into a MATLAB file. ‘db’: (default) to save all the attributes of global parameters, source parameters, post processor and pickable objects of the model.

optimus.postprocess.io.import_from_file(file_name)

Import the saved data from a file.

Parameters
file_namestr

This string includes the file name (with path) and the file extension in one string. The supported extensions are ‘mat’ and ‘db’.

Returns
imported_datadict

A dictionary of different objects imported from the data file.