threadlepy 0.1.3__tar.gz → 0.1.4__tar.gz

{threadlepy-0.1.3 → threadlepy-0.1.4}/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.1.4
+
+- Added the `return_histograms` option to `rwfpt()` / `th_rwfpt()` to match the current threadleR wrapper.
+
 ## 0.1.3
 
 - Aligned `load_examples()` with threadleR behavior by assigning example handles by default and restoring the previous Threadle working directory after loading.

{threadlepy-0.1.3/src/threadlepy.egg-info → threadlepy-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: threadlepy
-Version: 0.1.3
+Version: 0.1.4
 Summary: Python client for the Threadle CLI JSON interface.
 Author: Yukun Jiao
 License-Expression: MIT

{threadlepy-0.1.3 → threadlepy-0.1.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "threadlepy"
-version = "0.1.3"
+version = "0.1.4"
 description = "Python client for the Threadle CLI JSON interface."
 readme = "README.md"
 requires-python = ">=3.9"

{threadlepy-0.1.3 → threadlepy-0.1.4}/scripts/test_all_commands_example_data.py

@@ -253,6 +253,25 @@ def run(threadle_path: str | None = None, *, timeout: float = 1800.0) -> int:
         )
         show("info rw distances", lambda: th.info(rw_distances))
         show("info rw fpt", lambda: th.info(rw_fpt))
+        rw_fpt_hist = show(
+            "rw fpt with histograms",
+            lambda: th.rwfpt(
+                "rw_fpt_hist",
+                walk_net,
+                attrname="group",
+                maxsteps=30,
+                layernames="walk_layer",
+                walkfactor=0.5,
+                minpairobs=1,
+                balanced=False,
+                weighted=False,
+                return_histograms=True,
+            ),
+        )
+        show(
+            "info rw fpt histogram network",
+            lambda: th.info(rw_fpt_hist["network"] if isinstance(rw_fpt_hist, dict) else rw_fpt_hist),
+        )
 
         # Miscellaneous session helpers.
         show("setting verbose false", lambda: th.setting("verbose", False))

{threadlepy-0.1.3 → threadlepy-0.1.4}/src/threadlepy/__init__.py

@@ -2,7 +2,7 @@
 
 from .client import ThreadleStruct, configure, is_available, raw_cmd, session, start, stop
 
-__version__ = "0.1.3"
+__version__ = "0.1.4"
 
 __all__ = [
     "ThreadleStruct",

{threadlepy-0.1.3 → threadlepy-0.1.4}/src/threadlepy/commands.py

@@ -735,14 +735,21 @@ def rwfpt(
     minpairobs: int = 10,
     balanced: bool = False,
     weighted: bool = False,
+    return_histograms: bool = False,
     layername: Optional[Union[str, list[str], tuple[str, ...]]] = None,
 ):
     """Estimate category mean first-passage times with random walks and return a result network handle."""
     if layername is not None and not layernames:
         layernames = layername
     layernames = _collapse(layernames)
-    call("rwfpt", locals(), assign=name, drop=("layername",))
-    return _handle(name)
+    args = locals().copy()
+    if return_histograms:
+        args["returnhistograms"] = "true"
+    payload = call("rwfpt", args, assign=name, drop=("layername", "return_histograms"))
+    network_handle = _handle(name)
+    if return_histograms and payload is not None:
+        return {"network": network_handle, "histograms": payload}
+    return network_handle
 
 
 def random_seed(seed: int = 6031769):

{threadlepy-0.1.3 → threadlepy-0.1.4/src/threadlepy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: threadlepy
-Version: 0.1.3
+Version: 0.1.4
 Summary: Python client for the Threadle CLI JSON interface.
 Author: Yukun Jiao
 License-Expression: MIT