porecast 0.0.1__py3-none-any.whl

porecast/__init__.py

@@ -0,0 +1,41 @@
+"""porecast — forecast electrophysiology from single-cell ion-channel expression.
+
+Method companion to the CATION ion-channel cell atlas. The ion-channel analogue
+of ``hormone2cell``, with the key distinction that ion-channel composition maps
+quantitatively to a measurable biophysical output (the action potential, V(t)),
+so ``porecast`` predicts *function*, not just expression.
+
+Planned public API (three tiers, implemented in a later release):
+
+    >>> import porecast as pc
+    >>> fp   = pc.fingerprint(adata)            # tier 1: ion-channel signature per cell type
+    >>> pred = pc.excitability(adata)           # tier 2: excitable vs non-excitable (ML)
+    >>> hh   = pc.model(cell_type="L5 ET")      # tier 3: Hodgkin-Huxley -> V(t)
+    >>> hh.spike(current_injection=40)
+
+This is the name-reservation release (0.0.1). The full implementation ships with
+the CATION atlas publication.
+"""
+from __future__ import annotations
+
+__version__ = "0.0.1"
+__all__ = ["__version__"]
+
+# Sentinel so `import porecast` works and `porecast.__version__` reports cleanly.
+_NOT_IMPLEMENTED_MSG = (
+    "porecast {v} is a name-reservation release. The full implementation "
+    "(fingerprint, excitability, Hodgkin-Huxley inference) ships with the CATION "
+    "ion-channel cell atlas publication. See https://cationatlas.com"
+).format(v=__version__)
+
+
+def fingerprint(*args, **kwargs):  # pragma: no cover - reserved signature
+    raise NotImplementedError(_NOT_IMPLEMENTED_MSG)
+
+
+def excitability(*args, **kwargs):  # pragma: no cover - reserved signature
+    raise NotImplementedError(_NOT_IMPLEMENTED_MSG)
+
+
+def model(*args, **kwargs):  # pragma: no cover - reserved signature
+    raise NotImplementedError(_NOT_IMPLEMENTED_MSG)

porecast-0.0.1.dist-info/METADATA

@@ -0,0 +1,71 @@
+Metadata-Version: 2.4
+Name: porecast
+Version: 0.0.1
+Summary: Forecast electrophysiology from single-cell ion-channel expression. Maps the ion-channel fingerprint of any cell type to its predicted electrical behaviour (excitability classification + Hodgkin-Huxley action-potential inference). Built on the CATION ion-channel cell atlas.
+Project-URL: Homepage, https://cationatlas.com
+Project-URL: Documentation, https://docs.cationatlas.com
+Project-URL: Repository, https://github.com/restrolla/ion-channel-cell-atlas
+Project-URL: Bug Tracker, https://github.com/restrolla/ion-channel-cell-atlas/issues
+Author: CATION Project
+License-Expression: MIT
+License-File: LICENSE
+Keywords: action potential,bioinformatics,cell atlas,channelome,electrophysiology,excitability,hodgkin-huxley,ion channels,single-cell
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# porecast
+
+**Forecast electrophysiology from single-cell ion-channel expression.**
+
+`porecast` maps the ion-channel **pore** composition of any cell type (from a
+single-cell RNA-seq dataset) to a **forecast** of its electrical behaviour. It
+is the method companion to the **CATION** ion-channel cell atlas — the ion-channel
+analogue of `hormone2cell`, with one key difference: ion channels are the only
+gene family where expression maps *quantitatively* to a measurable biophysical
+output (the action potential, *V(t)*), so `porecast` can predict function, not
+just describe expression.
+
+## Planned API (three tiers)
+
+```python
+import porecast as pc
+
+# tier 1 — score the ion-channel fingerprint of every cell type
+fp = pc.fingerprint(adata)
+
+# tier 2 — classify cell types as electrically excitable vs non-excitable
+pred = pc.excitability(adata)          # validated against causal CRISPR-perturbation ephys
+
+# tier 3 — infer a Hodgkin–Huxley model and forecast the action potential
+hh = pc.model(cell_type="L5 ET pyramidal")
+hh.spike(current_injection=40)         # -> predicted V(t)
+```
+
+`porecast` ships with the curated **IUPHAR/BPS channelome** (320 genes, 55
+families), a model card, and trained weights.
+
+## Status
+
+**`0.0.1` — name reservation.** This release reserves the package name on PyPI.
+The full implementation lands with the CATION atlas publication. Watch this
+space; see the [CATION atlas](https://cationatlas.com).
+
+## Installation
+
+```bash
+pip install porecast
+```
+
+## License
+
+MIT.

porecast-0.0.1.dist-info/RECORD

@@ -0,0 +1,5 @@
+porecast/__init__.py,sha256=gARt-QYpSHTajoXUm4SrUaTQB_M0tNotT1Eg7-NiTRM,1727
+porecast-0.0.1.dist-info/METADATA,sha256=qJFG1fTXP-c7v1t91wcsJ6FnoE0O21LPp4vLts-fA74,2898
+porecast-0.0.1.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+porecast-0.0.1.dist-info/licenses/LICENSE,sha256=rt3oHJOK_B2tixwMxeqk3cVJ-La8dX0PEyFRcCOxQTw,1071
+porecast-0.0.1.dist-info/RECORD,,

porecast-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any

porecast-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 CATION Project
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.