Metadata-Version: 2.4
Name: scplode
Version: 0.1.0
Summary: scplode: a memory-efficient fast accesser for adata files
Author-email: Ryosuke Kita <rkita4@gmail.com>
Project-URL: Homepage, https://github.com/rkita4/scplode
Project-URL: Issues, https://github.com/rkita4/scplode/issues
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: pandas
Requires-Dist: numpy
Requires-Dist: anndata

# scplode

**"Scplode" your disk space once and get faster access to your single cell data with less memory.**

## Why scplode?

- **Disk space is cheap. Time and memory are not.** 
- A one-time index pays dividends in faster data access
- Familiar `read_h5ad()` and indexing commands for seamless data exploration

## How it compares

| Tool | Pros | Cons |
|------|------|------|
| **Backed AnnData** | Full-featured | Slower access times |
| **BioNeMo** | Similar memory mapping | Heavier weight, unfamiliar API |
| **scplode** | Fast, memory-efficient, familiar API | Requires disk space for index |

## Installation

```bash
pip install scplode
```

## Quick Start

```python
import scplode as sp

# Your familiar workflow, now faster
adata = sp.read_h5ad('your_data.h5ad')
```

## Examples

Located in examples directory:
- `00_example`: Demonstrates use of scplode, and tests for equivalent results
- `01_benchmark`: Compares scplode and anndata for random and contiguous indexing
- `02_state_benchmark`: Compares scplode and anndata when using scplode with the Arc Institute State Model

## Requirements

- Python 3.8+
- AnnData
- Pandas
- Numpy

## License

MIT
