From 162bc9686a48eb35a2c8bb2b630b62bb5195d9e9 Mon Sep 17 00:00:00 2001
From: Yansheng Wang <yanshengw@rivosinc.com>
Date: Tue, 30 Jul 2024 14:28:59 -0700
Subject: [PATCH] update user manual

---
 docs/Home/Classes.md          | 11 +++++++++
 docs/Home/Integrated-Flows.md | 46 +++++++++++++++++++++++++++++++++++
 docs/Home/User-Manual.md      |  6 ++++-
 3 files changed, 62 insertions(+), 1 deletion(-)
 create mode 100644 docs/Home/Classes.md
 create mode 100644 docs/Home/Integrated-Flows.md

diff --git a/docs/Home/Classes.md b/docs/Home/Classes.md
new file mode 100644
index 0000000..4369b96
--- /dev/null
+++ b/docs/Home/Classes.md
@@ -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
diff --git a/docs/Home/Integrated-Flows.md b/docs/Home/Integrated-Flows.md
new file mode 100644
index 0000000..8717358
--- /dev/null
+++ b/docs/Home/Integrated-Flows.md
@@ -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)
+```
diff --git a/docs/Home/User-Manual.md b/docs/Home/User-Manual.md
index fd59aaa..691c3db 100644
--- a/docs/Home/User-Manual.md
+++ b/docs/Home/User-Manual.md
@@ -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)