Some documentation for general simplicial complexes.

1 files changed, 13 insertions, 4 deletions

diff --git a/phstuff/diphawrapper.py b/phstuff/diphawrapper.py
index b2c9444..4d1742e 100644
--- a/phstuff/diphawrapper.py
+++ b/phstuff/diphawrapper.py
@@ -187,6 +187,19 @@ def save_cubical(fname, array):
             f.write(struct.pack("<d", float(w)))
 
 def save_simplicial(fname, complex):
+    """*EXPERIMENTAL*. Save a filtered simplicial complex.
+
+    Corresponds to DIPHA's "weighted boundary matrix".
+
+    Parameters:
+    -----------
+    
+    fname: Name of file to write.
+
+    complex: Simplicial complex to save.
+
+    """
+        
     complex.order()
     assert(complex.is_ordered())
     
@@ -221,10 +234,6 @@ def save_simplicial(fname, complex):
                 f.write(struct.pack("<q", bnode.i))
             
             
-    
-    
-            
-
 def load_barcode(fname, top_dim = None):
 
     """Load a barcode as written by DIPHA.