From 346dde658515967912652ba372f38ee5f729f8d6 Mon Sep 17 00:00:00 2001 From: Eli Talbert Date: Mon, 20 May 2024 10:45:25 -0400 Subject: [PATCH] documentation update --- README.md | 8 +++++++- geochron/convert.py | 3 +++ 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 83e9ca2..3a1f3c8 100644 --- 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 index 676328e..0fe983f 100644 --- 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