-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
0fbaf7d
commit 162bc96
Showing
3 changed files
with
62 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- | ||
SPDX-FileCopyrightText: 2024 Rivos Inc. | ||
SPDX-License-Identifier: Apache-2.0 | ||
--> | ||
|
||
# OpenSIPI Configuration Files | ||
|
||
# OpenSIPI Functions and Classes References | ||
- Integrated Flows | ||
- Classes |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
<!-- | ||
SPDX-FileCopyrightText: 2024 Rivos Inc. | ||
SPDX-License-Identifier: Apache-2.0 | ||
--> | ||
|
||
# Integrated Flows | ||
|
||
## 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. | ||
|
||
Variables: | ||
- input_info: dict, input related information | ||
|
||
input_type: str, input file type. "csv" or "gsheet". | ||
|
||
input_dir: str, directory of input csv files. This key is mandatory if input_type = "csv". | ||
|
||
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". | ||
|
||
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. | ||
|
||
- mntr_info: dict, monitor related information | ||
|
||
email: str, email address to receive notifications. NOT ENABLED YET! | ||
|
||
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 = { | ||
"input_dir": r"C:\SIPIProj\Olympus\Sim_Input" + "\\", | ||
"input_type": "csv", | ||
"input_folder": "Sigrity_PDN", | ||
"op_run_name": "", | ||
} | ||
|
||
mntr_info = { | ||
"email": "", | ||
"op_pause_after_model_check": 1, | ||
} | ||
|
||
sim2report(input_info, mntr_info) | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters