Skip to content

Commit

Permalink
update user manual
Browse files Browse the repository at this point in the history
  • Loading branch information
Bellwether889 committed Jul 30, 2024
1 parent 0fbaf7d commit 162bc96
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 1 deletion.
11 changes: 11 additions & 0 deletions docs/Home/Classes.md
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
46 changes: 46 additions & 0 deletions docs/Home/Integrated-Flows.md
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)
```
6 changes: 5 additions & 1 deletion docs/Home/User-Manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,8 @@ SPDX-FileCopyrightText: 2024 Rivos Inc.
SPDX-License-Identifier: Apache-2.0
-->

Test
# OpenSIPI Configuration Files

# OpenSIPI Functions and Classes References
- [Integrated Flows](/docs/Home/Integrated-Flows.md)
- [Classes](/docs/Home/Classes.md)

0 comments on commit 162bc96

Please sign in to comment.