Skip to content

Commit

Permalink
Update Integrated-Flows.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Bellwether889 authored Jul 31, 2024
1 parent 96580b8 commit 0bed26a
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions docs/Home/Integrated-Flows.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,28 @@ SPDX-License-Identifier: Apache-2.0

## sim2report(input_info, mntr_info)

Usage: This function takes csv input info to the Platform, parses them into scripts to automate S-para extraction, processes results and generates a report.
**Usage**:

Variables:
- input_info: dict, input related information
This function takes csv input info to the Platform, parses them into scripts to automate S-para extraction, processes results and generates a report.

input_type: str, input file type. "csv" or "gsheet".
**Inputs**:
- **input_info**: dict, input related information

input_dir: str, directory of input csv files. This key is mandatory if input_type = "csv".
**_input_type_**: str, input file type. "csv" or "gsheet".

input_folder: str, folder name of the input csv files, the specified folder contains the required input info for a specific extraction type like PDN, LSIO, HSIO etc. This key is mandatory if input_type = "csv".
**_input_dir_**: str, directory of input csv files. This key is mandatory if _input_type_ = "csv".

op_run_name: \[optional\], str, the time stamp of the "Run" folder. It should be omitted or assigned empty string by default. Each time an extraction starts, a folder called "Run_(time stamp)" is created automatically. In order to hack into an existing Run folder, set the existing time stamp to this key.
**_input_folder_**: str, folder name of the input csv files, the specified folder contains the required input info for a specific extraction type like PDN, LSIO, HSIO etc. This key is mandatory if _input_type_ = "csv".

- mntr_info: dict, monitor related information
**_op_run_name_**: \[optional\], str, the time stamp of the "Run" folder. It should be omitted or assigned empty string by default. Each time an extraction starts, a folder called "Run_(time stamp)" is created automatically. In order to hack into an existing Run folder, set the existing time stamp to this key.

email: str, email address to receive notifications. NOT ENABLED YET!
- **mntr_info**: dict, monitor related information

op_pause_after_model_check: int, 1-> flow pauses after model check is done, 0-> flow doesn't pause. If the key is omitted, 0 is applied by default.
**_email_**: str, email address to receive notifications. NOT ENABLED YET!

Example:
**_op_pause_after_model_check_**: int, 1-> flow pauses after model check is done, 0-> flow doesn't pause. If the key is omitted, 0 is applied by default.

**Example**:

```python
input_info = {
Expand Down

0 comments on commit 0bed26a

Please sign in to comment.