documentation update

etalbert102 · May 20, 2024 · 346dde6 · 346dde6
1 parent e8e3da5
commit 346dde6
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -34,9 +34,15 @@ Geostructures FeatureCollections can take most major geospatial standards like s
 ```python
 from geochron import convert
 
-desired_output = convert(fcol=Feature_Collection_of_time_shapes, datastructure= "timehex",
+timehex_output = convert(fcol=Feature_Collection_of_time_shapes, datastructure= "timehex",
 hour_interval= 1, res= 10)
 
+chronnet_output = convert(fcol=Feature_Collection_of_time_shapes, datastructure= "chronnet",
+hour_interval= 1, res= 10, self_loop = True, mode = "directed")
+
+geotimehash_output = convert(fcol=Feature_Collection_of_time_shapes, datastructure= "geotimehash",
+hour_interval= 1, res= 10, precision = 8)
+
 ```
 
 

diff --git a/geochron/convert.py b/geochron/convert.py
@@ -30,6 +30,9 @@ def convert(fcol: FeatureCollection, datastructure: str,
         mode: (str) (Default directed)
             Applies to chronnets only whether network is
             directed or not
+        precision: (int) (No default)
+            Applies to geotimehash only precision level
+            of time hashes
 
     Returns:
         Desired geotime representation