canns 0.12.6__py3-none-any.whl → 0.13.0__py3-none-any.whl

canns/__init__.py

@@ -1,3 +1,16 @@
+"""Top-level package for CANNs.
+
+This module exposes the main namespaces so you can import them directly from
+``canns`` (for example, ``canns.data`` or ``canns.trainer``). It also provides
+simple version metadata.
+
+Examples:
+    >>> import canns
+    >>> print(canns.__version__)
+    >>> print(canns.version_info)
+    >>> print(list(canns.data.DATASETS))
+"""
+
 from . import analyzer as analyzer
 from . import data as data
 from . import models as models
@@ -7,11 +20,34 @@ from . import utils as utils
 
 # Version information
 try:
-    from ._version import __version__, version_info
+    from ._version import __version__ as _version
+    from ._version import version_info as _version_info
 except ImportError:
     # Fallback if _version.py is not available (e.g., during documentation build)
-    __version__ = "unknown"
-    version_info = (0, 0, 0, "unknown")
+    _version = "unknown"
+    _version_info = (0, 0, 0, "unknown")
+
+__version__ = _version
+"""Human-readable package version string.
+
+This is usually derived from the installed package metadata. When that
+information is unavailable, it falls back to ``"unknown"``.
+
+Examples:
+    >>> import canns
+    >>> print(canns.__version__)
+"""
+
+version_info = _version_info
+"""Version information as a tuple.
+
+The tuple typically follows ``(major, minor, patch)``. A development or
+documentation build may return a fallback value instead.
+
+Examples:
+    >>> import canns
+    >>> print(canns.version_info)
+"""
 
 __all__ = [
     "analyzer",

canns/analyzer/__init__.py

@@ -1,11 +1,12 @@
 """Analyzer utilities for inspecting CANNs models and simulations.
 
-NEW STRUCTURE:
-├── metrics/           - Model metrics computation
-├── visualization/     - Model visualization and animation
-├── data/              - Data analysis (experimental & synthetic)
-├── slow_points/       - Fixed point analysis
-└── model_specific/    - Specialized model analyzers
+This namespace groups analysis helpers such as model metrics, visualization,
+experimental or synthetic data analysis, slow-point (fixed-point) analysis,
+and model-specific tools.
+
+Examples:
+    >>> from canns import analyzer
+    >>> print(analyzer.__all__)
 """
 
 from . import data, metrics, model_specific, slow_points, visualization

canns/analyzer/data/__init__.py

@@ -1,13 +1,5 @@
-"""Data analysis utilities for experimental and synthetic neural data.
+"""Data analysis utilities for experimental and synthetic neural data."""
 
-This module provides tools for analyzing neural recordings (spike trains,
-firing rates) and extracting features like bump positions, topological
-structures, and population dynamics.
-"""
+from .asa import *  # noqa: F401,F403
 
-from . import cann1d, cann2d
-
-__all__ = [
-    "cann1d",
-    "cann2d",
-]
+__all__ = list(locals().get("__all__", []))

canns/analyzer/data/asa/__init__.py

@@ -0,0 +1,74 @@
+from __future__ import annotations
+
+# Coho-space analysis + visualization
+from .cohospace import (
+    compute_cohoscore,
+    plot_cohospace_neuron,
+    plot_cohospace_population,
+    plot_cohospace_trajectory,
+)
+from .config import (
+    CANN2DError,
+    CANN2DPlotConfig,
+    Constants,
+    DataLoadError,
+    ProcessingError,
+    SpikeEmbeddingConfig,
+    TDAConfig,
+)
+from .decode import decode_circular_coordinates, decode_circular_coordinates_multi
+from .embedding import embed_spike_trains
+from .fr import (
+    FRMResult,
+    compute_fr_heatmap_matrix,
+    compute_frm,
+    plot_frm,
+    save_fr_heatmap_png,
+)
+
+# Path utilities
+from .path import align_coords_to_position, apply_angle_scale
+
+# Higher-level plotting helpers
+from .plotting import (
+    plot_2d_bump_on_manifold,
+    plot_3d_bump_on_torus,
+    plot_cohomap,
+    plot_cohomap_multi,
+    plot_path_compare,
+    plot_projection,
+)
+
+# TDA entry point
+from .tda import tda_vis
+
+__all__ = [
+    "SpikeEmbeddingConfig",
+    "TDAConfig",
+    "CANN2DPlotConfig",
+    "Constants",
+    "CANN2DError",
+    "DataLoadError",
+    "ProcessingError",
+    "embed_spike_trains",
+    "tda_vis",
+    "decode_circular_coordinates",
+    "decode_circular_coordinates_multi",
+    "plot_projection",
+    "plot_path_compare",
+    "plot_cohomap",
+    "plot_cohomap_multi",
+    "plot_3d_bump_on_torus",
+    "plot_2d_bump_on_manifold",
+    "compute_fr_heatmap_matrix",
+    "save_fr_heatmap_png",
+    "FRMResult",
+    "compute_frm",
+    "plot_frm",
+    "plot_cohospace_trajectory",
+    "plot_cohospace_neuron",
+    "plot_cohospace_population",
+    "compute_cohoscore",
+    "align_coords_to_position",
+    "apply_angle_scale",
+]