Merge pull request #8 from berenslab/better_api

Better APIs

Author: huangziwei

README.md

@@ -1,6 +1,6 @@
 # pywarper
 
-`pywarper` is a Python package for conformal mapping-based warping of neuronal arbor morphologies, based on the [MATLAB implementations](https://github.com/uygarsumbul/rgc) (Sümbül, et al. 2014). 
+`pywarper` is a Python package for conformal mapping-based warping of neuronal morphologies, based on the [MATLAB implementations](https://github.com/uygarsumbul/rgc) (Sümbül, et al. 2014). 
 
 ![](.github/banner.png)
 

notebooks/example.api.high.ipynb

@@ -4,16 +4,16 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pywarper"
-version = "0.1.10"
-description = "Conformal mapping-based warping of neuronal arbor morphologies."
+version = "0.2.0"
+description = "Conformal mapping-based warping of neuronal morphologies."
 authors = []
 requires-python = ">=3.10.0"
 dependencies = [
     "alphashape>=1.3.1",
     "numpy>=2.2.0",
     "pygridfit>=0.1.5",
     "scipy>=1.15.0",
-    "skeliner>=0.1.3",
+    "skeliner>=0.1.6",
     "watermark>=2.5.0",
 ]
 license = "GPL-3.0-or-later"

notebooks/example.api.low.ipynb

@@ -1,3 +1,10 @@
-from .warper import Warper
+from importlib.metadata import PackageNotFoundError, version
 
-__all__ = ["Warper"]
+from .warpers import Warper
+
+__all__ = ["Warper"]
+
+try:
+    __version__ = version(__name__)       
+except PackageNotFoundError:              
+    __version__ = "0.0.0.dev0"

pyproject.toml

@@ -44,6 +44,9 @@
     )
     print(_WARN_MSG)
 
+from importlib import metadata as _metadata
+
+_PYWARPER_VERSION = _metadata.version("pywarper")
 
 def fit_sac_surface(
     x: np.ndarray,
@@ -775,5 +778,7 @@ def build_mapping(
         "sampled_y_idx": sampled_y_idx, # formerly `thisy`
         "on_sac_surface": on_sac_surface, # formerly `thisVZminmesh`
         "off_sac_surface": off_sac_surface, # formerly `thisVZmaxmesh`
-        "n_anchors": n_anchors
+        "n_anchors": n_anchors,
+        "conformal_jump": conformal_jump,
+        "meta": {"mapped_at": time.strftime("%Y-%m-%d %H:%M:%S"), "pywarper_version": _PYWARPER_VERSION}
     }