Metadata-Version: 2.4
Name: bolerodata
Version: 2026.7.22
Summary: Dataset, model-zoo and metadata registry for the Bolero model
Project-URL: Documentation, https://liuhlab.github.io/bolerodata/
Project-URL: Source, https://github.com/liuhlab/bolerodata
Project-URL: Home-page, https://github.com/liuhlab/bolerodata
Author: Hanqing Liu
Maintainer-email: Hanqing Liu <hanqingliu@fas.harvard.edu>
License: MIT License
        
        Copyright (c) 2024, Hanqing Liu
        
        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.
License-File: LICENSE
Requires-Python: >=3.10
Requires-Dist: anndata
Requires-Dist: huggingface-hub
Requires-Dist: joblib
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: platformdirs
Requires-Dist: pyarrow
Provides-Extra: dev
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: twine>=4.0.2; extra == 'dev'
Provides-Extra: diff
Requires-Dist: pybigwig; extra == 'diff'
Requires-Dist: pyranges; extra == 'diff'
Requires-Dist: pysam; extra == 'diff'
Provides-Extra: doc
Requires-Dist: mkdocs; extra == 'doc'
Requires-Dist: mkdocs-jupyter; extra == 'doc'
Requires-Dist: mkdocs-material; extra == 'doc'
Requires-Dist: mkdocstrings[python]; extra == 'doc'
Requires-Dist: pymdown-extensions; extra == 'doc'
Provides-Extra: full
Requires-Dist: pybigwig; extra == 'full'
Requires-Dist: pyranges; extra == 'full'
Requires-Dist: pysam; extra == 'full'
Provides-Extra: test
Requires-Dist: coverage; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Description-Content-Type: text/markdown

# bolerodata

**Dataset, model-zoo and metadata registry for [Bolero](https://github.com/liuhlab/bolero).**

A uniform Python API over the single-cell ATAC/RNA datasets, model checkpoints, QTL
collections and differential-accessibility records behind Bolero. It maps short keys
to artifacts and returns them as pandas / AnnData objects and ready-to-use file paths.
Large artifacts are **downloaded on demand from HuggingFace** and cached locally.

Documentation: <https://liuhlab.github.io/bolerodata/>

## Installation

```bash
pip install bolerodata            # registry + auto-download of shared data
pip install 'bolerodata[diff]'    # + differential-analysis stack
```

```python
import bolerodata
from bolerodata import DATASETS, MODELS, metadata, GTEx

metadata.MODEL_ZOO.head()                    # browse the model zoo (offline)
DATASETS["HumanBrainDev"].cell_metadata      # downloads from HuggingFace on first use
model = MODELS["<model_key>"]                # checkpoint downloads lazily
```

Building / running a model predictor, resolving a `Genome`, or using
`diff_analysis` additionally needs the companion
[`bolero`](https://github.com/liuhlab/bolero) package (GPU stack); `bolerodata`
imports it lazily. See the [installation guide](https://liuhlab.github.io/bolerodata/install/).

Data is fetched from **[`bolero/bolero-models`](https://huggingface.co/bolero/bolero-models)**
(checkpoints) and **[`bolero/bolero-data`](https://huggingface.co/datasets/bolero/bolero-data)**
into `$BOLERODATA_HOME` (default: the platform cache dir). See
[Data setup & caching](https://liuhlab.github.io/bolerodata/data-setup/).

## Developing

The repo uses [pixi](https://pixi.sh) (lean — no GPU stack):

```bash
git clone https://github.com/liuhlab/bolerodata.git
cd bolerodata
pixi install            # runtime env; or: pixi install -e dev / -e diff / -e docs
```

Maintainers publishing data to HuggingFace: see
[`huggingface_digest.md`](huggingface_digest.md) and the
[sharing guide](https://liuhlab.github.io/bolerodata/sharing/).

## License

MIT — see [LICENSE](LICENSE).
