Metadata-Version: 2.4
Name: hucira
Version: 0.1.0
Summary: Human Cytokine Dictionary
Project-URL: Documentation, https://huCIRA.readthedocs.io/
Project-URL: Homepage, https://github.com/theislab/huCIRA
Project-URL: Source, https://github.com/theislab/huCIRA
Author: Jenni Liu
Maintainer-email: Jenni Liu <liu.jenni295@gmail.com>
License: MIT License
        
        Copyright (c) 2025, Jenni 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
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.11
Requires-Dist: anndata
Requires-Dist: bokeh
Requires-Dist: gseapy>=1.1.8
Requires-Dist: numpy>=2.1
Requires-Dist: openpyxl
Requires-Dist: pandas>=2.2.3
Requires-Dist: pycirclize
Requires-Dist: scanpy>=1.11.1
Requires-Dist: scikit-learn>=1.5.2
Requires-Dist: scipy>=1.15.2
Requires-Dist: seaborn>=0.13.2
Requires-Dist: session-info2
Requires-Dist: tqdm>=4.67.1
Provides-Extra: dev
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: twine>=4.0.2; extra == 'dev'
Provides-Extra: doc
Requires-Dist: docutils!=0.18.*,!=0.19.*,>=0.8; extra == 'doc'
Requires-Dist: ipykernel; extra == 'doc'
Requires-Dist: ipython; extra == 'doc'
Requires-Dist: myst-nb>=1.1; extra == 'doc'
Requires-Dist: pandas; extra == 'doc'
Requires-Dist: setuptools; extra == 'doc'
Requires-Dist: sphinx-autodoc-typehints; extra == 'doc'
Requires-Dist: sphinx-book-theme>=1; extra == 'doc'
Requires-Dist: sphinx-copybutton; extra == 'doc'
Requires-Dist: sphinx-tabs; extra == 'doc'
Requires-Dist: sphinx>=8.1; extra == 'doc'
Requires-Dist: sphinxcontrib-bibtex>=1; extra == 'doc'
Requires-Dist: sphinxcontrib-katex; extra == 'doc'
Requires-Dist: sphinxext-opengraph; extra == 'doc'
Provides-Extra: test
Requires-Dist: coverage>=7.10; extra == 'test'
Requires-Dist: ipython; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Description-Content-Type: text/markdown

# huCIRA

[![Tests][badge-tests]][tests]
[![Documentation][badge-docs]][documentation]

[badge-tests]: https://img.shields.io/github/actions/workflow/status/theislab/cytokine_dict/test.yaml?branch=main
[badge-docs]: https://img.shields.io/readthedocs/cytokine_dict

huCIRA (human Cytokine Immune Response Analysis) provides an easy-to-use interface to analyze cytokine signaling and cytokine-induced immune program enrichment in transcriptomic datasets.

To get started, simply supply a transcriptomic dataset annotated with immune cell types and the experimental conditions of interest. Using our dictionary as a reference, huCIRA allows you to infer differential cytokine activity and immune program activation across conditions and to map cytokine-mediated interactions between immune cells. Under the hood, huCIRA is based on [gseapy](https://github.com/zqfang/GSEApy/tree/master/gseapy) to run enrichment analyses.



<img src="docs/_static/images/hucira_overview.svg" width="500" alt="huCIRA">




## Demo

Please refer to this [tutorial](https://github.com/theislab/huCIRA/blob/main/docs/notebooks/Tutorial_huCIRA_Lupus.ipynb) for an example of a full pipeline and outputs.

The core analysis is happening here:
```python
import scanpy as sc
import hucira as hc

# 1. Load your data
adata = sc.read_h5ad("your_transcriptome.h5ad")
human_cytokine_dictionary = hc.load_human_cytokine_dict()

# 2. Run cytokine enrichment analysis for B cells between healthy and diseased patients
enrichment_results = hc.run_one_enrichment_test(
    adata = adata,
    df_hcd_all = human_cytokine_dictionary,
    contrasts_combo = ("healthy", "disease"),
    celltype_combo = ("B cell", "B"),
    contrast_column = "condition",
    celltype_column = "cell_type",
    direction = "upregulated",
    threshold_expression = 0.0
)

# 3. Investigate enrichment scores of cytokines in your data
enrichment_results



```


## Installation

You need to have 3.11 <= Python < 3.14 installed on your system.
If you don't have Python installed, we recommend installing [uv][].

There are several alternative options to install hucira:


1. Install the latest release of `hucira` from [PyPI][]:

```bash
pip install hucira
```


2. Install the latest development version:

```bash
pip install git+https://github.com/theislab/huCIRA.git@main
```

Installation is expected to complete within a few minutes.

## Release notes

See the [changelog][].

## Contact

If you found a bug, please use the [issue tracker][].

## Citation
```bibtex
@article {Oesinghaus2025.12.12.693897,
	author = {Oesinghaus, Lukas and Becker, S{\"o}ren and Vornholz, Larsen and Papalexi, Efthymia and Pangallo, Joey and Moinfar, Amir Ali and Liu, Jenni and Fleur, Alyssa La and Shulman, Maiia and Marrujo, Simone and Hariadi, Bryan and Curca, Crina and Suyama, Alexa and Nigos, Maria and Sanderson, Oliver and Nguyen, Hoai and Tran, Vuong K and Sapre, Ajay A. and Kaplan, Olivia and Schroeder, Sarah and Salvino, Alec and Gallareta-Olivares, Guillermo and Koehler, Ryan and Geiss, Gary and Rosenberg, Alexander B. and Roco, Charles M. and Seelig, Georg and Theis, Fabian},
	title = {A single-cell cytokine dictionary of human peripheral blood},
	elocation-id = {2025.12.12.693897},
	year = {2025},
	doi = {10.64898/2025.12.12.693897},
	publisher = {Cold Spring Harbor Laboratory},
	URL = {https://www.biorxiv.org/content/early/2025/12/15/2025.12.12.693897},
	journal = {bioRxiv}
}
```

[uv]: https://github.com/astral-sh/uv
[scverse discourse]: https://discourse.scverse.org/
[issue tracker]: https://github.com/theislab/cytokine_dict/issues
[tests]: https://github.com/theislab/cytokine_dict/actions/workflows/test.yaml
[documentation]: https://cytokine_dict.readthedocs.io
[changelog]: https://cytokine_dict.readthedocs.io/en/latest/changelog.html
[api documentation]: https://cytokine_dict.readthedocs.io/en/latest/api.html
[pypi]: https://pypi.org/project/cytokine_dict
