update comments and api document for stepspy

changgang · Feb 2, 2021 · 65d5c87 · 65d5c87
1 parent e863709
commit 65d5c87
Show file tree

Hide file tree

Showing 3 changed files with 250 additions and 105 deletions.
diff --git a/python/extract_stepspy_apis.py b/python/extract_stepspy_apis.py
@@ -1,5 +1,5 @@
 # program to extract stepspy APIs to text file.
-with open("./stepspy-current/stepspy/stepspy2.py","rt") as fid_stepspy:
+with open("./stepspy-current/stepspy/stepspy.py","rt") as fid_stepspy:
     with open("stepspy_api.txt","wt") as fid_api:
         napi = 0
         while True:

diff --git a/python/stepspy-current/stepspy/stepspy.py b/python/stepspy-current/stepspy/stepspy.py
@@ -4293,9 +4293,12 @@ def save_network_Y_matrix(self, file, export_full=False):
         """
         Save newwork complex Y matrix to file.
         Args:
-            (1) file: String of target file name.
+            (1) file: String of target file name of sparse Y matrix. If export_full is True, then 'full_' is appended to the head of file name for full matrix. 
+            (2) export_full: boolean. False for saving only the sparse network matrix. True for saving both sparse and full network matrix.
         Rets: N/A
-        Example: N/A
+        Example:
+            simulator.save_network_Y_matrix("y.csv") # save only sparse matrix to y.csv
+            simulator.save_network_Y_matrix("y.csv", True) # save both sparse and full matrix to y.csv and full_y.csv respectively
         """
         global STEPS_LIB
         file = self.__get_c_char_p_of_string(file)