run_analysis

czmtestkit.py_modules.run_analysis(JobID, analysis_func, setup_func=None)

Sequentially run python functions using dictionaries from the Database.json. (See example from run_sim() for details on generating the Database.json). Output dictionary items are appended to the Database.json file.

Parameters

JobID (str): ID for colleciton of tests in the design of experiments.

analysis_func (function object): Post processing function using output from run_sim().

setup_func (function object): Setup for the post processing function.

Example

To analyze data from the Database generated with run_sim() for example:

$ <current working directory>
└── ExampleDOE
    ├── point_00
    ├── point_01
    ├── point_02
    ├── point_03
    └── Database.json

Database.json

{'param_1': value_param1, ..., 'output2': value0_out2}
{'param_1': value_param1, ..., 'output2': value1_out2}
{'param_1': value_param1, ..., 'output2': value2_out2}
{'param_1': value_param1, ..., 'output2': value3_out2}

using an analysis function that uses a dictionary from the Database as input. For example:

def analysisFunc(dict):
    ...
    return {'analysisOut1': <value>}


dictIn = {'param_1': value_param1, ..., 'output2': value0_out2}
dictOut = analysisFunc(dictIn)

run_analysis() can be used to iterate through the entries in the Database and append the resulting dictionary items to the database. Running the following code

run_analysis('ExampleDOE', analysisFunc)

will result in updated Database.json.

Database.json

{'param_1': value_param1, ..., 'output2': value0_out2,'analysisOut1': value0_out3}
{'param_1': value_param1, ..., 'output2': value1_out2,'analysisOut1': value1_out3}
{'param_1': value_param1, ..., 'output2': value2_out2,'analysisOut1': value2_out3}
{'param_1': value_param1, ..., 'output2': value3_out2,'analysisOut1': value3_out3}

Metadata

Environment

Python

Version

v1.0.0

Date

2021-12-11

Authors

Nanditha Mudunuru

Contribution: v1.0.0

Email: nanditha.mudunuru@gmail.com