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.
